SimpleUtterance

Навык получает запрос с типом SimpleUtterance, если:

  • Пользователь произносит фразу.
  • Пользователь нажимает кнопку в бабле из предыдущего ответа навыка (свойство hide со значением false).
  • Пользователь нажимает отдельную кнопку в предыдущем ответе навыка (свойство hide со значением true) с отсутствующим значением в поле payload.
  • Пользователь впервые обращается к навыку в контексте сессии. Остальные поля в объекте request в этом случае передаются пустыми.
  1. request
  2. request.markup
  3. request.nlu
  4. request.nlu.entities
{
  "request": {
    "command": "закажи пиццу на улицу льва толстого 16 на завтра",
    "original_utterance": "закажи пиццу на улицу льва толстого, 16 на завтра",
    "markup": {
      "dangerous_context": true
    },
    "payload": {},
    "nlu": {
      "tokens": [
        "закажи",
        "пиццу",
        "на",
        "льва",
        "толстого",
        "16",
        "на",
        "завтра"
      ],
      "entities": [
        {
          "tokens": {
            "start": 2,
            "end": 6
          },
          "type": "YANDEX.GEO",
          "value": {
            "house_number": "16",
            "street": "льва толстого"
          }
        },
        {
          "tokens": {
            "start": 3,
            "end": 5
          },
          "type": "YANDEX.FIO",
          "value": {
            "first_name": "лев",
            "last_name": "толстой"
          }
        },
        {
          "tokens": {
            "start": 5,
            "end": 6
          },
          "type": "YANDEX.NUMBER",
          "value": 16
        },
        {
          "tokens": {
            "start": 6,
            "end": 8
          },
          "type": "YANDEX.DATETIME",
          "value": {
            "day": 1,
            "day_is_relative": true
          }
        }
      ],
      "intents": {},
    }
    "type": "SimpleUtterance"
  },
}

request

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

Свойство Описание
command

string

Нормализованный текст запроса. В ходе нормализации текст очищается от знаков препинания, приводится к нижнему регистру, а числительные преобразуются в числа. При запуске навыка по запросу вида «Спроси у навыка <Название> сколько времени» в command придет только правая часть запроса: «сколько времени».

Чтобы получить точный текст запроса, используйте свойство original_utterance.

original_utterance

string

Полный текст пользовательского запроса, максимум 1024 символа.

Если свойство содержит значение ping, то запрос выполняется Диалогами и является проверочным.

markup

object

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

nlu

object

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

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

tokens

object

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

type

string

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

Свойство Описание
command

string

Нормализованный текст запроса. В ходе нормализации текст очищается от знаков препинания, приводится к нижнему регистру, а числительные преобразуются в числа. При запуске навыка по запросу вида «Спроси у навыка <Название> сколько времени» в command придет только правая часть запроса: «сколько времени».

Чтобы получить точный текст запроса, используйте свойство original_utterance.

original_utterance

string

Полный текст пользовательского запроса, максимум 1024 символа.

Если свойство содержит значение ping, то запрос выполняется Диалогами и является проверочным.

markup

object

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

nlu

object

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

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

tokens

object

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

type

string

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

request.markup

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

Свойство Описание
dangerous_context

boolean

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

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

Свойство Описание
dangerous_context

boolean

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

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

request.nlu

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

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

Свойство Описание
tokens[]

array of strings

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

entities[]

array of objects

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

intents

object

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

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

Свойство Описание
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, number

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

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

Свойство Описание
start

number

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

end

number

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

type

string

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

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

object, number

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

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

Служба поддержки