- YAML-представление
- СтатикПромпт
- СтатикПромптКандидате
- Селектор
- Возможности поверхности
- СтатикПромптОтклик
- СтатическийПростойПодсказка
- Вариант
- СтатикКонтентПромпт
- СтатическаяКартаПодсказка
- Статическое изображениеПодсказка
- Статиклинкпромпт
- OpenUrl
- Статиктаблепромпт
- ТаблицаСтолбец
- ТаблицаРоу
- Таблеселл
- СтатикМедиаПромпт
- Медиаобъект
- Медиаизображение
- Статиклистлистпромпт
- ListItem
- StaticCollectionPrompt
- КоллекцияЭлемент
- StaticCollectionBrowsePrompt
- КоллекцияОбзорЭлемент
- Предположение
- СтатическийХолстПодсказка
Определяет обработчик, который будет выполняться после события. Примерами событий являются события, основанные на намерениях и условиях, в сцене.
YAML-представление | |
---|---|
webhookHandler: string # Union field |
Поля | ||
---|---|---|
webhookHandler | Имя вызываемого обработчика веб-перехватчика. | |
prompt поля объединения. Подсказки могут быть встроены или указаны по имени. prompt может быть только одной из следующих: | ||
staticPrompt | Встроенная статическая подсказка. Может содержать ссылки на строковые ресурсы в пакетах. | |
staticPromptName | Имя статического приглашения для вызова. |
СтатикПромпт
Представляет список кандидатов на приглашение, один из которых будет выбран в качестве приглашения, отображаемого в ответе пользователю. Это сообщение можно локализовать.
YAML-представление | |
---|---|
candidates:
- object ( |
Поля | |
---|---|
candidates[] | Список кандидатов-подсказок для отправки клиенту. У каждого приглашения есть селектор, позволяющий определить, когда его можно использовать. Будет отправлен первый селектор, соответствующий запросу, а остальные будут игнорироваться. |
СтатикПромптКандидате
Представляет статического кандидата приглашения.
YAML-представление | |
---|---|
selector: object ( |
Поля | |
---|---|
selector | Необязательный. Критерии соответствия этого запроса запросу. Если селектор пуст, это приглашение будет активироваться всегда. |
promptResponse | Быстрый ответ, связанный с селектором. |
Селектор
Определяет критерии соответствия приглашения запросу.
YAML-представление | |
---|---|
surfaceCapabilities:
object ( |
Поля | |
---|---|
surfaceCapabilities | Набор необходимых возможностей поверхности. |
Возможности поверхности
Представляет поверхность, которую пользователь использует для запроса действия.
YAML-представление | |
---|---|
capabilities:
- enum ( |
Поля | |
---|---|
capabilities[] | Необходимый. Возможности поверхности, делающей запрос к Action. |
СтатикПромптОтклик
Представляет структурированные ответы для отправки пользователю, такие как текст, речь, карточки, данные холста, чипы предложений и т. д.
YAML-представление | |
---|---|
firstSimple: object ( |
Поля | |
---|---|
firstSimple | Необязательный. Первый голосовой и текстовый ответ. |
content | Необязательный. Содержимое, такое как карточка, список или медиафайл, который будет отображаться пользователю. |
lastSimple | Необязательный. Последний голосовой и текстовый ответ. |
suggestions[] | Необязательный. Предложения, которые будут отображаться пользователю и всегда будут появляться в конце ответа. Если поле |
link | Необязательный. Дополнительный чип предложения, который может ссылаться на соответствующее приложение или сайт. Чип будет отображаться с заголовком «Открыть». |
override | Необязательный. Режим объединения этих сообщений с ранее определенными сообщениями. |
canvas | Ответ, который будет использоваться для интерактивного взаимодействия с холстом. |
СтатическийПростойПодсказка
Представляет простой запрос, который необходимо отправить пользователю.
YAML-представление | |
---|---|
variants:
- object ( |
Поля | |
---|---|
variants[] | Список возможных вариантов. |
Вариант
Представляет вариант, который является частью простого приглашения.
YAML-представление | |
---|---|
speech: string text: string |
Поля | |
---|---|
speech | Необязательный. Представляет речь, которая будет произнесена пользователю. Это может быть SSML или преобразование текста в речь. По умолчанию речь будет добавлена к речи предыдущей простой подсказки. Если поле |
text | Необязательный. Текст для отображения в чате. Если не указано, будет использоваться отображение речевого поля выше. Ограничено 640 символами. По умолчанию текст будет добавлен к тексту предыдущего простого приглашения. Если поле |
СтатикКонтентПромпт
Заполнитель для части содержимого StaticPrompt.
YAML-представление | |
---|---|
# Union field |
Поля | ||
---|---|---|
content поля объединения. В приглашении может присутствовать только один тип контента. content может быть только одним из следующих: | ||
card | Базовая карта. | |
image | Изображение. | |
table | Настольная карта. | |
media | Ответ, указывающий набор медиафайлов для воспроизведения. | |
list | Карточка для представления списка вариантов на выбор. | |
collection | Карточка со списком вариантов для выбора. | |
collectionBrowse | Карточка с набором веб-страниц, которые нужно открыть. |
СтатическаяКартаПодсказка
Базовая карточка для отображения некоторой информации, например изображения и/или текста.
YAML-представление | |
---|---|
title: string subtitle: string text: string image: object ( |
Поля | |
---|---|
title | Необязательный. Общее название карты. |
subtitle | Необязательный. Подзаголовок карты. |
text | Необходимый. Основной текст карты, который необходим, если изображение не присутствует. Поддерживает ограниченный набор синтаксиса уценки для форматирования. |
image | Необязательный. Изображение героя для карты. Высота фиксирована и равна 192dp. |
imageFill | Необязательный. Как будет заполнен фон изображения. |
button | Необязательный. Нажимаемая кнопка, которая будет отображаться на карточке. |
Статическое изображениеПодсказка
Изображение, отображаемое на карточке.
YAML-представление | |
---|---|
url: string alt: string height: integer width: integer |
Поля | |
---|---|
url | Необходимый. Исходный URL изображения. Изображения могут быть в формате JPG, PNG и GIF (анимированные и неанимированные). Например, |
alt | Необходимый. Текстовое описание изображения, которое будет использоваться для обеспечения доступности, например программы чтения с экрана. |
height | Необязательный. Высота изображения в пикселях. |
width | Необязательный. Ширина изображения в пикселях. |
Статиклинкпромпт
Определяет ссылку, которая будет отображаться в виде подсказки и может быть открыта пользователем.
YAML-представление | |
---|---|
name: string
open:
object ( |
Поля | |
---|---|
name | Название ссылки |
open | Определяет поведение, когда пользователь открывает ссылку. |
OpenUrl
Определяет поведение, когда пользователь открывает ссылку.
YAML-представление | |
---|---|
url: string
hint: enum ( |
Поля | |
---|---|
url | Поле URL-адреса, которое может быть любым из: URL-адреса http/https для открытия приложения, связанного с приложением, или веб-страницы. |
hint | Указывает подсказку для типа URL-адреса. |
Статиктаблепромпт
Карточка таблицы для отображения таблицы текста.
YAML-представление | |
---|---|
title: string subtitle: string image: object ( |
Поля | |
---|---|
title | Необязательный. Общее название таблицы. Должно быть установлено, если установлены субтитры. |
subtitle | Необязательный. Подзаголовок к таблице. |
image | Необязательный. Изображение, связанное с таблицей. |
columns[] | Необязательный. Заголовки и выравнивание столбцов. |
rows[] | Необязательный. Данные строки таблицы. Первые три строки гарантированно будут показаны, но на определенных поверхностях остальные могут быть обрезаны. Пожалуйста, протестируйте с помощью симулятора, чтобы увидеть, какие строки будут отображаться для данной поверхности. На поверхностях, которые поддерживают возможность |
button | Необязательный. Кнопка. |
ТаблицаСтолбец
Описывает столбец в таблице.
YAML-представление | |
---|---|
header: string
align: enum ( |
Поля | |
---|---|
header | Текст заголовка столбца. |
align | Горизонтальное выравнивание содержимого по столбцу. Если не указано, содержимое будет выровнено по переднему краю. |
ТаблицаРоу
Описывает строку в таблице.
YAML-представление | |
---|---|
cells:
- object ( |
Поля | |
---|---|
cells[] | Ячейки в этом ряду. Первые три ячейки гарантированно будут показаны, но на определенных поверхностях остальные могут быть обрезаны. Пожалуйста, протестируйте с помощью симулятора, чтобы увидеть, какие ячейки будут отображаться для данной поверхности. |
divider | Указывает, должен ли быть разделитель после каждой строки. |
Таблеселл
Описывает ячейку в строке.
YAML-представление | |
---|---|
text: string |
Поля | |
---|---|
text | Текстовое содержимое ячейки. |
СтатикМедиаПромпт
Содержит информацию о носителе, такую как имя, описание, URL-адрес и т. д. Следующий идентификатор: 11
YAML-представление | |
---|---|
mediaType: enum ( |
Поля | |
---|---|
mediaType | Тип носителя этого ответа. |
startOffset | Начальное смещение первого медиа-объекта. Длительность в секундах, содержащая до девяти дробных цифр, заканчивающаяся символом « |
optionalMediaControls[] | Дополнительные типы управления мультимедиа, которые может поддерживать этот сеанс ответа на мультимедиа. Если установлено, запрос будет отправлен на 3p, когда произойдет определенное медиа-событие. Если не установлено, 3p все равно должен обрабатывать два типа управления по умолчанию: FINISHED и FAILED. |
mediaObjects[] | Список медиа-объектов. |
repeatMode | Режим повтора для списка медиа-объектов. |
Медиаобъект
Представляет один медиа-объект.
YAML-представление | |
---|---|
name: string
description: string
url: string
image:
object ( |
Поля | |
---|---|
name | Имя этого медиа-объекта. |
description | Описание этого медиа-объекта. |
url | URL-адрес, указывающий на медиа-контент. |
image | Изображение для показа вместе с медиа-картой. |
Медиаизображение
Изображение, которое будет отображаться внутри MediaPrompt.
YAML-представление | |
---|---|
# Union field |
Поля | ||
---|---|---|
image поля объединения. Разрешен только один тип MediaImage. image может быть только одним из следующих: | ||
large | Большое изображение, например обложка альбома и т. д. | |
icon | Небольшой значок изображения отображается справа от заголовка. Его размер изменен до 36x36 dp. |
Статиклистлистпромпт
Карточка для представления списка вариантов на выбор.
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 | Необязательный. Тип опции отображения изображения. |
КоллекцияЭлемент
Предмет в коллекции.
YAML-представление | |
---|---|
key: string
title: string
description: string
image:
object ( |
Поля | |
---|---|
key | Необходимый. Ключ NLU, соответствующий имени ключа записи в связанном типе. При нажатии на элемент этот ключ будет отправлен обратно в качестве параметра выбора опции. |
title | Необходимый. Название предмета. При нажатии этот текст будет дословно отправлен обратно в беседу, как если бы пользователь его напечатал. Каждый заголовок должен быть уникальным среди множества элементов. |
description | Необязательный. Основной текст элемента. |
image | Необязательный. Изображение предмета. |
StaticCollectionBrowsePrompt
Представляет набор веб-документов как коллекцию элементов большой плитки. Элементы могут быть выбраны для запуска связанного с ними веб-документа в средстве веб-просмотра.
YAML-представление | |
---|---|
items: - object ( |
Поля | |
---|---|
items[] | Элементы в коллекции просмотра. Размер списка должен находиться в диапазоне [2, 10]. |
imageFill | Опция отображения изображений для изображений в коллекции. |
КоллекцияОбзорЭлемент
Предмет в коллекции.
YAML-представление | |
---|---|
title: string description: string footer: string image: object ( |
Поля | |
---|---|
title | Необходимый. Название предмета коллекции. |
description | Описание предмета коллекции. |
footer | Текст нижнего колонтитула элемента коллекции, отображаемый под описанием. Одна строка текста, обрезанная многоточием. |
image | Изображение предмета коллекции. |
openUriAction | Необходимый. URI для открытия, если элемент выбран. |
Предположение
Представляет чип предложения — элемент пользовательского интерфейса, отображаемый пользователю для удобства.
YAML-представление | |
---|---|
title: string |
Поля | |
---|---|
title | Необходимый. Текст, отображаемый в чипе предложения. При нажатии этот текст будет дословно отправлен обратно в беседу, как если бы пользователь его напечатал. Каждое название должно быть уникальным среди множества фишек предложений. Макс. 25 символов |
СтатическийХолстПодсказка
Представляет ответ Interactive Canvas, который будет отправлен пользователю. Его можно использовать вместе с полем firstSimple
в содержащем приглашении для разговора с пользователем в дополнение к отображению ответа на интерактивном холсте.
YAML-представление | |
---|---|
url: string data: - value suppressMic: boolean sendStateDataToCanvasApp: boolean enableFullScreen: boolean continueTtsDuringTouch: boolean |
Поля | |
---|---|
url | Необходимый. URL-адрес веб-представления для загрузки. |
data[] | Необязательный. Данные JSON, которые будут переданы на веб-страницу иммерсивного опыта как событие. Если поле |
suppressMic | Необязательный. Значение true означает, что микрофон не будет открыт для захвата ввода после того, как пользователю будет представлен иммерсивный ответ. |
sendStateDataToCanvasApp | Необязательный. Если |
enableFullScreen | Необязательный. Если |
continueTtsDuringTouch | Необязательный. Если это правда, нажатия на экран не будут останавливать TTS на протяжении всего сеанса холста. Значение по умолчанию: ложь. |