StaticPrompt

表示提示候选项列表，其中一个将作为要在响应用户显示的提示。此消息可本地化。

JSON 表示法 
{
  "candidates": [
    {
      object (StaticPromptCandidate)
    }
  ]
}
字段
candidates[]

object (StaticPromptCandidate)

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

StaticPromptCandidate

表示静态候选提示。

JSON 表示法 
{
  "selector": {
    object (Selector)
  },
  "promptResponse": {
    object (StaticPromptResponse)
  }
}
字段
selector

object (Selector)

可选。指示此提示是否与请求匹配的条件。如果选择器为空，系统将始终触发此提示。
promptResponse

object (StaticPromptResponse)

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

选择器

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

JSON 表示法 
{
  "surfaceCapabilities": {
    object (SurfaceCapabilities)
  }
}
字段
surfaceCapabilities

object (SurfaceCapabilities)

必需的 Surface 功能集。

SurfaceCapabilities

表示用户用来向 Action 发出请求的 Surface。

JSON 表示法 
{
  "capabilities": [
    enum (Capability)
  ]
}
字段
capabilities[]

enum (Capability)

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

StaticPromptResponse

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

JSON 表示法 
{
  "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

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

JSON 表示法 
{
  "variants": [
    {
      object (Variant)
    }
  ]
}
字段
variants[]

object (Variant)

可能的变体的列表。

变体

表示属于简单提示的变体。

JSON 表示法 
{
  "speech": string,
  "text": string
}
字段
speech

string

可选。表示要对用户说出的语音。可以是 SSML 或文字转语音。如果包含提示中的“附加”字段为“true”，此字段中定义的语音将附加到上一个简单提示的语音。
text

string

可选。要在聊天气泡中显示的文本。如果未指定，将使用上述语音字段的显示渲染。上限为 640 个字符。如果包含的提示中的“附加”字段为“true”，此字段中定义的文本将会附加到上一个简单提示的文本。

StaticContentPrompt

StaticPrompt 的内容部分的占位符。

JSON 表示法 
{

  // 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)
  }
  // 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)

一张卡片，其中显示了一系列可供选择的选项。

StaticCardPrompt

用于显示一些信息（例如图片和/或文字）的基本卡片。

JSON 表示法 
{
  "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

卡片中显示的图片。

JSON 表示法 
{
  "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

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

JSON 表示法 
{
  "name": string,
  "open": {
    object (OpenUrl)
  }
}
字段
name

string

关联名称
open

object (OpenUrl)

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

OpenUrl

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

JSON 表示法 
{
  "url": string,
  "hint": enum (UrlHint)
}
字段
url

string

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

enum (UrlHint)

表示关于网址类型的提示。

StaticTablePrompt

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

JSON 表示法 
{
  "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

描述表中的列。

JSON 表示法 
{
  "header": string,
  "align": enum (HorizontalAlignment)
}
字段
header

string

列的标题文本。
align

enum (HorizontalAlignment)

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

TableRow

描述表中的行。

JSON 表示法 
{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}
字段
cells[]

object (TableCell)

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

boolean

指示每行后面是否应该有一个分隔线。

TableCell

描述行中的一个单元格。

JSON 表示法 
{
  "text": string
}
字段
text

string

单元格的文本内容。

StaticMediaPrompt

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

JSON 表示法 
{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ]
}
字段
mediaType

enum (MediaType)

此响应的媒体类型。
startOffset

string (Duration format)

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

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

enum (OptionalMediaControls)

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

object (MediaObject)

媒体对象的列表。

MediaObject

表示单个媒体对象。

JSON 表示法 
{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}
字段
name

string

此媒体对象的名称。
description

string

此媒体对象的说明。
url

string

指向媒体内容的网址。
image

object (MediaImage)

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

MediaImage

要在 MediaPrompt 中显示的图片。

JSON 表示法 
{

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

用于显示选项列表的卡片。

JSON 表示法 
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}
字段
title

string

可选。列表标题。
subtitle

string

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

object (ListItem)

必需。列出项。

ListItem

列表中的一个项。

JSON 表示法 
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
字段
key

string

必需。与关联类型中的条目键名称匹配的 NLU 键。用户点按内容时，此键将以选择选项参数的形式发回。
title

string

必需。商品的标题。用户点按该文字后，系统会将文字完整地发布回对话，就像用户之前输入文字一样。每个标题在一组项中必须是唯一的。
description

string

可选。商品的正文。
image

object (StaticImagePrompt)

可选。商品图片。

StaticCollectionPrompt

一张卡片，用于显示一系列可供选择的选项。

JSON 表示法 
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
字段
title

string

可选。集合的标题。
subtitle

string

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

object (CollectionItem)

必需。集合项。
imageFill

enum (ImageFill)

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

CollectionItem

集合中的一项。

JSON 表示法 
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
字段
key

string

必需。与关联类型中的条目键名称匹配的 NLU 键。用户点按内容时，此键将以选择选项参数的形式发回。
title

string

必需。商品的标题。用户点按该文字后，系统会将文字完整地发布回对话，就像用户之前输入文字一样。每个标题在一组项中必须是唯一的。
description

string

可选。商品的正文。
image

object (StaticImagePrompt)

可选。商品图片。

建议

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

JSON 表示法 
{
  "title": string
}
字段
title

string

必需。建议内容信息卡中显示的文本。用户点按该文字后，系统会将文字完整地发布回对话，就像用户之前输入文字一样。每个标题在建议内容信息卡组中必须是唯一的。最多 25 个字符

StaticCanvasPrompt

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

JSON 表示法 
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean
}
字段
url

string

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

value (Value format)

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

boolean

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