- 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 (Bộ sưu tập)
- Đề xuất
- StaticCanvasPrompt
Đại diện cho danh sách các đề xuất của câu lệnh, một trong số các đề xuất đó sẽ được chọn làm lời nhắc xuất hiện trong phản hồi cho người dùng. Bạn cần bản địa hoá thông báo này.
Biểu diễn dưới dạng JSON | |
---|---|
{
"candidates": [
{
object ( |
Các trường | |
---|---|
candidates[] |
Danh sách lời nhắc của ứng viên sẽ được gửi đến 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. Bộ chọn đầu tiên khớp với yêu cầu sẽ được gửi và phầ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 ( |
Các trường | |
---|---|
selector |
Không bắt buộc. Tiêu chí để xác định xem lời nhắc này có phù hợ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 |
Phản hồi nhanh được liên kết với bộ chọn. |
Bộ chọn
Xác định tiêu chí để xác định xem lời nhắc có phù hợp với một yêu cầu hay không.
Biểu diễn dưới dạng JSON | |
---|---|
{
"surfaceCapabilities": {
object ( |
Các trường | |
---|---|
surfaceCapabilities |
Tập hợp các tính 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 để đưa ra yêu cầu cho Hành động.
Biểu diễn dưới dạng JSON | |
---|---|
{
"capabilities": [
enum ( |
Các trường | |
---|---|
capabilities[] |
Bắt buộc. Khả năng của nền tảng đưa ra yêu cầu đối với Hành động. |
StaticPromptResponse
Biểu thị các câu trả lời có cấu trúc để 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 ( |
Các trường | |
---|---|
firstSimple |
Không bắt buộc. Tin nhắn phản hồi đầu tiên bằng giọng nói và văn bản. |
content |
Không bắt buộc. Nội dung như thẻ, danh sách hoặc nội dung nghe nhìn cần hiển thị với người dùng. |
lastSimple |
Không bắt buộc. Câu trả lời bằng giọng nói và văn bản sau cùng. |
suggestions[] |
Không bắt buộc. Các nội dung đề xuất dành cho người dùng sẽ luôn xuất hiện ở cuối câu trả lời. Nếu trường "nối" trong câu lệnh chứa giá trị là "đúng", thì các tiêu đề được xác định trong trường này sẽ được thêm vào tiêu đề được xác định trong mọi lời nhắc đề xuất đã được xác định trước đó và các giá trị trùng lặp sẽ bị xoá. |
link |
Không bắt buộc. 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 đề "Open |
override |
Không bắt buộc. Chế độ cách hợp nhất tin nhắn này với tin nhắn đã xác định trước đó. "true" sẽ xoá tất cả thông báo đã xác định trước đó (nội dung đơn giản, đầu tiên và cuối cùng, đường liên kết đề xuất và canvas) cũng như thêm thông báo được xác định trong câu lệnh này. "false" sẽ thêm thông báo được xác định trong câu lệnh này vào các thông báo được xác định trong các câu trả lời trước. Việc đặt trường này thành "false" cũng sẽ cho phép thêm một số trường 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). Thông báo Nội dung và 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 |
Một phản hồi sẽ được dùng cho trải nghiệm canvas tương tác. |
StaticSimplePrompt
Đại diện cho một lời nhắc đơn giản để gửi đến người dùng.
Biểu diễn dưới dạng JSON | |
---|---|
{
"variants": [
{
object ( |
Các 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 } |
Các trường | |
---|---|
speech |
Không bắt buộc. Đại diện cho lời nói sẽ được nói với người dùng. Có thể là SSML hoặc tính năng chuyển văn bản sang lời nói. Nếu trường "nối" trong câu lệnh chứa là "đúng", thì lời nói được xác định trong trường này sẽ được nối 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 sẽ hiển thị trong bong bóng trò chuyện. Nếu không được cung cấp, chế độ hiển thị của trường lời nói ở trên sẽ được sử dụng. Giới hạn ở 640 ký tự. Nếu trường "nối" trong câu lệnh chứa là "true", thì văn bản xác định trong trường này sẽ được nối 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 Nội dung của StaticPrompt.
Biểu diễn dưới dạng JSON | |
---|---|
{ // Union field |
Các trường | ||
---|---|---|
Trường nhóm content . Chỉ một loại nội dung có thể xuất hiện trong 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 |
Một thẻ trình bày danh sách các tuỳ chọn để chọn. |
|
collection |
Một thẻ hiển thị danh sách các tuỳ chọn để chọn. |
StaticCardPrompt
Một 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 ( |
Các 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ẻ là cần thiết trừ khi có hình ảnh. Hỗ trợ một số cú pháp Markdown 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 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 } |
Các 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 (động và tĩnh). Ví dụ: |
alt |
Bắt buộc. Nội dung mô tả văn bản của hình ảnh được dùng cho khả năng hỗ trợ 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 và người dùng có thể mở đường liên kết đó.
Biểu diễn dưới dạng JSON | |
---|---|
{
"name": string,
"open": {
object ( |
Các 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 ( |
Các trường | |
---|---|
url |
Trường url có thể là bất kỳ URL nào trong số: – URL http/https để mở Ứng dụng được liên kết với ứng dụng hoặc một trang web |
hint |
Biểu thị gợi ý cho loại URL. |
StaticTablePrompt
Thẻ bảng để trình bày một bảng văn bản.
Biểu diễn dưới dạng JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Các trường | |
---|---|
title |
Không bắt buộc. Tiêu đề chung của bảng. Phải đặt 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ác cột. |
rows[] |
Không bắt buộc. Dữ liệu hàng của bảng. 3 hàng đầu tiên chắc chắn sẽ xuất hiện, nhưng những hàng khác có thể bị cắt trên một số vị trí. Vui lòng thử nghiệm bằng trình mô phỏng để xem hàng nào sẽ xuất hiện trên 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ể trỏ 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 ( |
Các trường | |
---|---|
header |
Văn bản tiêu đề cho cột. |
align |
Căn ngang nội dung với cột t.r.t. Nếu chưa chỉ định, nội dung sẽ được căn chỉnh vào cạnh trên cùng. |
TableRow
Mô tả một hàng trong bảng.
Biểu diễn dưới dạng JSON | |
---|---|
{
"cells": [
{
object ( |
Các trường | |
---|---|
cells[] |
Các ô trong hàng này. 3 ô đầu tiên được đảm bảo sẽ hiển thị, nhưng các ô khác có thể bị cắt trên một số bề mặt nhất định. Vui lòng thử nghiệm bằng trình mô phỏng để xem ô nào sẽ xuất hiện trên một nền tảng nhất định. |
divider |
Cho biết có cần dùng dải phân cách sau mỗi hàng hay không. |
TableCell
Mô tả một ô trong hàng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "text": string } |
Các 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 ( |
Các trường | |
---|---|
mediaType |
Loại nội dung đa phương tiện của phản hồi này. |
startOffset |
Bắt đầu độ lệch của đối tượng nội dung đa phương tiện đầu tiên. Thời lượng tính bằng giây có 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 được đặt, yêu cầu sẽ được gửi đến bên thứ ba khi một sự kiện truyền thông nhất định diễn ra. Nếu không được đặt, 3p vẫn phải xử lý hai loại điều khiển mặc định là ComposeED 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 phương tiện.
Biểu diễn dưới dạng JSON | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
Các 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 đa phương tiện này. |
url |
URL trỏ đến nội dung nghe nhìn. |
image |
Hình ảnh để hiển thị cùng với thẻ nội dung đa phương tiện. |
MediaImage
Hình ảnh hiển thị bên trong MediaPrompt.
Biểu diễn dưới dạng JSON | |
---|---|
{ // Union field |
Các trường | ||
---|---|---|
Trường nhóm 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ư bìa album, v.v. |
|
icon |
Một biểu tượng hình ảnh nhỏ ở bên phải của tiêu đề. Nó được đổi kích thước thành 36x36 dp. |
StaticListPrompt
Một thẻ trình bày danh sách các tuỳ chọn để chọn.
Biểu diễn dưới dạng JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
Các trường | |
---|---|
title |
Không bắt buộc. Tiêu đề 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 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 ( |
Các 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 mục được nhấn, khoá này sẽ được đăng lại dưới dạng tham số tuỳ chọn có chọn lọc. |
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 trong cuộc trò chuyện như thể người dùng đã nhập. 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ục. |
image |
Không bắt buộc. Hình ảnh mục. |
StaticCollectionPrompt
Một thẻ trình bày một bộ sưu tập các tuỳ chọn để chọn.
Biểu diễn dưới dạng JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Các trường | |
---|---|
title |
Không bắt buộc. Tên 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 tuỳ chọn hiển thị hình ảnh. |
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 ( |
Các trường | |
---|---|
key |
Bắt buộc. Khoá NLU khớp với tên khoá nhập trong Loại được liên kết. Khi mục được nhấn, khoá này sẽ được đăng lại dưới dạng tham số tuỳ chọn có chọn lọc. |
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 trong cuộc trò chuyện như thể người dùng đã nhập. 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ục. |
image |
Không bắt buộc. Hình ảnh mục. |
Đề xuất
Đại diện cho khối đề xuất, một thành phần trên giao diện người dùng được hiển thị cho người dùng để thuận tiện.
Biểu diễn dưới dạng JSON | |
---|---|
{ "title": string } |
Các 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 trong cuộc trò chuyện như thể người dùng đã nhập. Mỗi tiêu đề phải là duy nhất trong tập hợp 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ể sử dụng tính năng này cùng với trường "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 } |
Các trường | |
---|---|
url |
Bắt buộc. URL của chế độ xem web cần tải. |
data[] |
Không bắt buộc. Dữ liệu JSON sẽ được truyền đến trang web trải nghiệm sống động dưới dạng sự kiện. Nếu trường "ghi đè" trong câu lệnh chứa là "sai" thì 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 các giá trị dữ liệu được xác định trong các câu lệnh trước đó của Canvas. |
suppressMic |
Không bắt buộc. Giá trị true có nghĩa là micrô sẽ không được mở để thu thập dữ liệu đầu vào sau khi phản hồi trực quan này được hiển thị cho người dùng. |