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

Имя вызываемого обработчика веб-перехватчика.

prompt поля объединения. Подсказки могут быть встроены или указаны по имени. prompt может быть только одной из следующих:
staticPrompt

object ( StaticPrompt )

Встроенная статическая подсказка. Может содержать ссылки на строковые ресурсы в пакетах.

staticPromptName

string

Имя статического приглашения для вызова.

СтатикПромпт

Представляет список кандидатов на приглашение, один из которых будет выбран в качестве приглашения, отображаемого в ответе пользователю. Это сообщение можно локализовать.

YAML-представление 
candidates: 
  - object (StaticPromptCandidate)
Поля
candidates[]

object ( StaticPromptCandidate )

Список кандидатов-подсказок для отправки клиенту. У каждого приглашения есть селектор, позволяющий определить, когда его можно использовать. Будет отправлен первый селектор, соответствующий запросу, а остальные будут игнорироваться.

СтатикПромптКандидате

Представляет статического кандидата приглашения.

YAML-представление 
selector: 
  object (Selector)
promptResponse: 
  object (StaticPromptResponse)
Поля
selector

object ( Selector )

Необязательный. Критерии соответствия этого запроса запросу. Если селектор пуст, это приглашение будет активироваться всегда.

promptResponse

object ( StaticPromptResponse )

Быстрый ответ, связанный с селектором.

Селектор

Определяет критерии соответствия приглашения запросу.

YAML-представление 
surfaceCapabilities: 
  object (SurfaceCapabilities)
Поля
surfaceCapabilities

object ( SurfaceCapabilities )

Набор необходимых возможностей поверхности.

Возможности поверхности

Представляет поверхность, которую пользователь использует для запроса действия.

YAML-представление 
capabilities: 
  - enum (Capability)
Поля
capabilities[]

enum ( Capability )

Необходимый. Возможности поверхности, делающей запрос к Action.

СтатикПромптОтклик

Представляет структурированные ответы для отправки пользователю, такие как текст, речь, карточки, данные холста, чипы предложений и т. д.

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 также позволит добавлять к некоторым полям простые приглашения, приглашение «Предложения» и приглашение «Холст» (часть приглашения «Содержимое»). Сообщения о содержимом и ссылках всегда будут перезаписаны, если они определены в приглашении. Значение по умолчанию — false .

canvas

object ( StaticCanvasPrompt )

Ответ, который будет использоваться для интерактивного взаимодействия с холстом.

СтатическийПростойПодсказка

Представляет простой запрос, который необходимо отправить пользователю.

YAML-представление 
variants: 
  - object (Variant)
Поля
variants[]

object ( Variant )

Список возможных вариантов.

Вариант

Представляет вариант, который является частью простого приглашения.

YAML-представление 
speech: string
text: string
Поля
speech

string

Необязательный. Представляет речь, которая будет произнесена пользователю. Это может быть SSML или преобразование текста в речь. По умолчанию речь будет добавлена ​​к речи предыдущей простой подсказки. Если поле override в содержащем приглашении true речь, определенная в этом поле, будет переопределять речь предыдущего простого приглашения.

text

string

Необязательный. Текст для отображения в чате. Если не указано, будет использоваться отображение речевого поля выше. Ограничено 640 символами. По умолчанию текст будет добавлен к тексту предыдущего простого приглашения. Если поле override в содержащем приглашении имеет true текст, определенный в этом поле, будет переопределять текст предыдущего простого приглашения.

СтатикКонтентПромпт

Заполнитель для части содержимого StaticPrompt.

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 )

Карточка с набором веб-страниц, которые нужно открыть.

СтатическаяКартаПодсказка

Базовая карточка для отображения некоторой информации, например изображения и/или текста.

YAML-представление 
title: string
subtitle: string
text: string
image: 
  object (StaticImagePrompt)
imageFill: enum (ImageFill)
button: 
  object (StaticLinkPrompt)
Поля
title

string

Необязательный. Общее название карты.

subtitle

string

Необязательный. Подзаголовок карты.

text

string

Необходимый. Основной текст карты, который необходим, если изображение не присутствует. Поддерживает ограниченный набор синтаксиса уценки для форматирования.

image

object ( StaticImagePrompt )

Необязательный. Изображение героя для карты. Высота фиксирована и равна 192dp.

imageFill

enum ( ImageFill )

Необязательный. Как будет заполнен фон изображения.

button

object ( StaticLinkPrompt )

Необязательный. Нажимаемая кнопка, которая будет отображаться на карточке.

Статическое изображениеПодсказка

Изображение, отображаемое на карточке.

YAML-представление 
url: string
alt: string
height: integer
width: integer
Поля
url

string

Необходимый. Исходный URL изображения. Изображения могут быть в формате JPG, PNG и GIF (анимированные и неанимированные). Например, https://www.agentx.com/logo.png .

alt

string

Необходимый. Текстовое описание изображения, которое будет использоваться для обеспечения доступности, например программы чтения с экрана.

height

integer

Необязательный. Высота изображения в пикселях.

width

integer

Необязательный. Ширина изображения в пикселях.

Статиклинкпромпт

Определяет ссылку, которая будет отображаться в виде подсказки и может быть открыта пользователем.

YAML-представление 
name: string
open: 
  object (OpenUrl)
Поля
name

string

Название ссылки

open

object ( OpenUrl )

Определяет поведение, когда пользователь открывает ссылку.

OpenUrl

Определяет поведение, когда пользователь открывает ссылку.

YAML-представление 
url: string
hint: enum (UrlHint)
Поля
url

string

Поле URL-адреса, которое может быть любым из: URL-адреса http/https для открытия приложения, связанного с приложением, или веб-страницы.

hint

enum ( UrlHint )

Указывает подсказку для типа URL-адреса.

Статиктаблепромпт

Карточка таблицы для отображения таблицы текста.

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 )

Необязательный. Данные строки таблицы. Первые три строки гарантированно будут показаны, но на определенных поверхностях остальные могут быть обрезаны. Пожалуйста, протестируйте с помощью симулятора, чтобы увидеть, какие строки будут отображаться для данной поверхности. На поверхностях, которые поддерживают возможность WEB_BROWSER , вы можете указать пользователю на веб-страницу с дополнительными данными.

button

object ( StaticLinkPrompt )

Необязательный. Кнопка.

ТаблицаСтолбец

Описывает столбец в таблице.

YAML-представление 
header: string
align: enum (HorizontalAlignment)
Поля
header

string

Текст заголовка столбца.

align

enum ( HorizontalAlignment )

Горизонтальное выравнивание содержимого по столбцу. Если не указано, содержимое будет выровнено по переднему краю.

ТаблицаРоу

Описывает строку в таблице.

YAML-представление 
cells: 
  - object (TableCell)
divider: boolean
Поля
cells[]

object ( TableCell )

Ячейки в этом ряду. Первые три ячейки гарантированно будут показаны, но на определенных поверхностях остальные могут быть обрезаны. Пожалуйста, протестируйте с помощью симулятора, чтобы увидеть, какие ячейки будут отображаться для данной поверхности.

divider

boolean

Указывает, должен ли быть разделитель после каждой строки.

Таблеселл

Описывает ячейку в строке.

YAML-представление 
text: string
Поля
text

string

Текстовое содержимое ячейки.

СтатикМедиаПромпт

Содержит информацию о носителе, такую ​​как имя, описание, URL-адрес и т. д. Следующий идентификатор: 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, когда произойдет определенное медиа-событие. Если не установлено, 3p все равно должен обрабатывать два типа управления по умолчанию: FINISHED и FAILED.

mediaObjects[]

object ( MediaObject )

Список медиа-объектов.

repeatMode

enum ( RepeatMode )

Режим повтора для списка медиа-объектов.

Медиаобъект

Представляет один медиа-объект.

YAML-представление 
name: string
description: string
url: string
image: 
  object (MediaImage)
Поля
name

string

Имя этого медиа-объекта.

description

string

Описание этого медиа-объекта.

url

string

URL-адрес, указывающий на медиа-контент.

image

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

Статиклистлистпромпт

Карточка для представления списка вариантов на выбор.

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 )

Необязательный. Тип опции отображения изображения.

КоллекцияЭлемент

Предмет в коллекции.

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 )

Опция отображения изображений для изображений в коллекции.

КоллекцияОбзорЭлемент

Предмет в коллекции.

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 символов

СтатическийХолстПодсказка

Представляет ответ Interactive Canvas, который будет отправлен пользователю. Его можно использовать вместе с полем firstSimple в содержащем приглашении для разговора с пользователем в дополнение к отображению ответа на интерактивном холсте.

YAML-представление 
url: string
data: 
  - value
suppressMic: boolean
sendStateDataToCanvasApp: boolean
enableFullScreen: boolean
continueTtsDuringTouch: boolean
Поля
url

string

Необходимый. URL-адрес веб-представления для загрузки.

data[]

value ( Value format)

Необязательный. Данные JSON, которые будут переданы на веб-страницу иммерсивного опыта как событие. Если поле override в содержащем приглашении содержит false значения данных, определенные в этом приглашении Canvas, будут добавлены после значений данных, определенных в предыдущих приглашениях Canvas.

suppressMic

boolean

Необязательный. Значение true означает, что микрофон не будет открыт для захвата ввода после того, как пользователю будет представлен иммерсивный ответ.

sendStateDataToCanvasApp

boolean

Необязательный. Если true , метаданные, связанные с диалогом, включаются и отправляются обратно в приложение Canvas.

enableFullScreen

boolean

Необязательный. Если true приложение Canvas занимает весь экран и не имеет заголовка вверху. На экране загрузки также будет отображаться всплывающее сообщение, содержащее отображаемое имя действия, имя разработчика и инструкции по выходу из действия. Значение по умолчанию: false .

continueTtsDuringTouch

boolean

Необязательный. Если это правда, нажатия на экран не будут останавливать TTS на протяжении всего сеанса холста. Значение по умолчанию: ложь.