EventHandler

定义要在事件发生后执行的处理程序。例如，场景中基于意图和条件的事件。

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.
字段
webhookHandler

string

要调用的 webhook 处理程序的名称。
联合字段 prompt。提示可以内嵌，也可以通过名称引用。prompt 只能是下列其中一项：
staticPrompt

object (StaticPrompt)

内嵌静态提示。可以包含对软件包中字符串资源的引用。
staticPromptName

string

要调用的静态提示的名称。

StaticPrompt

表示候选提示列表，系统会选择其中一个候选提示作为要在对用户的回答中显示的提示。此消息可本地化。

YAML 表示法 
candidates: 
  - object (StaticPromptCandidate)
字段
candidates[]

object (StaticPromptCandidate)

要发送给客户的候选提示列表。每个提示都有一个选择器，用于确定何时可以使用该提示。系统会发送与请求匹配的第一个选择器，并忽略其余选择器。

StaticPromptCandidate

表示静态候选提示。

YAML 表示法 
selector: 
  object (Selector)
promptResponse: 
  object (StaticPromptResponse)
字段
selector

object (Selector)

可选。判断此提示是否与请求匹配的条件。如果选择器为空，则始终会触发此提示。
promptResponse

object (StaticPromptResponse)

与选择器关联的提示响应。

选择器

定义提示是否与请求匹配的条件。

YAML 表示法 
surfaceCapabilities: 
  object (SurfaceCapabilities)
字段
surfaceCapabilities

object (SurfaceCapabilities)

所需的 Surface 功能集。

SurfaceCapabilities

表示用户用于向 Action 发出请求的界面。

YAML 表示法 
capabilities: 
  - enum (Capability)
字段
capabilities[]

enum (Capability)

必需。向 Action 发出请求的界面的功能。

StaticPromptResponse

表示要发送给用户的结构化响应，例如文本、语音、卡片、画布数据、建议内容信息卡等。

YAML 表示法 
firstSimple: 
  object (StaticSimplePrompt)
content: 
  object (StaticContentPrompt)
lastSimple: 
  object (StaticSimplePrompt)
suggestions: 
  - object (Suggestion)
link: 
  object (StaticLinkPrompt)
override: boolean
canvas: 
  object (StaticCanvasPrompt)
字段
firstSimple

object (StaticSimplePrompt)

可选。第一条语音回复和纯文字回复。
content

object (StaticContentPrompt)

可选。向用户显示的卡片、列表或媒体等内容。
lastSimple

object (StaticSimplePrompt)

可选。最后一次语音和纯文字回复。
suggestions[]

object (Suggestion)

可选。要向用户显示的建议，这些建议将始终显示在响应末尾。如果包含提示中的 append 字段为 true，则此字段中定义的标题将添加到之前定义的任何建议提示中定义的标题，并移除重复值。
override

boolean

可选。指定如何将此消息与之前定义的消息合并的模式。true 将清除所有之前定义的消息（第一个和最后一个简单消息、内容、建议链接和画布），并添加此提示中定义的消息。false 会将此提示中定义的消息添加到之前的回答中定义的消息。将此字段设置为 false 还会允许附加到简单提示、建议提示和 Canvas 提示（内容提示的一部分）中的某些字段。如果提示中指定了“内容”和“链接”消息，这些消息将始终会被覆盖。默认值为 false。
canvas

object (StaticCanvasPrompt)

用于互动式画布体验的响应。

StaticSimplePrompt

表示要发送给用户的简单提示。

YAML 表示法 
variants: 
  - object (Variant)
字段
variants[]

object (Variant)

可能的变体列表。

变体

表示简单提示中的变体。

YAML 表示法 
speech: string
text: string
字段
speech

string

可选。表示向用户说出的语音。可以是 SSML 或文字转语音。默认情况下，语音将附加到上一个简单提示的语音。如果包含提示中的 override 字段为 true，则此字段中定义的语音将替换上一个简单提示的语音。
text

string

可选。要在聊天气泡中显示的文本。如果未指定，系统将使用呈现方式呈现上面的语音字段。不得超过 640 个字符。默认情况下，文本将附加到上一个简单提示的文本。如果包含提示中的 override 字段为 true，则此字段中定义的文本将替换上一个简单提示的文本。

StaticContentPrompt

StaticPrompt 的 Content 部分的占位符。

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.
字段
联合字段 content。提示中只能出现一种类型的内容。content 只能是下列其中一项：
card

object (StaticCardPrompt)

基本卡片。
image

object (StaticImagePrompt)

图片。
table

object (StaticTablePrompt)

表格卡片。
media

object (StaticMediaPrompt)

指示要播放的一组媒体的响应。
list

object (StaticListPrompt)

显示可供选择的选项列表的卡片。
collection

object (StaticCollectionPrompt)

显示可供选择的选项列表的卡片。
collectionBrowse

object (StaticCollectionBrowsePrompt)

一张卡片，显示了一系列可打开的网页。

StaticCardPrompt

用于显示某些信息的基本卡片，如图片和/或文字

YAML 表示法 
title: string
subtitle: string
text: string
image: 
  object (StaticImagePrompt)
imageFill: enum (ImageFill)
button: 
  object (StaticLinkPrompt)
字段
title

string

可选。卡片的总体标题。
subtitle

string

可选。卡片的副标题。
text

string

必需。所需的卡片正文（除非显示图片）。支持一组数量有限的 Markdown 语法。
image

object (StaticImagePrompt)

可选。卡片的主打图片。高度固定为 192dp。
imageFill

enum (ImageFill)

可选。图片背景的填充方式。
button

object (StaticLinkPrompt)

可选。要在卡片中显示的可点击按钮。

StaticImagePrompt

卡片中显示的图片。

YAML 表示法 
url: string
alt: string
height: integer
width: integer
字段
url

string

必需。图片的来源网址。图片可以是 JPG、PNG 和 GIF（动画和非动画）。例如：https://www.agentx.com/logo.png。
alt

string

必需。将用于无障碍功能的图片的文字说明，例如屏幕阅读器。
height

integer

可选。图片的高度（以像素为单位）。
width

integer

可选。图片的宽度（以像素为单位）。

StaticLinkPrompt

定义将显示为建议内容信息卡且可由用户打开的链接。

YAML 表示法 
name: string
open: 
  object (OpenUrl)
字段
name

string

链接名称
open

object (OpenUrl)

定义用户打开链接时的行为。

OpenUrl

定义用户打开链接时的行为。

YAML 表示法 
url: string
hint: enum (UrlHint)
字段
url

string

网址字段，可以是以下任一项：- 用于打开与应用关联的应用或网页的 http/https 网址
hint

enum (UrlHint)

表示网址类型的提示。

StaticTablePrompt

用于显示文本表格的表格卡片。

YAML 表示法 
title: string
subtitle: string
image: 
  object (StaticImagePrompt)
columns: 
  - object (TableColumn)
rows: 
  - object (TableRow)
button: 
  object (StaticLinkPrompt)
字段
title

string

可选。表格的总体标题。如果设置了字幕，则必须也设置此字段。
subtitle

string

可选。表格的副标题。
image

object (StaticImagePrompt)

可选。与表关联的图片。
columns[]

object (TableColumn)

可选。标题和列的对齐方式。
rows[]

object (TableRow)

可选。表中的行数据。前 3 行保证会显示，但其他行可能会被在某些平台上剪切。请使用模拟器进行测试，看看将针对给定 Surface 显示哪些行。在支持 WEB_BROWSER 功能的 surface 上，您可以将用户引导至包含更多数据的网页。
button

object (StaticLinkPrompt)

可选。按钮。

TableColumn

描述表中的列。

YAML 表示法 
header: string
align: enum (HorizontalAlignment)
字段
header

string

列的标题文本。
align

enum (HorizontalAlignment)

内容与列的水平对齐方式。如果未指定，内容将与前缘对齐。

TableRow

描述表中的行。

YAML 表示法 
cells: 
  - object (TableCell)
divider: boolean
字段
cells[]

object (TableCell)

此行中的单元格。前 3 个单元格一定会显示，但其他单元格可能会被在某些表面上剪切。请使用模拟器进行测试，看看将针对给定 Surface 显示哪些单元格。
divider

boolean

指示每行后是否应有分隔线。

TableCell

描述一行中的单元格。

YAML 表示法 
text: string
字段
text

string

单元格的文本内容。

StaticMediaPrompt

包含有关媒体的信息，例如名称、说明、网址等。下一个 ID：11

YAML 表示法 
mediaType: enum (MediaType)
startOffset: string
optionalMediaControls: 
  - enum (OptionalMediaControls)
mediaObjects: 
  - object (MediaObject)
repeatMode: enum (RepeatMode)
字段
mediaType

enum (MediaType)

此响应的媒体类型。
startOffset

string (Duration format)

第一个媒体对象的起始偏移量。

该持续时间以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
optionalMediaControls[]

enum (OptionalMediaControls)

此媒体响应会话可以支持的可选媒体控件类型。如果设置，当发生特定媒体事件时，系统会向第三方发送请求。如果此政策未设置，3p 仍必须处理两种默认控件类型：FINISHED 和 FAILED。
mediaObjects[]

object (MediaObject)

媒体对象的列表。
repeatMode

enum (RepeatMode)

针对媒体对象列表重复运行模式。

MediaObject

表示单个媒体对象。

YAML 表示法 
name: string
description: string
url: string
image: 
  object (MediaImage)
字段
name

string

此媒体对象的名称。
description

string

此媒体对象的说明。
url

string

指向媒体内容的网址。
image

object (MediaImage)

与媒体卡片一起显示的图片。

MediaImage

要在 MediaPrompt 中显示的图片。

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.
字段
联合字段 image。仅允许使用一种类型的 MediaImage。image 只能是下列其中一项：
large

object (StaticImagePrompt)

大图片，例如影集的封面等。
icon

object (StaticImagePrompt)

标题右侧会显示一个小图片图标。其大小已调整为 36x36 dp。

StaticListPrompt

显示可供选择的选项列表的卡片。

YAML 表示法 
title: string
subtitle: string
items: 
  - object (ListItem)
字段
title

string

可选。列表的标题。
subtitle

string

可选。列表的副标题。
items[]

object (ListItem)

必需。列出项。

ListItem

列表中的一个项。

YAML 表示法 
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
字段
key

string

必需。与关联类型中的条目键名称匹配的 NLU 键。点按项后，此键将作为选择选项参数发回。
title

string

必需。商品的标题。用户点按后，这些文字会一字不差地重新发布到对话中，就如同用户已经输入了一样。每个标题在一组项中必须是唯一的。
description

string

可选。商品的正文。
image

object (StaticImagePrompt)

可选。商品图片。

StaticCollectionPrompt

显示一系列可供选择的选项的卡片。

YAML 表示法 
title: string
subtitle: string
items: 
  - object (CollectionItem)
imageFill: enum (ImageFill)
字段
title

string

可选。合集的标题。
subtitle

string

可选。合集的副标题。
items[]

object (CollectionItem)

必需。合集项。
imageFill

enum (ImageFill)

可选。图片显示选项的类型。

CollectionItem

集合中的项。

YAML 表示法 
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
字段
key

string

必需。与关联类型中的条目键名匹配的 NLU 键。点按项后，此键将作为选择选项参数发回。
title

string

必需。商品的标题。用户点按后，这些文字会一字不差地重新发布到对话中，就如同用户已经输入了一样。每个标题在一组项中必须是唯一的。
description

string

可选。商品的正文。
image

object (StaticImagePrompt)

可选。商品图片。

StaticCollectionBrowsePrompt

将一组网络文档作为大型图块的集合显示。选中内容后，即可在网页查看器中启动与其相关联的网络文档。

YAML 表示法 
items: 
  - object (CollectionBrowseItem)
imageFill: enum (ImageFill)
字段
items[]

object (CollectionBrowseItem)

浏览集合中的项。名单规模应在 [2, 10] 范围内。
imageFill

enum (ImageFill)

集合中的图片的图片显示选项。

CollectionBrowseItem

集合中的项。

YAML 表示法 
title: string
description: string
footer: string
image: 
  object (StaticImagePrompt)
openUriAction: 
  object (OpenUrl)
字段
title

string

必需。集合项的标题。
description

string

集合项的说明。
footer

string

集合项的页脚文本，显示在说明下方。一行文本，用省略号截断。
image

object (StaticImagePrompt)

合集项的图片。
openUriAction

object (OpenUrl)

必需。在项被选中后打开的 URI。

建议

表示建议内容信息卡，这是为方便起见向用户显示的界面元素。

YAML 表示法 
title: string
字段
title

string

必需。建议内容信息卡中显示的文本。用户点按后，这些文字会一字不差地重新发布到对话中，就如同用户已经输入了一样。每个标题在一组建议内容信息卡中必须是唯一的。最多 25 个字符

StaticCanvasPrompt

表示要发送给用户的 Interactive Canvas 响应。此属性可与包含提示中的 firstSimple 字段结合使用，以向用户显示交互式画布响应。

YAML 表示法 
url: string
data: 
  - value
suppressMic: boolean
sendStateDataToCanvasApp: boolean
enableFullScreen: boolean
continueTtsDuringTouch: boolean
字段
url

string

必需。要加载的网页视图的网址。
data[]

value (Value format)

可选。要作为事件传递到沉浸式体验网页的 JSON 数据。如果所包含的提示中的 override 字段是此 Canvas 提示中定义的 false 数据值，则将在之前的 Canvas 提示中定义的数据值之后添加。
suppressMic

boolean

可选。如果值为 true，则在向用户呈现此沉浸式响应后，系统不会打开麦克风来捕获输入。
sendStateDataToCanvasApp

boolean

可选。如果为 true，则包含与对话相关的元数据并发送回画布应用。
enableFullScreen

boolean

可选。如果为 true，则画布应用会占据整个屏幕，且顶部不会有标题。加载屏幕上还会显示消息框消息，其中包含操作的显示名称、开发者名称以及退出操作的说明。默认值：false。
continueTtsDuringTouch

boolean

可选。如果为 true，点按屏幕将不会在整个画布会话中停止 TTS。默认值：false。