EventHandler

Xác định một trình xử lý cần đượ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 theo 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.
Trường
webhookHandler

string

Tên của trình xử lý webhook cần gọi.

Trường kết hợp prompt. Lời nhắc có thể nằm trong 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 thông tin tham chiếu đến tài nguyên chuỗi trong các gói.

staticPromptName

string

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

StaticPrompt

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

Trình bày theo YAML
candidates: 
  - object (StaticPromptCandidate)
Trường
candidates[]

object (StaticPromptCandidate)

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.

Trình bày theo YAML
selector: 
  object (Selector)
promptResponse: 
  object (StaticPromptResponse)
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ó 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

object (StaticPromptResponse)

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.

Trình bày theo YAML
surfaceCapabilities: 
  object (SurfaceCapabilities)
Trường
surfaceCapabilities

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

Trình bày theo YAML
capabilities: 
  - enum (Capability)
Trường
capabilities[]

enum (Capability)

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.

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

object (StaticSimplePrompt)

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

object (StaticContentPrompt)

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

object (StaticSimplePrompt)

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

object (Suggestion)

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 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 các tiêu đề đã 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á.

override

boolean

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 đó. true 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) và thêm các thông báo được xác định trong câu lệnh này. false sẽ thêm các 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 đó. Việ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 câu lệnh Đơ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

object (StaticCanvasPrompt)

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.

Trình bày theo YAML
variants: 
  - object (Variant)
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 theo YAML
speech: string
text: string
Trường
speech

string

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

Trình bày theo 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.
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

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)

Thẻ để trình bày danh sách các lựa chọn.

collection

object (StaticCollectionPrompt)

Một thẻ trình bày danh sách các lựa chọn để bạn lựa chọn.

collectionBrowse

object (StaticCollectionBrowsePrompt)

Thẻ trình bày một tập hợp các trang web cần mở.

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.

Trình bày theo YAML
title: string
subtitle: string
text: string
image: 
  object (StaticImagePrompt)
imageFill: enum (ImageFill)
button: 
  object (StaticLinkPrompt)
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ẻ, 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

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 vào sẽ xuất hiện trong Thẻ.

StaticImagePrompt

Hình ảnh hiển thị trong thẻ.

Trình bày theo YAML
url: string
alt: string
height: integer
width: integer
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 (ảnh động và tĩnh). Ví dụ: https://www.agentx.com/logo.png.

alt

string

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

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 mà người dùng có thể mở.

Trình bày theo YAML
name: string
open: 
  object (OpenUrl)
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 theo YAML
url: string
hint: enum (UrlHint)
Trường
url

string

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

enum (UrlHint)

Cho biết gợi ý về loại url.

StaticTablePrompt

Thẻ bảng để hiển thị một bảng văn bản.

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

string

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

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ột.

rows[]

object (TableRow)

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

object (StaticLinkPrompt)

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

TableColumn

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

Trình bày theo YAML
header: string
align: enum (HorizontalAlignment)
Trường
header

string

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

align

enum (HorizontalAlignment)

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.

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

object (TableCell)

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

boolean

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.

Trình bày theo YAML
text: string
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 theo YAML
mediaType: enum (MediaType)
startOffset: string
optionalMediaControls: 
  - enum (OptionalMediaControls)
mediaObjects: 
  - object (MediaObject)
repeatMode: enum (RepeatMode)
Trường
mediaType

enum (MediaType)

Loại nội dung nghe nhìn của câu trả lời này.

startOffset

string (Duration format)

Độ 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 "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 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[]

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 nội dung đa phương tiện.

MediaObject

Đại diện cho một đối tượng nội dung nghe nhìn duy nhất.

Trình bày theo YAML
name: string
description: string
url: string
image: 
  object (MediaImage)
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 nghe nhìn này.

url

string

URL trỏ đến nội dung đa phương tiện.

image

object (MediaImage)

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.

Trình bày theo 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.
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

object (StaticImagePrompt)

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

icon

object (StaticImagePrompt)

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.

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

string

Không bắt buộc. Tiêu đề của 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 trong danh sách.

ListItem

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

Trình bày theo YAML
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
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 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

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

string

Không bắt buộc. Văn bản nội dung của mặt hàng.

image

object (StaticImagePrompt)

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.

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

string

Không bắt buộc. Tiêu đề của 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 hình ảnh hiển thị.

CollectionItem

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

Trình bày theo YAML
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
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 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

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

string

Không bắt buộc. Văn bản nội dung của mặt hàng.

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 web dưới dạng tập hợp các mục ô lớn. Bạn có thể chọn các mục để chạy tài liệu trên web được liên kết trong trình xem trên web.

Trình bày theo YAML
items: 
  - object (CollectionBrowseItem)
imageFill: enum (ImageFill)
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 theo YAML
title: string
description: string
footer: string
image: 
  object (StaticImagePrompt)
openUriAction: 
  object (OpenUrl)
Trường
title

string

Bắt buộc. Tiêu đề của mục trong bộ sưu tập.

description

string

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

footer

string

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

image

object (StaticImagePrompt)

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

openUriAction

object (OpenUrl)

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

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

Trình bày theo YAML
title: string
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 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ể sử dụng tính năng này kết hợp với trường firstSimple trong câu lệnh chứa để trò chuyện với người dùng ngoài việc hiện câu trả lời có tính tương tác trên canvas.

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

string

Bắt buộc. URL của chế độ xem trên web cần tải.

data[]

value (Value format)

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 trường override trong câu lệnh chứa false thì 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

boolean

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.

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 cho ứ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à 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 đặt là true, thì các thao tác nhấn vào màn hình sẽ không dừng TTS trong toàn bộ phiên canvas. Giá trị mặc định: false.