ButtonPressed

Навык получает запрос с типом ButtonPressed, если в предыдущем ответе пользователь нажал:

  • отдельную кнопку (свойство hide со значением true) с непустым полем payload;
  • изображение (тип BigImage) с непустым полем payload в card.button;
  • элемент списка (тип ItemList) с непустым полем payload в items.button;
  • изображение из галереи (тип ImageGallery) с непустым полем payload в items.button.
{
  "request": {
    "nlu": {
      "tokens": [
        "надпись",
        "на",
        "кнопке"
      ],
      "entities": [],
      "intents": {}
    },
    "payload": {}
    "type": "ButtonPressed"
  }
}

request

Данные, полученные от пользователя.

Свойство

Описание

markup

object

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

payload

string

JSON-объект, полученный с нажатой кнопкой от обработчика навыка (в ответе на предыдущий запрос), максимум 4096 байт.

nlu

object

Слова и именованные сущности, которые Диалоги извлекли из запроса пользователя.

Подробное описание поддерживаемых типов сущностей см. в разделе Именованные сущности в запросах .

tokens

object

Обозначение начала и конца именованной сущности в массиве слов. Нумерация слов в массиве начинается с 0.

type

string

Тип ввода. Возможные значения см. в разделе Формат запроса.

request.markup

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

Свойство

Описание

dangerous_context

boolean

Признак реплики, которая содержит криминальный подтекст (самоубийство, разжигание ненависти, угрозы). Вы можете настроить навык на определенную реакцию для таких случаев — например, отвечать «Не понимаю, о чем вы. Пожалуйста, переформулируйте вопрос.»

Возможно только значение true. Если признак не применим, это свойство не включается в ответ.

request.nlu

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

Подробное описание поддерживаемых типов сущностей см. в разделе Именованные сущности в запросах.

Свойство

Описание

tokens[]

array of strings.

Массив слов из произнесенной пользователем фразы.

entities[]

array of objects.

Массив именованных сущностей.

intents

object

Объект с данными, извлеченными из пользовательского запроса.

Подробнее см. в разделе Обработка естественного языка (NLP).

request.nlu.entities

Массив именованных сущностей.

Свойство

Описание

start

number

Первое слово именованной сущности.

end

number

Первое слово после именованной сущности.

type

string

Тип именованной сущности. Возможные значения:

  • YANDEX.DATETIME — дата и время, абсолютные или относительные.
  • YANDEX.FIO — фамилия, имя и отчество.
  • YANDEX.GEO — местоположение (адрес или аэропорт).
  • YANDEX.NUMBER — число, целое или с плавающей точкой.

value

object

Формальное описание именованной сущности.

Формат этого поля для всех поддерживаемых типов сущностей приведен в разделе Именованные сущности в запросах .

Cтрока, выделяется кавычками, например "Hello world".

Целое или дробное число без кавычек, например 25.5.

Логическое значение без кавычек: true (истина) или false (ложь).

Массив элементов, разделенных запятой. Элементом могут быть стандартные элементы JSON: строка, число, true, false, объект или массив. Массив выделяется квадратными скобками []: "cities": ["Moscow", "Tokyo", "New York"]

Список пар "ключ": значение, разделенных запятой. Выделяется фигурными скобками {}.

{
  "name": "John",
  "surname": "Smith"
}
Предыдущая
Формат запроса
Следующая
Show.Pull