- StaticPromptCandidate
- Bộ chọn
- SurfaceCapabilities
- StaticPromptResponse
- StaticSimplePrompt
- Biến thể
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- StaticLinkPrompt
- OpenUrl
- StaticTablePrompt
- TableColumn
- TableRow
- TableCell
- StaticMediaPrompt
- MediaObject
- MediaImage
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- Đề xuất
- StaticCanvasPrompt
Biểu thị danh sách các đề xuất câu lệnh, một trong số đó sẽ được chọn làm câu lệnh xuất hiện trong câu trả lời cho người dùng. Thông báo này có thể bản địa hoá.
Biểu diễn dưới dạng JSON | |
---|---|
{
"candidates": [
{
object ( |
Trường | |
---|---|
candidates[] |
Danh sách lời nhắc ứng viên cần gửi cho khách hàng. Mỗi câu lệnh có một bộ chọn để xác định thời điểm có thể sử dụng câu lệnh đó. Bộ chọn đầu tiên khớp với yêu cầu sẽ được gửi và bộ chọn còn lại sẽ bị bỏ qua. |
StaticPromptCandidate
Đại diện cho một đề xuất lời nhắc tĩnh.
Biểu diễn dưới dạng JSON | |
---|---|
{ "selector": { object ( |
Trường | |
---|---|
selector |
Không bắt buộc. Tiêu chí để xác định xem lời nhắc này có khớp với một yêu cầu hay không. Nếu bộ chọn trống, lời nhắc này sẽ luôn được kích hoạt. |
promptResponse |
Câu trả lời ngay lập tức được liên kết với bộ chọn. |
Bộ chọn
Xác định tiêu chí để xác định liệu một lời nhắc có khớp với một yêu cầu hay không.
Biểu diễn dưới dạng JSON | |
---|---|
{
"surfaceCapabilities": {
object ( |
Trường | |
---|---|
surfaceCapabilities |
Tập hợp các chức năng bắt buộc của nền tảng. |
SurfaceCapabilities
Đại diện cho nền tảng mà người dùng đang sử dụng để yêu cầu Hành động.
Biểu diễn dưới dạng JSON | |
---|---|
{
"capabilities": [
enum ( |
Trường | |
---|---|
capabilities[] |
Bắt buộc. Các tính năng của nền tảng đưa ra yêu cầu cho Hành động. |
StaticPromptResponse
Biểu thị các câu trả lời có cấu trúc cần gửi cho người dùng, chẳng hạn như văn bản, lời nói, thẻ, dữ liệu canvas, khối đề xuất, v.v.
Biểu diễn dưới dạng JSON | |
---|---|
{ "firstSimple": { object ( |
Trường | |
---|---|
firstSimple |
Không bắt buộc. Câu trả lời đầu tiên chỉ có văn bản và giọng nói. |
content |
Không bắt buộc. Một nội dung như thẻ, danh sách hoặc nội dung nghe nhìn để hiển thị với người dùng. |
lastSimple |
Không bắt buộc. Câu trả lời gần đây nhất chỉ có văn bản và giọng nói. |
suggestions[] |
Không bắt buộc. Nội dung đề xuất sẽ hiển thị với người dùng và sẽ luôn xuất hiện ở cuối câu trả lời. Nếu nút "nối" trường trong câu lệnh chứa là "true" các tiêu đề được xác định trong trường này sẽ được thêm vào các tiêu đề được xác định trong mọi câu lệnh đề xuất đã xác định trước đó và các giá trị trùng lặp sẽ bị xoá. |
link |
Không bắt buộc. Một khối đề xuất bổ sung có thể liên kết đến ứng dụng hoặc trang web được liên kết. Khối sẽ được hiển thị với tiêu đề "Mở |
override |
Không bắt buộc. Chế độ cho biết cách hợp nhất tin nhắn này với tin nhắn đã xác định trước đó. "đúng" sẽ xoá mọi thông báo đã xác định trước đó (đơn giản đầu tiên và cuối cùng, nội dung, đường liên kết đề xuất và canvas) đồng thời thêm các thông báo được xác định trong câu lệnh này. "sai" sẽ thêm tin nhắn được xác định trong câu lệnh này vào các tin nhắn được xác định trong các câu trả lời trước đó. Đặt trường này thành "false" cũng sẽ cho phép thêm một số trường bên trong lời nhắc Đơn giản, lời nhắc Đề xuất và lời nhắc Canvas (một phần của lời nhắc Nội dung). Các nội dung Nội dung và Đường liên kết sẽ luôn bị ghi đè nếu được xác định trong câu lệnh. Giá trị mặc định là "false". |
canvas |
Câu trả lời dùng cho trải nghiệm canvas tương tác. |
StaticSimplePrompt
Biểu thị một lời nhắc đơn giản cần gửi cho người dùng.
Biểu diễn dưới dạng JSON | |
---|---|
{
"variants": [
{
object ( |
Trường | |
---|---|
variants[] |
Danh sách các biến thể có thể có. |
Biến thể
Đại diện cho một biến thể thuộc câu lệnh đơn giản.
Biểu diễn dưới dạng JSON | |
---|---|
{ "speech": string, "text": string } |
Trường | |
---|---|
speech |
Không bắt buộc. Biểu thị lời nói sẽ được đọc với người dùng. Có thể là SSML hoặc chuyển văn bản sang lời nói. Nếu nút "nối" trường trong câu lệnh chứa là "true" lời nói được xác định trong trường này sẽ được thêm vào lời nói của câu lệnh Đơn giản trước đó. |
text |
Không bắt buộc. Văn bản hiển thị trong bong bóng trò chuyện. Nếu không cung cấp, hình ảnh kết xuất hiển thị của trường lời nói ở trên sẽ được sử dụng. Tối đa 640 ký tự. Nếu nút "nối" trường trong câu lệnh chứa là "true" văn bản được xác định trong trường này sẽ được thêm vào văn bản của câu lệnh Đơn giản trước đó. |
StaticContentPrompt
Phần giữ chỗ cho phần Content (Nội dung) của StaticPrompt.
Biểu diễn dưới dạng JSON | |
---|---|
{ // Union field |
Trường | ||
---|---|---|
Trường kết hợp content . Chỉ có thể xuất hiện một loại nội dung trong một Lời nhắc. content chỉ có thể là một trong những trạng thái sau đây: |
||
card |
Một thẻ cơ bản. |
|
image |
Một hình ảnh. |
|
table |
Thẻ bảng. |
|
media |
Phản hồi cho biết một nhóm nội dung nghe nhìn sẽ phát. |
|
list |
Thẻ để trình bày danh sách các lựa chọn. |
|
collection |
Một thẻ trình bày danh sách các lựa chọn để bạn lựa chọn. |
StaticCardPrompt
Thẻ cơ bản để hiển thị một số thông tin, ví dụ: hình ảnh và/hoặc văn bản.
Biểu diễn dưới dạng JSON | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
Trường | |
---|---|
title |
Không bắt buộc. Tiêu đề chung của thẻ. |
subtitle |
Không bắt buộc. Tiêu đề phụ của thẻ. |
text |
Bắt buộc. Văn bản nội dung của thẻ, cần thiết, trừ phi có hình ảnh. Hỗ trợ một số cú pháp đánh dấu có giới hạn để định dạng. |
image |
Không bắt buộc. Hình ảnh chính cho thẻ. Chiều cao được cố định là 192 dp. |
imageFill |
Không bắt buộc. Cách tô nền hình ảnh. |
button |
Không bắt buộc. Một nút có thể nhấp vào sẽ xuất hiện trong Thẻ. |
StaticImagePrompt
Hình ảnh hiển thị trong thẻ.
Biểu diễn dưới dạng JSON | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
Trường | |
---|---|
url |
Bắt buộc. URL nguồn của hình ảnh. Hình ảnh có thể ở định dạng JPG, PNG và GIF (ảnh động và tĩnh). Ví dụ: |
alt |
Bắt buộc. Nội dung mô tả bằng văn bản của hình ảnh dùng để tăng khả năng tiếp cận, ví dụ: trình đọc màn hình. |
height |
Không bắt buộc. Chiều cao của hình ảnh tính bằng pixel. |
width |
Không bắt buộc. Chiều rộng của hình ảnh tính bằng pixel. |
StaticLinkPrompt
Xác định đường liên kết sẽ xuất hiện dưới dạng khối đề xuất mà người dùng có thể mở.
Biểu diễn dưới dạng JSON | |
---|---|
{
"name": string,
"open": {
object ( |
Trường | |
---|---|
name |
Tên của đường liên kết |
open |
Xác định hành vi khi người dùng mở đường liên kết. |
OpenUrl
Xác định hành vi khi người dùng mở đường liên kết.
Biểu diễn dưới dạng JSON | |
---|---|
{
"url": string,
"hint": enum ( |
Trường | |
---|---|
url |
Trường URL có thể là bất kỳ trường hợp nào sau đây: – URL http/https để mở một Ứng dụng liên kết với ứng dụng hoặc một trang web |
hint |
Cho biết gợi ý về loại url. |
StaticTablePrompt
Thẻ bảng để hiển thị một bảng văn bản.
Biểu diễn dưới dạng JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Trường | |
---|---|
title |
Không bắt buộc. Tiêu đề chung của bảng. Bạn phải đặt tiêu đề phụ nếu đã đặt tiêu đề phụ. |
subtitle |
Không bắt buộc. Tiêu đề phụ cho bảng. |
image |
Không bắt buộc. Hình ảnh được liên kết với bảng. |
columns[] |
Không bắt buộc. Tiêu đề và căn chỉnh cột. |
rows[] |
Không bắt buộc. Dữ liệu về hàng của bảng. 3 hàng đầu tiên được đảm bảo sẽ xuất hiện, nhưng các hàng khác có thể bị cắt bớt trên một số nền tảng nhất định. Vui lòng kiểm tra với trình mô phỏng để xem những hàng nào sẽ hiển thị cho một nền tảng nhất định. Trên các nền tảng hỗ trợ chức năng WEB_BROWSER, bạn có thể hướng người dùng đến một trang web có nhiều dữ liệu hơn. |
button |
Không bắt buộc. Nút. |
TableColumn
Mô tả một cột trong bảng.
Biểu diễn dưới dạng JSON | |
---|---|
{
"header": string,
"align": enum ( |
Trường | |
---|---|
header |
Văn bản tiêu đề cho cột. |
align |
Căn chỉnh theo chiều ngang của cột nội dung. Nếu bạn chưa chỉ định, nội dung sẽ được căn chỉnh theo cạnh trên. |
TableRow
Mô tả một hàng trong bảng.
Biểu diễn dưới dạng JSON | |
---|---|
{
"cells": [
{
object ( |
Trường | |
---|---|
cells[] |
Các ô trong hàng này. 3 ô đầu tiên được đảm bảo sẽ xuất hiện, nhưng các ô khác có thể bị cắt trên một số bề mặt. Vui lòng kiểm tra với trình mô phỏng để xem những ô nào sẽ hiển thị cho một bề mặt nhất định. |
divider |
Cho biết có cần có dải phân cách sau mỗi hàng hay không. |
TableCell
Mô tả một ô trong một hàng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "text": string } |
Trường | |
---|---|
text |
Nội dung văn bản của ô. |
StaticMediaPrompt
Chứa thông tin về nội dung nghe nhìn, chẳng hạn như tên, nội dung mô tả, URL, v.v. Mã tiếp theo: 9
Biểu diễn dưới dạng JSON | |
---|---|
{ "mediaType": enum ( |
Trường | |
---|---|
mediaType |
Loại nội dung nghe nhìn của câu trả lời này. |
startOffset |
Độ lệch bắt đầu của đối tượng nội dung nghe nhìn đầu tiên. Thời lượng tính bằng giây với tối đa 9 chữ số phân số, kết thúc bằng " |
optionalMediaControls[] |
Các loại chế độ điều khiển nội dung nghe nhìn (không bắt buộc) mà phiên phản hồi nội dung nghe nhìn này có thể hỗ trợ. Nếu bạn đặt chính sách này, yêu cầu sẽ được gửi đến bên thứ ba khi một sự kiện đa phương tiện nhất định xảy ra. Nếu không được thiết lập, ứng dụng 3p vẫn phải xử lý hai loại điều khiển mặc định là FinishED (KẾT THÚC) và FAILED (KHÔNG THÀNH CÔNG). |
mediaObjects[] |
Danh sách đối tượng nội dung nghe nhìn. |
MediaObject
Đại diện cho một đối tượng nội dung nghe nhìn duy nhất.
Biểu diễn dưới dạng JSON | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
Trường | |
---|---|
name |
Tên của đối tượng nội dung đa phương tiện này. |
description |
Nội dung mô tả về đối tượng nội dung nghe nhìn này. |
url |
URL trỏ đến nội dung đa phương tiện. |
image |
Hình ảnh sẽ hiển thị với thẻ nội dung nghe nhìn. |
MediaImage
Hình ảnh xuất hiện trong MediaPrompt.
Biểu diễn dưới dạng JSON | |
---|---|
{ // Union field |
Trường | ||
---|---|---|
Trường kết hợp image . Chỉ cho phép một loại MediaImage. image chỉ có thể là một trong những trạng thái sau đây: |
||
large |
Một hình ảnh lớn, chẳng hạn như ảnh bìa đĩa nhạc, v.v. |
|
icon |
Một biểu tượng hình ảnh nhỏ hiển thị ở bên phải tiêu đề. Kích thước đã đổi kích thước thành 36x36 dp. |
StaticListPrompt
Thẻ để trình bày danh sách các lựa chọn.
Biểu diễn dưới dạng JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
Trường | |
---|---|
title |
Không bắt buộc. Tiêu đề của danh sách. |
subtitle |
Không bắt buộc. Tiêu đề phụ của danh sách. |
items[] |
Bắt buộc. Mục trong danh sách. |
ListItem
Một mục trong danh sách.
Biểu diễn dưới dạng JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Trường | |
---|---|
key |
Bắt buộc. Khoá NLU khớp với tên khoá kết nối trong loại được liên kết. Khi bạn nhấn vào mục, khoá này sẽ được đăng lại dưới dạng thông số lựa chọn. |
title |
Bắt buộc. Tiêu đề của mặt hàng. Khi được nhấn, văn bản này sẽ được đăng lại nguyên văn vào cuộc trò chuyện như thể người dùng đã nhập văn bản đó. Mỗi tiêu đề phải là duy nhất trong tập hợp các mục. |
description |
Không bắt buộc. Văn bản nội dung của mặt hàng. |
image |
Không bắt buộc. Hình ảnh mục. |
StaticCollectionPrompt
Thẻ để trình bày một tập hợp các lựa chọn.
Biểu diễn dưới dạng JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Trường | |
---|---|
title |
Không bắt buộc. Tiêu đề của bộ sưu tập. |
subtitle |
Không bắt buộc. Tiêu đề phụ của bộ sưu tập. |
items[] |
Bắt buộc. Các mục trong bộ sưu tập. |
imageFill |
Không bắt buộc. Loại hình ảnh hiển thị. |
CollectionItem
Một mục trong bộ sưu tập.
Biểu diễn dưới dạng JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Trường | |
---|---|
key |
Bắt buộc. Khoá NLU khớp với tên khoá kết nối trong Loại được liên kết. Khi bạn nhấn vào mục, khoá này sẽ được đăng lại dưới dạng thông số lựa chọn. |
title |
Bắt buộc. Tiêu đề của mặt hàng. Khi được nhấn, văn bản này sẽ được đăng lại nguyên văn vào cuộc trò chuyện như thể người dùng đã nhập văn bản đó. Mỗi tiêu đề phải là duy nhất trong tập hợp các mục. |
description |
Không bắt buộc. Văn bản nội dung của mặt hàng. |
image |
Không bắt buộc. Hình ảnh mục. |
Đề xuất
Đại diện cho khối đề xuất, một phần tử trên giao diện người dùng hiển thị cho người dùng để thuận tiện.
Biểu diễn dưới dạng JSON | |
---|---|
{ "title": string } |
Trường | |
---|---|
title |
Bắt buộc. Văn bản xuất hiện trong khối đề xuất. Khi được nhấn, văn bản này sẽ được đăng lại nguyên văn vào cuộc trò chuyện như thể người dùng đã nhập văn bản đó. Mỗi tiêu đề phải là duy nhất trong tập hợp các khối đề xuất. Tối đa 25 ký tự |
StaticCanvasPrompt
Biểu thị phản hồi Canvas tương tác sẽ được gửi đến người dùng. Bạn có thể dùng lệnh này cùng với "firstSimple" trong câu lệnh chứa lời nhắc để nói chuyện với người dùng ngoài việc hiển thị phản hồi canvas tương tác.
Biểu diễn dưới dạng JSON | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean } |
Trường | |
---|---|
url |
Bắt buộc. URL của chế độ xem trên web cần tải. |
data[] |
Không bắt buộc. Dữ liệu JSON được truyền đến trang web trải nghiệm sống động dưới dạng sự kiện. Nếu giá trị "ghi đè" trường trong câu lệnh chứa là "false" các giá trị dữ liệu được xác định trong lời nhắc Canvas này sẽ được thêm vào sau giá trị dữ liệu được xác định trong các lời nhắc Canvas trước đó. |
suppressMic |
Không bắt buộc. Giá trị true có nghĩa là micrô sẽ không bật để ghi nhận dữ liệu đầu vào sau khi người dùng nhìn thấy phản hồi sống động này. |