EventHandler

Xác định một trình xử lý sẽ được thực thi sau một sự kiện. Ví dụ về sự kiện là các sự kiện dựa trên ý định và điều kiện trong một cảnh.

Trình bày YAML 
webhookHandler: string

# Union field prompt can be only one of the following:
staticPrompt: 
  object (StaticPrompt)
staticPromptName: string
# End of list of possible types for union field prompt.
Các trường
webhookHandler

string

Tên của trình xử lý webhook cần gọi.
Trường nhóm prompt. Lời nhắc có thể nằm cùng dòng hoặc được tham chiếu theo tên. prompt chỉ có thể là một trong những trạng thái sau đây:
staticPrompt

object (StaticPrompt)

Lời nhắc tĩnh cùng dòng. Có thể chứa các tham chiếu đến tài nguyên chuỗi trong gói.
staticPromptName

string

Tên của lời nhắc tĩnh để gọi.

StaticPrompt

Đạ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.

Trình bày YAML 
candidates: 
  - object (StaticPromptCandidate)
Các trường
candidates[]

object (StaticPromptCandidate)

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.

Trình bày YAML 
selector: 
  object (Selector)
promptResponse: 
  object (StaticPromptResponse)
Các trường
selector

object (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

object (StaticPromptResponse)

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.

Trình bày YAML 
surfaceCapabilities: 
  object (SurfaceCapabilities)
Các trường
surfaceCapabilities

object (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.

Trình bày YAML 
capabilities: 
  - enum (Capability)
Các trường
capabilities[]

enum (Capability)

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.

Trình bày YAML 
firstSimple: 
  object (StaticSimplePrompt)
content: 
  object (StaticContentPrompt)
lastSimple: 
  object (StaticSimplePrompt)
suggestions: 
  - object (Suggestion)
link: 
  object (StaticLinkPrompt)
override: boolean
canvas: 
  object (StaticCanvasPrompt)
Các trường
firstSimple

object (StaticSimplePrompt)

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

object (StaticContentPrompt)

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

object (StaticSimplePrompt)

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[]

object (Suggestion)

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 append trong câu lệnh chứa là true, thì 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 câu lệnh đề xuất đã được xác định trước đó và các giá trị trùng lặp sẽ bị xoá.
override

boolean

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ả các thông báo đã xác định trước đó (nội dung, đường liên kết đề xuất và canvas) đã xác định trước đó, đồng thời 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 lời nhắc này vào các thông báo đã 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

object (StaticCanvasPrompt)

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.

Trình bày YAML 
variants: 
  - object (Variant)
Các trường
variants[]

object (Variant)

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.

Trình bày YAML 
speech: string
text: string
Các trường
speech

string

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. Theo mặc định, lời nói sẽ được thêm vào lời nói của câu lệnh Đơn giản trước đó. Nếu trường override trong câu lệnh chứa là true thì lời nói được xác định trong trường này sẽ ghi đè lời nói của câu lệnh Đơn giản trước đó.
text

string

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ự. Theo mặc định, văn bản sẽ được nối vào văn bản của câu lệnh Đơn giản trước đó. Nếu trường override trong lời nhắc chứa là true thì văn bản được xác định trong trường này sẽ ghi đè văn bản của lời nhắc Đơn giản trước đó.

StaticContentPrompt

Phần giữ chỗ cho phần Nội dung của StaticPrompt.

Trình bày YAML 
# Union field content can be only one of the following:
card: 
  object (StaticCardPrompt)
image: 
  object (StaticImagePrompt)
table: 
  object (StaticTablePrompt)
media: 
  object (StaticMediaPrompt)
list: 
  object (StaticListPrompt)
collection: 
  object (StaticCollectionPrompt)
collectionBrowse: 
  object (StaticCollectionBrowsePrompt)
# End of list of possible types for union field content.
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

object (StaticCardPrompt)

Một thẻ cơ bản.
image

object (StaticImagePrompt)

Một hình ảnh.
table

object (StaticTablePrompt)

Thẻ bảng.
media

object (StaticMediaPrompt)

Phản hồi cho biết một nhóm nội dung nghe nhìn sẽ phát.
list

object (StaticListPrompt)

Một thẻ trình bày danh sách các tuỳ chọn để chọn.
collection

object (StaticCollectionPrompt)

Một thẻ hiển thị danh sách các tuỳ chọn để chọn.
collectionBrowse

object (StaticCollectionBrowsePrompt)

Một thẻ hiển thị một tập hợp các trang web sẽ mở.

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).

Trình bày YAML 
title: string
subtitle: string
text: string
image: 
  object (StaticImagePrompt)
imageFill: enum (ImageFill)
button: 
  object (StaticLinkPrompt)
Các trường
title

string

Không bắt buộc. Tiêu đề chung của thẻ.
subtitle

string

Không bắt buộc. Tiêu đề phụ của thẻ.
text

string

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

object (StaticImagePrompt)

Không bắt buộc. Hình ảnh chính cho thẻ. Chiều cao được cố định là 192 dp.
imageFill

enum (ImageFill)

Không bắt buộc. Cách tô nền hình ảnh.
button

object (StaticLinkPrompt)

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ẻ.

Trình bày YAML 
url: string
alt: string
height: integer
width: integer
Các trường
url

string

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ụ: https://www.agentx.com/logo.png.
alt

string

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

integer

Không bắt buộc. Chiều cao của hình ảnh tính bằng pixel.
width

integer

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 đó.

Trình bày YAML 
name: string
open: 
  object (OpenUrl)
Các trường
name

string

Tên của đường liên kết
open

object (OpenUrl)

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.

Trình bày YAML 
url: string
hint: enum (UrlHint)
Các trường
url

string

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

enum (UrlHint)

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.

Trình bày YAML 
title: string
subtitle: string
image: 
  object (StaticImagePrompt)
columns: 
  - object (TableColumn)
rows: 
  - object (TableRow)
button: 
  object (StaticLinkPrompt)
Các trường
title

string

Không bắt buộc. Tiêu đề chung của bảng. Phải đặt nếu đã đặt tiêu đề phụ.
subtitle

string

Không bắt buộc. Tiêu đề phụ cho bảng.
image

object (StaticImagePrompt)

Không bắt buộc. Hình ảnh được liên kết với bảng.
columns[]

object (TableColumn)

Không bắt buộc. Tiêu đề và căn chỉnh các cột.
rows[]

object (TableRow)

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ợ tính 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

object (StaticLinkPrompt)

Không bắt buộc. Nút.

TableColumn

Mô tả một cột trong bảng.

Trình bày YAML 
header: string
align: enum (HorizontalAlignment)
Các trường
header

string

Văn bản tiêu đề cho cột.
align

enum (HorizontalAlignment)

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.

Trình bày YAML 
cells: 
  - object (TableCell)
divider: boolean
Các trường
cells[]

object (TableCell)

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

boolean

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.

Trình bày YAML 
text: string
Các trường
text

string

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: 11

Trình bày YAML 
mediaType: enum (MediaType)
startOffset: string
optionalMediaControls: 
  - enum (OptionalMediaControls)
mediaObjects: 
  - object (MediaObject)
repeatMode: enum (RepeatMode)
Các trường
mediaType

enum (MediaType)

Loại nội dung đa phương tiện của phản hồi này.
startOffset

string (Duration format)

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 's'. Ví dụ: "3.5s".
optionalMediaControls[]

enum (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[]

object (MediaObject)

Danh sách đối tượng nội dung nghe nhìn.
repeatMode

enum (RepeatMode)

Chế độ lặp lại cho danh sách Đối tượng phương tiện.

MediaObject

Đại diện cho một đối tượng phương tiện.

Trình bày YAML 
name: string
description: string
url: string
image: 
  object (MediaImage)
Các trường
name

string

Tên của đối tượng nội dung đa phương tiện này.
description

string

Nội dung mô tả về đối tượng nội dung đa phương tiện này.
url

string

URL trỏ đến nội dung nghe nhìn.
image

object (MediaImage)

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.

Trình bày YAML 
# Union field image can be only one of the following:
large: 
  object (StaticImagePrompt)
icon: 
  object (StaticImagePrompt)
# End of list of possible types for union field image.
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

object (StaticImagePrompt)

Một hình ảnh lớn, chẳng hạn như bìa album, v.v.
icon

object (StaticImagePrompt)

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.

Trình bày YAML 
title: string
subtitle: string
items: 
  - object (ListItem)
Các trường
title

string

Không bắt buộc. Tiêu đề danh sách.
subtitle

string

Không bắt buộc. Tiêu đề phụ của danh sách.
items[]

object (ListItem)

Bắt buộc. Mục danh sách.

ListItem

Một mục trong danh sách.

Trình bày YAML 
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
Các trường
key

string

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

string

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

string

Không bắt buộc. Văn bản nội dung của mục.
image

object (StaticImagePrompt)

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.

Trình bày YAML 
title: string
subtitle: string
items: 
  - object (CollectionItem)
imageFill: enum (ImageFill)
Các trường
title

string

Không bắt buộc. Tên bộ sưu tập.
subtitle

string

Không bắt buộc. Tiêu đề phụ của bộ sưu tập.
items[]

object (CollectionItem)

Bắt buộc. Các mục trong bộ sưu tập.
imageFill

enum (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.

Trình bày YAML 
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
Các trường
key

string

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

string

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

string

Không bắt buộc. Văn bản nội dung của mục.
image

object (StaticImagePrompt)

Không bắt buộc. Hình ảnh mục.

StaticCollectionBrowsePrompt

Trình bày một nhóm tài liệu trên web dưới dạng một tập hợp các mục có nhiều ô lớn. Bạn có thể chọn các mục để chạy tài liệu web liên kết trong một trình xem web.

Trình bày YAML 
items: 
  - object (CollectionBrowseItem)
imageFill: enum (ImageFill)
Các trường
items[]

object (CollectionBrowseItem)

Các mục trong bộ sưu tập duyệt xem. Kích thước danh sách phải nằm trong khoảng [2, 10].
imageFill

enum (ImageFill)

Tuỳ chọn hiển thị hình ảnh cho các hình ảnh trong bộ sưu tập.

CollectionBrowseItem

Mục trong bộ sưu tập.

Trình bày YAML 
title: string
description: string
footer: string
image: 
  object (StaticImagePrompt)
openUriAction: 
  object (OpenUrl)
Các trường
title

string

Bắt buộc. Tên của mục trong bộ sưu tập.
description

string

Nội dung mô tả về mục bộ sưu tập.
footer

string

Văn bản chân trang cho mục trong bộ sưu tập, hiển thị bên dưới phần mô tả. Một dòng văn bản, bị cắt ngắn bằng dấu ba chấm.
image

object (StaticImagePrompt)

Hình ảnh cho mục trong bộ sưu tập.
openUriAction

object (OpenUrl)

Bắt buộc. URI để mở nếu mục được chọn.

Đề 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.

Trình bày YAML 
title: string
Các trường
title

string

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. Ngoài việc hiển thị phản hồi canvas tương tác, bạn có thể sử dụng thuộc tính 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.

Trình bày YAML 
url: string
data: 
  - value
suppressMic: boolean
sendStateDataToCanvasApp: boolean
enableFullScreen: boolean
continueTtsDuringTouch: boolean
Các trường
url

string

Bắt buộc. URL của chế độ xem web cần tải.
data[]

value (Value format)

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 override trong lời nhắc chứa là false thì các giá trị dữ liệu được định nghĩa 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 lời nhắc Canvas trước đó.
suppressMic

boolean

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.
sendStateDataToCanvasApp

boolean

Không bắt buộc. Nếu là true, siêu dữ liệu liên quan đến cuộc trò chuyện sẽ được đưa vào và gửi lại đến ứng dụng canvas.
enableFullScreen

boolean

Không bắt buộc. Nếu true, ứng dụng canvas sẽ chiếm toàn màn hình và sẽ không có tiêu đề ở trên cùng. Một thông báo ngắn cũng sẽ xuất hiện trên màn hình tải, bao gồm tên hiển thị của Hành động, tên nhà phát triển và hướng dẫn thoát khỏi Hành động đó. Giá trị mặc định: false.
continueTtsDuringTouch

boolean

Không bắt buộc. Nếu được đặt thành true, thao tác nhấn vào màn hình sẽ không dừng tính năng TTS trong toàn bộ phiên canvas. Giá trị mặc định: false.