- YAML 表示法
- StaticPrompt
- StaticPromptCandidate
- 选择器
- SurfaceCapabilities
- StaticPromptResponse
- StaticSimplePrompt
- 变体
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- StaticLinkPrompt
- OpenUrl
- StaticTablePrompt
- TableColumn
- TableRow
- TableCell
- StaticMediaPrompt
- MediaObject
- MediaImage
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- StaticCollectionBrowsePrompt
- CollectionBrowseItem
- 建议
- StaticCanvasPrompt
定义要在事件之后执行的处理程序。事件示例包括场景中基于意向和条件的事件。
YAML 表示法 | |
---|---|
webhookHandler: string # Union field |
字段 | ||
---|---|---|
webhookHandler |
要调用的 webhook 处理程序的名称。 |
|
联合字段 prompt 。提示可以内嵌或按名称引用。prompt 只能是下列其中一项: |
||
staticPrompt |
内嵌的静态提示。可以包含对捆绑包中的字符串资源的引用。 |
|
staticPromptName |
要调用的静态提示的名称。 |
StaticPrompt
表示提示候选项列表,其中一个将作为要在响应用户显示的提示。此消息可本地化。
YAML 表示法 | |
---|---|
candidates:
- object ( |
字段 | |
---|---|
candidates[] |
要发送给客户端的候选提示列表。每个提示都有一个选择器,用于确定何时可以使用相应提示。系统会发送与请求匹配的第一个选择器,并忽略其余选择器。 |
StaticPromptCandidate
表示静态候选提示。
YAML 表示法 | |
---|---|
selector: object ( |
字段 | |
---|---|
selector |
可选。指示此提示是否与请求匹配的条件。如果选择器为空,系统将始终触发此提示。 |
promptResponse |
与选择器关联的提示响应。 |
选择器
定义提示是否与请求匹配的条件。
YAML 表示法 | |
---|---|
surfaceCapabilities:
object ( |
字段 | |
---|---|
surfaceCapabilities |
必需的 Surface 功能集。 |
SurfaceCapabilities
表示用户用来向 Action 发出请求的 Surface。
YAML 表示法 | |
---|---|
capabilities:
- enum ( |
字段 | |
---|---|
capabilities[] |
必需。向 Action 发出请求的 Surface 的功能。 |
StaticPromptResponse
表示要发送给用户的结构化响应,例如文本、语音、卡片、画布数据、建议内容信息卡等。
YAML 表示法 | |
---|---|
firstSimple: object ( |
字段 | |
---|---|
firstSimple |
可选。第一条语音和纯文本响应。 |
content |
可选。要向用户显示的卡片、列表或媒体等内容。 |
lastSimple |
可选。最后一次的语音和纯文本回复。 |
suggestions[] |
可选。要向用户显示的建议,这些建议将始终显示在响应的末尾。如果包含的提示中的 |
link |
可选。可链接到关联的应用或网站的额外建议内容信息卡。条状标签将在标题中显示“打开” |
override |
可选。指定如何与先前定义的消息合并的模式。 |
canvas |
用于交互式画布体验的响应。 |
StaticSimplePrompt
表示要发送给用户的简单提示。
YAML 表示法 | |
---|---|
variants:
- object ( |
字段 | |
---|---|
variants[] |
可能的变体的列表。 |
变体
表示属于简单提示的变体。
YAML 表示法 | |
---|---|
speech: string text: string |
字段 | |
---|---|
speech |
可选。表示要对用户说出的语音。可以是 SSML 或文字转语音。默认情况下,语音会附加到上一个简单提示的语音。如果包含提示中的 |
text |
可选。要在聊天气泡中显示的文本。如果未指定,将使用上述语音字段的显示渲染。上限为 640 个字符。默认情况下,文本会附加到上一个简单提示的文本中。如果包含的提示中的 |
StaticContentPrompt
StaticPrompt 的内容部分的占位符。
YAML 表示法 | |
---|---|
# Union field |
字段 | ||
---|---|---|
联合字段 content 。提示中只能包含一种类型的内容。content 只能是下列其中一项: |
||
card |
基本卡片。 |
|
image |
图片。 |
|
table |
表格卡片。 |
|
media |
指示要播放的一组媒体的响应。 |
|
list |
用于显示选项列表的卡片。 |
|
collection |
一张卡片,其中显示了一系列可供选择的选项。 |
|
collectionBrowse |
一张卡片,表示一系列可打开的网页。 |
StaticCardPrompt
用于显示一些信息(例如图片和/或文字)的基本卡片。
YAML 表示法 | |
---|---|
title: string subtitle: string text: string image: object ( |
字段 | |
---|---|
title |
可选。卡片的总体标题。 |
subtitle |
可选。卡片的副标题。 |
text |
必需。除非显示图片,否则所需的卡片正文。支持一组有限的 Markdown 格式设置语法。 |
image |
可选。卡片的主打图片。高度固定为 192dp。 |
imageFill |
可选。图片背景的填充方式。 |
button |
可选。可在卡片中显示的可点击按钮。 |
StaticImagePrompt
卡片中显示的图片。
YAML 表示法 | |
---|---|
url: string alt: string height: integer width: integer |
字段 | |
---|---|
url |
必需。图片的来源网址。图片可以是 JPG、PNG 和 GIF(动画和非动画)。例如 |
alt |
必需。用于无障碍功能的图片的文字说明,例如屏幕阅读器。 |
height |
可选。图片的高度(以像素为单位)。 |
width |
可选。图片的宽度(以像素为单位)。 |
StaticLinkPrompt
定义显示为建议内容信息条并可由用户打开的链接。
YAML 表示法 | |
---|---|
name: string
open:
object ( |
字段 | |
---|---|
name |
关联名称 |
open |
定义用户打开链接时的行为。 |
OpenUrl
定义用户打开链接时的行为。
YAML 表示法 | |
---|---|
url: string
hint: enum ( |
字段 | |
---|---|
url |
网址字段,可以是以下任一种:- 用于打开与应用关联的应用或网页的 http/https 网址 |
hint |
表示关于网址类型的提示。 |
StaticTablePrompt
用于显示文本表格的表格卡片。
YAML 表示法 | |
---|---|
title: string subtitle: string image: object ( |
字段 | |
---|---|
title |
可选。表格的总体标题。如果设置了副标题,则必须设置。 |
subtitle |
可选。表格的副标题。 |
image |
可选。与表关联的图片。 |
columns[] |
可选。标题和列的对齐方式。 |
rows[] |
可选。表的行数据。前 3 行一定会显示,但其他行可能会被某些 Surface 裁剪。请使用模拟器进行测试,了解给定界面将会显示哪些行。在支持 |
button |
可选。按钮。 |
TableColumn
描述表中的列。
YAML 表示法 | |
---|---|
header: string
align: enum ( |
字段 | |
---|---|
header |
列的标题文本。 |
align |
内容列的水平对齐方式。如果未指定,内容将与前边缘对齐。 |
TableRow
描述表中的行。
YAML 表示法 | |
---|---|
cells:
- object ( |
字段 | |
---|---|
cells[] |
此行中的单元格。前 3 个单元格一定会显示,但其他单元格可能在某些表面上被裁剪掉。请使用模拟器进行测试,了解给定界面将会显示哪些单元格。 |
divider |
指示每行后面是否应该有一个分隔线。 |
TableCell
描述行中的一个单元格。
YAML 表示法 | |
---|---|
text: string |
字段 | |
---|---|
text |
单元格的文本内容。 |
StaticMediaPrompt
包含媒体的相关信息,例如名称、说明、网址等。下一个 ID:11
YAML 表示法 | |
---|---|
mediaType: enum ( |
字段 | |
---|---|
mediaType |
此响应的媒体类型。 |
startOffset |
第一个媒体对象的起始偏移量。 该持续时间以秒为单位,最多包含九个小数位,以“ |
optionalMediaControls[] |
此媒体响应会话可以支持的可选媒体控件类型。如果设置此参数,当特定媒体事件发生时,系统会向第三方发出请求。如果未设置,第三方仍必须处理两种默认控件类型:FINISHED 和 FAILED。 |
mediaObjects[] |
媒体对象的列表。 |
repeatMode |
针对媒体对象列表的重复模式。 |
MediaObject
表示单个媒体对象。
YAML 表示法 | |
---|---|
name: string
description: string
url: string
image:
object ( |
字段 | |
---|---|
name |
此媒体对象的名称。 |
description |
此媒体对象的说明。 |
url |
指向媒体内容的网址。 |
image |
与媒体卡片一起显示的图片。 |
MediaImage
要在 MediaPrompt 中显示的图片。
YAML 表示法 | |
---|---|
# Union field |
字段 | ||
---|---|---|
联合字段 image 。只允许使用一种类型的 MediaImage。image 只能是下列其中一项: |
||
large |
大图片,例如专辑封面等。 |
|
icon |
显示在标题右侧的小图片图标。它的大小会调整为 36x36 dp。 |
StaticListPrompt
用于显示选项列表的卡片。
YAML 表示法 | |
---|---|
title: string
subtitle: string
items:
- object ( |
字段 | |
---|---|
title |
可选。列表标题。 |
subtitle |
可选。列表的副标题。 |
items[] |
必需。列出项。 |
ListItem
列表中的一个项。
YAML 表示法 | |
---|---|
key: string
title: string
description: string
image:
object ( |
字段 | |
---|---|
key |
必需。与关联类型中的条目键名称匹配的 NLU 键。用户点按内容时,此键将以选择选项参数的形式发回。 |
title |
必需。商品的标题。用户点按该文字后,系统会将文字完整地发布回对话,就像用户之前输入文字一样。每个标题在一组项中必须是唯一的。 |
description |
可选。商品的正文。 |
image |
可选。商品图片。 |
StaticCollectionPrompt
一张卡片,用于显示一系列可供选择的选项。
YAML 表示法 | |
---|---|
title: string subtitle: string items: - object ( |
字段 | |
---|---|
title |
可选。集合的标题。 |
subtitle |
可选。合集的副标题。 |
items[] |
必需。集合项。 |
imageFill |
可选。图片显示选项的类型。 |
CollectionItem
集合中的一项。
YAML 表示法 | |
---|---|
key: string
title: string
description: string
image:
object ( |
字段 | |
---|---|
key |
必需。与关联类型中的条目键名称匹配的 NLU 键。用户点按内容时,此键将以选择选项参数的形式发回。 |
title |
必需。商品的标题。用户点按该文字后,系统会将文字完整地发布回对话,就像用户之前输入文字一样。每个标题在一组项中必须是唯一的。 |
description |
可选。商品的正文。 |
image |
可选。商品图片。 |
StaticCollectionBrowsePrompt
将一组网络文档显示为大图块项的集合。可选择项目,以在网络查看器中启动其关联的网络文档。
YAML 表示法 | |
---|---|
items: - object ( |
字段 | |
---|---|
items[] |
浏览集合中的项。名单规模应在 [2, 10] 范围内。 |
imageFill |
集合中图片的图片显示选项。 |
CollectionBrowseItem
集合中的项。
YAML 表示法 | |
---|---|
title: string description: string footer: string image: object ( |
字段 | |
---|---|
title |
必需。合集项的标题。 |
description |
合集项的说明。 |
footer |
合集项的页脚文本,显示在说明下方。单行文本,用省略号截断。 |
image |
合集项的图片。 |
openUriAction |
必需。要在内容被选中时打开的 URI。 |
建议
表示建议内容信息卡,这是为方便起见而向用户显示的界面元素。
YAML 表示法 | |
---|---|
title: string |
字段 | |
---|---|
title |
必需。建议内容信息卡中显示的文本。用户点按该文字后,系统会将文字完整地发布回对话,就像用户之前输入文字一样。每个标题在建议内容信息卡组中必须是唯一的。最多 25 个字符 |
StaticCanvasPrompt
表示要发送给用户的 Interactive Canvas 响应。除了显示交互式画布响应之外,此字段还可与包含的语音提示中的 firstSimple
字段结合使用。
YAML 表示法 | |
---|---|
url: string data: - value suppressMic: boolean sendStateDataToCanvasApp: boolean enableFullScreen: boolean continueTtsDuringTouch: boolean |
字段 | |
---|---|
url |
必需。要加载的网页视图的网址。 |
data[] |
可选。作为事件传递给沉浸式体验网页的 JSON 数据。如果所在提示中的 |
suppressMic |
可选。值为 true 表示在向用户呈现此沉浸式响应后,不会打开麦克风来捕获输入。 |
sendStateDataToCanvasApp |
可选。如果为 |
enableFullScreen |
可选。如果为 |
continueTtsDuringTouch |
可选。如果为 true,点按屏幕将不会停止整个画布会话的 TTS。默认值:false。 |