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 )

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

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 )

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

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

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

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

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 )

Необязательный. Данные строки таблицы. Первые 3 строки гарантированно будут показаны, но другие могут быть вырезаны на определенных поверхностях. Пожалуйста, проверьте с помощью симулятора, чтобы увидеть, какие строки будут отображаться для данной поверхности. На поверхностях, поддерживающих функцию 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 )

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

divider

boolean

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

Ячейка Таблицы

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

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

string

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

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

Содержит информацию о носителе, такую ​​как имя, описание, URL-адрес и т. д. Next 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, когда произойдет определенное медиа-событие. Если не установлено, 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 )

Необходимый. Список элементов.

Пункт списка

Элемент в списке.

YAML-представление
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
Поля
key

string

Необходимый. Ключ NLU, который соответствует имени ключа записи в связанном типе. При нажатии элемента эта клавиша будет отправлена ​​обратно как параметр опции выбора.

title

string

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

description

string

Необязательный. Основной текст элемента.

image

object ( StaticImagePrompt )

Необязательный. Изображение предмета.

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

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

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 , метаданные, связанные с беседой, включаются и отправляются обратно в приложение холста.

enableFullScreen

boolean

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

continueTtsDuringTouch

boolean

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