Spec-Zone.ru › AWS CLI v2

[ aws . lexv2-runtime ]

recognize-text

Описание

Отправляет пользовательский ввод в Amazon Lex V2. Приложения-клиенты используют этот API для отправки запросов в Amazon Lex V2 во время выполнения. Amazon Lex V2 затем интерпретирует пользовательский ввод, используя модель машинного обучения, созданную для бота.

В ответ Amazon Lex V2 возвращает следующее сообщение для пользователя и необязательную карточку ответа для отображения.

Если указан необязательный ответ после выполнения, сообщения возвращаются следующим образом. Для получения дополнительной информации см. PostFulfillmentStatusSpecification.

  • Сообщение об успехе - Возвращается, если функция Lambda выполняется успешно, и состояние интента выполнено или готово к выполнению, если сообщение присутствует.
  • Сообщение об ошибке - Сообщение об ошибке возвращается, если функция Lambda выбрасывает исключение или если функция Lambda возвращает состояние интента с ошибкой без сообщения.
  • Сообщение о таймауте - Если вы не настраиваете сообщение о таймауте и таймаут, и функция Lambda не возвращает данные в течение 30 секунд, возвращается сообщение о таймауте. Если вы настраиваете таймаут, сообщение о таймауте возвращается при истечении срока.

Для получения дополнительной информации см. Сообщение о завершении.

См. также: Документация AWS API

Синтаксис

  recognize-text
--bot-id <value>
--bot-alias-id <value>
--locale-id <value>
--session-id <value>
--text <value>
[--session-state <value>]
[--request-attributes <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--bot-id (строка)

Идентификатор бота, обрабатывающего запрос.

--bot-alias-id (строка)

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

--locale-id (строка)

Локаль, в которой используется сессия.

--session-id (строка)

Идентификатор сессии пользователя, ведущего беседу.

--text (строка)

Текст, введенный пользователем. Amazon Lex V2 интерпретирует этот текст.

--session-state (структура)

Текущее состояние диалога между пользователем и ботом.

dialogAction -> (структура)

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

type -> (строка)

Следующее действие, которое должен предпринять бот в своём взаимодействии с пользователем. Возможные значения:

  • Close – Указывает, что ответ от пользователя не требуется. Например, утверждение «Ваш заказ оформлен» не требует ответа.
  • ConfirmIntent – Следующее действие заключается в запросе у пользователя о завершении и готовности интента к выполнению. Это вопрос типа «Да/Нет», например, «Подтвердить заказ?»
  • Delegate – Следующее действие определяется Amazon Lex V2.
  • ElicitIntent – Следующее действие заключается в извлечении интента от пользователя.
  • ElicitSlot – Следующее действие заключается в извлечении значения слота от пользователя.

slotToElicit -> (строка)

Имя слота, которое нужно извлечь от пользователя.

slotElicitationStyle -> (строка)

Настраивает слот для использования стиля «по буквам» или «по словам». При использовании стиля в слоте пользователи могут набирать ввод, чтобы сделать его понятным для вашего бота.

  • По буквам – «б» «о» «б»
  • По словам – «б как в boy» «о как в oscar» «б как в boy»

Для получения дополнительной информации см. Использование правописания для ввода значений слотов.

subSlotToElicit -> (структура)

Имя составляющей подслота составного слота, указанного в slotToElicit, которое необходимо извлечь от пользователя.

name -> (строка)

Имя слота, которое нужно извлечь от пользователя.

subSlotToElicit -> (структура)

Поле не поддерживается.

name -> (строка)

Имя слота, которое нужно извлечь от пользователя.

( … рекурсивно … )

intent -> (структура)

Активный интент, обрабатываемый Amazon Lex V2.

name -> (строка)

Имя интента.

slots -> (массив)

Массив всех слотов для интента. Название слота сопоставляется со значением слота. Если слот не заполнен, значение равно null.

key -> (строка)

value -> (структура)

Значение, используемое Amazon Lex V2 для выполнения интента.

value -> (структура)

Текущее значение слота.

originalValue -> (строка)

Часть ответа пользователя на извлечение слота, которую Amazon Lex V2 определяет как релевантную для значения слота.

interpretedValue -> (строка)

Значение, которое Amazon Lex V2 определяет для слота, исходя из ввода пользователя. Фактическое значение зависит от настройки стратегии выбора значения для бота. Вы можете использовать значение, введенное пользователем, или Amazon Lex V2 может выбрать первое значение в списке resolvedValues.

resolvedValues -> (список)

Список значений, которые Amazon Lex V2 определяет как возможные решения для ввода пользователя. Первое значение соответствует interpretedValue.

(строка)

shape -> (строка)

Если значение shape равно List, это указывает, что поле values содержит список значений слотов. Если значение равно Scalar, это указывает, что поле value содержит единственное значение.

values -> (список)

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

(структура)

Значение, используемое Amazon Lex V2 для выполнения интента.

value -> (структура)

Текущее значение слота.

originalValue -> (строка)

Часть ответа пользователя на извлечение слота, которую Amazon Lex V2 определяет как релевантную для значения слота.

interpretedValue -> (строка)

Значение, которое Amazon Lex V2 определяет для слота, исходя из ввода пользователя. Фактическое значение зависит от настройки стратегии выбора значения для бота. Вы можете использовать значение, введенное пользователем, или Amazon Lex V2 может выбрать первое значение в списке resolvedValues.

resolvedValues -> (список)

Список значений, которые Amazon Lex V2 определяет как возможные решения для ввода пользователя. Первое значение соответствует interpretedValue.

(строка)

shape -> (строка)

Если значение shape равно List, это указывает, что поле values содержит список значений слотов. Если значение равно Scalar, это указывает, что поле value содержит единственное значение.

values -> (список)

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

( … рекурсивно … )

subSlots -> (массив)

Составные подслоты составного слота.

key -> (строка)

( … рекурсивно … )

subSlots -> (массив)

Составные подслоты составного слота.

key -> (строка)

value -> (структура)

Значение, используемое Amazon Lex V2 для выполнения интента.

value -> (структура)

Текущее значение слота.

originalValue -> (строка)

Часть ответа пользователя на извлечение слота, которую Amazon Lex V2 определяет как релевантную для значения слота.

interpretedValue -> (строка)

Значение, которое Amazon Lex V2 определяет для слота, исходя из ввода пользователя. Фактическое значение зависит от настройки стратегии выбора значения для бота. Вы можете использовать значение, введенное пользователем, или Amazon Lex V2 может выбрать первое значение в списке resolvedValues.

resolvedValues -> (список)

Список значений, которые Amazon Lex V2 определяет как возможные решения для ввода пользователя. Первое значение соответствует interpretedValue.

(строка)

shape -> (строка)

Если значение shape равно List, это указывает, что поле values содержит список значений слотов. Если значение равно Scalar, это указывает, что поле value содержит единственное значение.

values -> (список)

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

( … рекурсивно … )

state -> (строка)

Указывает состояние выполнения интента. Значения и их смыслы:

  • Failed – Бот не смог выполнить интент.
  • Fulfilled – Бот завершил выполнение интента.
  • FulfillmentInProgress – Бот находится в процессе выполнения интента.
  • InProgress – Бот находится в процессе извлечения значений слотов, необходимых для выполнения интента.
  • ReadyForFulfillment – Бот извлек все значения слотов для интента и готов к его выполнению.
  • Waiting – Бот ожидает ответа от пользователя (ограничено потоковыми беседами).

confirmationState -> (строка)

Указывает, был ли интент подтвержден, отменен или подтверждение еще не достигнуто.

activeContexts -> (список)

Один или несколько контекстов, указывающих Amazon Lex V2 контекст запроса. Когда контекст активен, Amazon Lex V2 рассматривает интенты с соответствующим контекстом как триггер для следующего интента в сессии.

(структура)

Содержит информацию о контекстах, используемых пользователем в сессии. Вы можете настроить Amazon Lex V2 на установку контекста при выполнении интента или установить контекст с помощью операций , , или .

Используйте контекст, чтобы указать Amazon Lex V2 интенты, которые следует использовать в качестве последующих интентов. Например, если активным контекстом является order-fulfilled, только интенты с order-fulfilled, настроенным как триггер, рассматриваются для продолжения.

name -> (строка)

Имя контекста.

timeToLive -> (структура)

Указывает количество оборотов или секунд, в течение которых контекст активен. После истечения срока действия контекст больше не возвращается в ответе.

timeToLiveInSeconds -> (целое число)

Количество секунд, в течение которых контекст активен. Можно указать от 5 до 86400 секунд (24 часа).

turnsToLive -> (целое число)

Количество оборотов, в течение которых контекст активен. Можно указать до 20 оборотов. Каждый запрос и ответ от бота – это оборот.

contextAttributes -> (массив)

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

Если список контекстов не указан, Amazon Lex V2 будет использовать текущий список контекстов для сессии. Если указан пустой список, все контексты сессии очищаются.

key -> (строка)

value -> (строка)

sessionAttributes -> (массив)

Массив пар ключ/значение, представляющих информацию о контексте, специфичном для сессии. Он содержит информацию приложения, передаваемую между Amazon Lex V2 и приложением-клиентом.

key -> (строка)

value -> (строка)

originatingRequestId -> (строка)

Уникальный идентификатор конкретного запроса.

runtimeHints -> (структура)

Подсказки для фраз, которые клиент, вероятно, использует для слота. Amazon Lex V2 использует подсказки, чтобы определить правильное значение слота.

slotHints -> (map)

Список слотов в интенте, для которых должны быть добавлены подсказки во время выполнения, и фразы, которые должны быть добавлены для каждого слота.

Первый уровень карты slotHints — имя интента. Второй уровень — имя слота внутри интента. Дополнительную информацию см. в разделе Использование подсказок для повышения точности.

Имя интента и имя слота должны существовать.

key -> (string)

value -> (map)

key -> (string)

value -> (structure)

Предоставляет массив фраз, которым следует отдавать предпочтение при разрешении значений для слота.

runtimeHintValues -> (list)

Одна или несколько строк, которые Amazon Lex V2 должен искать во вводе бота. Каждая фраза отдаётся предпочтение при определении значений слотов.

(structure)

Предоставляет фразу, которую Amazon Lex V2 должен искать во вводе пользователя в бот.

phrase -> (string)

Фраза, которую Amazon Lex V2 должен искать во вводе пользователя в бот.

subSlotHints -> (map)

Карта составных имён подслотов внутри сложного слота в интенте и фраз, которые следует добавить для каждого подслота. Внутри подсказок каждого сложного слота эта структура предоставляет механизм для добавления фрагментов подслотов с высокой детализацией. Подсказки подслотов поддерживаются только для сложных слотов. Имя интента, имя сложного слота и имена составных подслотов должны существовать.

key -> (string)

value -> (structure)

Предоставляет массив фраз, которым следует отдавать предпочтение при разрешении значений для слота.

runtimeHintValues -> (list)

Одна или несколько строк, которые Amazon Lex V2 должен искать во вводе бота. Каждая фраза отдаётся предпочтение при определении значений слотов.

(structure)

Предоставляет фразу, которую Amazon Lex V2 должен искать во вводе пользователя в бот.

phrase -> (string)

Фраза, которую Amazon Lex V2 должен искать во вводе пользователя в бот.

Синтаксис JSON:

{
  "dialogAction": {
    "type": "Close"|"ConfirmIntent"|"Delegate"|"ElicitIntent"|"ElicitSlot"|"None",
    "slotToElicit": "string",
    "slotElicitationStyle": "Default"|"SpellByLetter"|"SpellByWord",
    "subSlotToElicit": {
      "name": "string",
      "subSlotToElicit": {
        "name": "string",
        "subSlotToElicit": { ... recursive ... }
      }
    }
  },
  "intent": {
    "name": "string",
    "slots": {"string": {
          "value": {
            "originalValue": "string",
            "interpretedValue": "string",
            "resolvedValues": ["string", ...]
          },
          "shape": "Scalar"|"List"|"Composite",
          "values": [
            {
              "value": {
                "originalValue": "string",
                "interpretedValue": "string",
                "resolvedValues": ["string", ...]
              },
              "shape": "Scalar"|"List"|"Composite",
              "values": [
                { ... recursive ... }
                ...
              ],
              "subSlots": {"string": { ... recursive ... }
                ...}
            }
            ...
          ],
          "subSlots": {"string": {
                "value": {
                  "originalValue": "string",
                  "interpretedValue": "string",
                  "resolvedValues": ["string", ...]
                },
                "shape": "Scalar"|"List"|"Composite",
                "values": [
                  { ... recursive ... }
                  ...
                ],
                "subSlots":
              }
            ...}
        }
      ...},
    "state": "Failed"|"Fulfilled"|"InProgress"|"ReadyForFulfillment"|"Waiting"|"FulfillmentInProgress",
    "confirmationState": "Confirmed"|"Denied"|"None"
  },
  "activeContexts": [
    {
      "name": "string",
      "timeToLive": {
        "timeToLiveInSeconds": integer,
        "turnsToLive": integer
      },
      "contextAttributes": {"string": "string"
        ...}
    }
    ...
  ],
  "sessionAttributes": {"string": "string"
    ...},
  "originatingRequestId": "string",
  "runtimeHints": {
    "slotHints": {"string": {"string": {
              "runtimeHintValues": [
                {
                  "phrase": "string"
                }
                ...
              ],
              "subSlotHints": {"string": {
                    "runtimeHintValues": [
                      {
                        "phrase": "string"
                      }
                      ...
                    ],
                    "subSlotHints":
                  }
                ...}
            }
          ...}
      ...}
  }
}

--request-attributes (map)

Информация, специфичная для запроса, передаваемая между клиентом и Amazon Lex V2

Пространство имён x-amz-lex: зарезервировано для специальных атрибутов. Не создавайте атрибуты запроса с префиксом x-amz-lex: .

key -> (string)

value -> (string)

Сокращенный синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному в --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределяют значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного JSON, поскольку строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (string) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено без значения или с значением input, выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример YAML-ввода, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверит входные данные команд и вернёт JSON-пример вывода для этой команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Общие параметры

--debug (boolean)

Включить отладовую запись в журнал.

--endpoint-url (string)

Переопределить значение по умолчанию URL команды на заданный URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверит сертификаты SSL. Этот параметр переопределяет поведение по умолчанию проверки сертификатов SSL.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для использования в фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/отключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет вызывать тайм-аут. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет вызывать тайм-аут. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде строки, закодированной в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичное и использовать содержимое файла напрямую независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Отключить кли-пейджер для вывода.

--cli-auto-prompt (boolean)

Автоматически запросить параметры CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запросы параметров CLI.

Вывод

messages -> (list)

Список сообщений, последней отправленных пользователю. Сообщения упорядочены в соответствии с порядком, в котором вы вернули сообщения из вашей Lambda-функции или в порядке определения сообщений в боте.

(structure)

Контейнер для текста, возвращаемого клиенту.

content -> (string)

Текст сообщения.

contentType -> (string)

Указывает тип ответа.

imageResponseCard -> (structure)

Карта, отображаемая пользователю платформой обмена сообщениями. Вы определяете содержимое карты, платформа отображает её.

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

title -> (string)

Заголовок для отображения на карте ответа. Формат заголовка определяется платформой, отображающей карту ответа.

subtitle -> (string)

Подзаголовок для отображения на карте ответа. Формат подзаголовка определяется платформой, отображающей карту ответа.

imageUrl -> (string)

URL изображения для отображения на карте ответа. URL изображения должен быть доступен в открытом доступе, чтобы платформа, отображающая карту ответа, имела доступ к изображению.

buttons -> (list)

Список кнопок, которые должны быть отображены на карте ответа. Расположение кнопок определяется платформой, отображающей кнопки.

(structure)

Кнопка, отображаемая на карте ответа пользователю.

text -> (string)

Текст, отображаемый на кнопке.

value -> (string)

Значение, возвращаемое Amazon Lex V2, когда пользователь выбирает кнопку.

sessionState -> (structure)

Представляет текущее состояние диалога между пользователем и ботом.

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

dialogAction -> (структура)

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

type -> (строка)

Следующее действие, которое бот должен предпринять во взаимодействии с пользователем. Возможные значения:

  • Close – Указывает, что ответ от пользователя не требуется. Например, утверждение «Ваш заказ оформлен» не требует ответа.
  • ConfirmIntent – Следующее действие заключается в вопросе пользователю, завершен ли запрос и готов ли он к выполнению. Это вопрос типа «да/нет», например, «Оформить заказ?»
  • Delegate – Следующее действие определяется Amazon Lex V2.
  • ElicitIntent – Следующее действие — запрос намерения у пользователя.
  • ElicitSlot – Следующее действие — запрос значения слота у пользователя.

slotToElicit -> (строка)

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

slotElicitationStyle -> (строка)

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

  • Ввод по буквам – «б» «о» «б»
  • Ввод по словам – «б, как в слове бой» «о, как в слове оскар» «б, как в слове бой»

Дополнительную информацию см. в разделе Использование ввода по буквам для ввода значений слота.

subSlotToElicit -> (структура)

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

name -> (строка)

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

subSlotToElicit -> (структура)

Поле не поддерживается.

name -> (строка)

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

( … рекурсивно … )

intent -> (структура)

Активное намерение, обрабатываемое Amazon Lex V2.

name -> (строка)

Имя намерения.

slots -> (карта)

Карта всех слотов для намерения. Название слота сопоставляется со значением слота. Если слот не заполнен, значение равно null.

key -> (строка)

value -> (структура)

Значение, используемое Amazon Lex V2 для выполнения намерения.

value -> (структура)

Текущее значение слота.

originalValue -> (строка)

Часть ответа пользователя на запрос значения слота, которую Amazon Lex V2 определяет как относящуюся к значению слота.

interpretedValue -> (строка)

Значение, определенное Amazon Lex V2 для слота на основе входных данных пользователя. Фактическое значение зависит от настроек стратегии выбора значений для бота. Вы можете использовать значение, введенное пользователем, или позволить Amazon Lex V2 выбрать первое значение в списке resolvedValues.

resolvedValues -> (список)

Список значений, которые Amazon Lex V2 определяет как возможные разрешения для входных данных пользователя. Первое значение соответствует значению interpretedValue.

(строка)

shape -> (строка)

Когда значение shape равно List, это указывает, что поле values содержит список значений слота. Когда значение равно Scalar, это указывает, что поле value содержит одно значение.

values -> (список)

Список одного или нескольких значений, предоставленных пользователем для слота. Например, если для слота запрашиваются добавки к пицце, значениями могут быть «перчик» и «ананас».

(структура)

Значение, используемое Amazon Lex V2 для выполнения намерения.

value -> (структура)

Текущее значение слота.

originalValue -> (строка)

Часть ответа пользователя на запрос значения слота, которую Amazon Lex V2 определяет как относящуюся к значению слота.

interpretedValue -> (строка)

Значение, определенное Amazon Lex V2 для слота на основе входных данных пользователя. Фактическое значение зависит от настроек стратегии выбора значений для бота. Вы можете использовать значение, введенное пользователем, или позволить Amazon Lex V2 выбрать первое значение в списке resolvedValues.

resolvedValues -> (список)

Список значений, которые Amazon Lex V2 определяет как возможные разрешения для входных данных пользователя. Первое значение соответствует значению interpretedValue.

(строка)

shape -> (строка)

Когда значение shape равно List, это указывает, что поле values содержит список значений слота. Когда значение равно Scalar, это указывает, что поле value содержит одно значение.

values -> (список)

Список одного или нескольких значений, предоставленных пользователем для слота. Например, если для слота запрашиваются добавки к пицце, значениями могут быть «перчик» и «ананас».

( … рекурсивно … )

subSlots -> (карта)

Составные подслоты составного слота.

key -> (строка)

( … рекурсивно … )

subSlots -> (карта)

Составные подслоты составного слота.

key -> (строка)

value -> (структура)

Значение, используемое Amazon Lex V2 для выполнения намерения.

value -> (структура)

Текущее значение слота.

originalValue -> (строка)

Часть ответа пользователя на запрос значения слота, которую Amazon Lex V2 определяет как относящуюся к значению слота.

interpretedValue -> (строка)

Значение, определенное Amazon Lex V2 для слота на основе входных данных пользователя. Фактическое значение зависит от настроек стратегии выбора значений для бота. Вы можете использовать значение, введенное пользователем, или позволить Amazon Lex V2 выбрать первое значение в списке resolvedValues.

resolvedValues -> (список)

Список значений, которые Amazon Lex V2 определяет как возможные разрешения для входных данных пользователя. Первое значение соответствует значению interpretedValue.

(строка)

shape -> (строка)

Когда значение shape равно List, это указывает, что поле values содержит список значений слота. Когда значение равно Scalar, это указывает, что поле value содержит одно значение.

values -> (список)

Список одного или нескольких значений, предоставленных пользователем для слота. Например, если для слота запрашиваются добавки к пицце, значениями могут быть «перчик» и «ананас».

( … рекурсивно … )

state -> (строка)

Указывает состояние выполнения намерения. Значения и их смыслы:

  • Failed – Бот не смог выполнить намерение.
  • Fulfilled – Бот завершил выполнение намерения.
  • FulfillmentInProgress – Бот находится в процессе выполнения намерения.
  • InProgress – Бот находится в процессе запроса значений слотов, необходимых для выполнения намерения.
  • ReadyForFulfillment – Бот запросил все значения слотов для намерения и готов к его выполнению.
  • Waiting – Бот ожидает ответа от пользователя (ограничено для потоковых разговоров).

confirmationState -> (строка)

Указывает, было ли намерение Confirmed, Denied, или None, если этап подтверждения еще не достигнут.

activeContexts -> (список)

Один или несколько контекстов, которые указывают Amazon Lex V2 на контекст запроса. Когда контекст активен, Amazon Lex V2 рассматривает намерения с соответствующим контекстом как триггер в качестве следующего намерения в сессии.

(структура)

Содержит информацию о контекстах, которые пользователь использует в сессии. Вы можете настроить Amazon Lex V2 на установку контекста при выполнении намерения или установить контекст с помощью операций , , или .

Используйте контекст для указания Amazon Lex V2 намерений, которые должны использоваться в качестве последующих намерений. Например, если активным контекстом является order-fulfilled, только намерения, у которых order-fulfilled настроен как триггер, рассматриваются для последующих намерений.

name -> (строка)

Имя контекста.

timeToLive -> (структура)

Указывает количество шагов или секунд, в течение которых контекст активен. После истечения срока действия контекст больше не возвращается в ответе.

timeToLiveInSeconds -> (целое число)

Количество секунд, в течение которых контекст активен. Вы можете указать от 5 до 86400 секунд (24 часа).

turnsToLive -> (целое число)

Количество шагов, в течение которых контекст активен. Вы можете указать до 20 шагов. Каждый запрос и ответ от бота — это шаг.

contextAttributes -> (карта)

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

Если вы не укажете список контекстов, Amazon Lex V2 будет использовать текущий список контекстов для сессии. Если вы укажете пустой список, все контексты сессии будут очищены.

key -> (строка)

value -> (строка)

sessionAttributes -> (карта)

Карта пар ключ/значение, представляющих информацию о контексте сессии. Она содержит информацию приложения, передаваемую между Amazon Lex V2 и приложением-клиентом.

key -> (строка)

value -> (строка)

originatingRequestId -> (строка)

Уникальный идентификатор конкретного запроса.

runtimeHints -> (структура)

Подсказки для фраз, которые клиент, вероятно, использует для слота. Amazon Lex V2 использует подсказки, чтобы определить правильное значение слота.

slotHints -> (map)

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

Первый уровень карты slotHints — это имя намерения. Второй уровень — имя слота в намерении. Дополнительную информацию см. в разделе Использование подсказок для повышения точности.

Имя намерения и имя слота должны существовать.

key -> (string)

value -> (map)

key -> (string)

value -> (structure)

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

runtimeHintValues -> (list)

Одна или несколько строк, которые Amazon Lex V2 должен искать в входных данных бота. Каждая фраза предпочтительнее при определении значений слотов.

(structure)

Предоставляет фразу, которую Amazon Lex V2 должен искать в входных данных пользователя боту.

phrase -> (string)

Фраза, которую Amazon Lex V2 должен искать во входных данных пользователя боту.

subSlotHints -> (map)

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

key -> (string)

value -> (structure)

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

runtimeHintValues -> (list)

Одна или несколько строк, которые Amazon Lex V2 должен искать во входных данных бота. Каждая фраза предпочтительнее при определении значений слотов.

(structure)

Предоставляет фразу, которую Amazon Lex V2 должен искать во входных данных пользователя боту.

phrase -> (string)

Фраза, которую Amazon Lex V2 должен искать во входных данных пользователя боту.

interpretations -> (list)

Список намерений, которые, по мнению Amazon Lex V2, могут удовлетворить высказывание пользователя.

Каждое толкование включает намерение, оценку, которая показывает, насколько уверен Amazon Lex V2, что толкование является правильным, и необязательный ответ о настроении, который указывает на настроение, выраженное в высказывании.

(structure)

Объект, содержащий информацию о намерении, которое, по мнению Amazon Lex V2, может удовлетворить высказывание пользователя. Намерения упорядочены по оценке уверенности.

nluConfidence -> (structure)

Определяет порог, в котором Amazon Lex V2 вставит AMAZON.FallbackIntent, AMAZON.KendraSearchIntent или оба, при возвращении альтернативных намерений в ответе. AMAZON.FallbackIntent и AMAZON.KendraSearchIntent вставляются только в том случае, если они настроены для бота.

score -> (double)

Оценка, которая показывает, насколько уверен Amazon Lex V2 в том, что намерение удовлетворяет намерению пользователя. Диапазон от 0,00 до 1,00. Более высокие оценки означают большую уверенность.

sentimentResponse -> (structure)

Настроение, выраженное в высказывании.

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

sentiment -> (string)

Общее настроение, выраженное в ответе пользователя. Это настроение, наиболее вероятно выраженное пользователем на основе анализа Amazon Comprehend.

sentimentScore -> (structure)

Индивидуальные ответы о настроении для высказывания.

positive -> (double)

Уровень уверенности Amazon Comprehend в точности обнаружения настроения POSITIVE.

negative -> (double)

Уровень уверенности Amazon Comprehend в точности обнаружения настроения NEGATIVE.

neutral -> (double)

Уровень уверенности Amazon Comprehend в точности обнаружения настроения NEUTRAL.

mixed -> (double)

Уровень уверенности Amazon Comprehend в точности обнаружения настроения MIXED.

intent -> (structure)

Список намерений, которые могут удовлетворить высказывание пользователя. Намерения упорядочены по оценке уверенности.

name -> (string)

Имя намерения.

slots -> (map)

Карта всех слотов для намерения. Имя слота сопоставляется со значением слота. Если слот не заполнен, значение равно null.

key -> (string)

value -> (structure)

Значение, которое Amazon Lex V2 использует для выполнения намерения.

value -> (structure)

Текущее значение слота.

originalValue -> (string)

Часть ответа пользователя на запрос значения слота, которую Amazon Lex V2 определяет как релевантную для значения слота.

interpretedValue -> (string)

Значение, которое Amazon Lex V2 определяет для слота, учитывая входные данные пользователя. Фактическое значение зависит от настроек стратегии выбора значения для бота. Вы можете использовать значение, введенное пользователем, или Amazon Lex V2 может выбрать первое значение в списке resolvedValues.

resolvedValues -> (list)

Список значений, которые Amazon Lex V2 определяет как возможные решения для входных данных пользователя. Первое значение соответствует interpretedValue.

(string)

shape -> (string)

Если значение shape равно List, это указывает на то, что поле values содержит список значений слотов. Если значение равно Scalar, это указывает на то, что поле value содержит одно значение.

values -> (list)

Список одного или нескольких значений, которые пользователь предоставил для слота. Например, если слот запрашивает начинки для пиццы, значения могут быть «пепперони» и «ананас».

(structure)

Значение, которое Amazon Lex V2 использует для выполнения намерения.

value -> (structure)

Текущее значение слота.

originalValue -> (string)

Часть ответа пользователя на запрос значения слота, которую Amazon Lex V2 определяет как релевантную для значения слота.

interpretedValue -> (string)

Значение, которое Amazon Lex V2 определяет для слота, учитывая входные данные пользователя. Фактическое значение зависит от настроек стратегии выбора значения для бота. Вы можете использовать значение, введенное пользователем, или Amazon Lex V2 может выбрать первое значение в списке resolvedValues.

resolvedValues -> (list)

Список значений, которые Amazon Lex V2 определяет как возможные решения для входных данных пользователя. Первое значение соответствует interpretedValue.

(string)

shape -> (string)

Если значение shape равно List, это указывает на то, что поле values содержит список значений слотов. Если значение равно Scalar, это указывает на то, что поле value содержит одно значение.

values -> (list)

Список одного или нескольких значений, которые пользователь предоставил для слота. Например, если слот запрашивает начинки для пиццы, значения могут быть «пепперони» и «ананас».

(… рекурсивно…)

subSlots -> (map)

Составные подслоты составного слота.

key -> (string)

(… рекурсивно…)

subSlots -> (map)

Составные подслоты составного слота.

key -> (string)

value -> (structure)

Значение, которое Amazon Lex V2 использует для выполнения намерения.

value -> (structure)

Текущее значение слота.

originalValue -> (string)

Часть ответа пользователя на запрос значения слота, которую Amazon Lex V2 определяет как релевантную для значения слота.

interpretedValue -> (string)

Значение, которое Amazon Lex V2 определяет для слота, учитывая входные данные пользователя. Фактическое значение зависит от настроек стратегии выбора значения для бота. Вы можете использовать значение, введенное пользователем, или Amazon Lex V2 может выбрать первое значение в списке resolvedValues.

resolvedValues -> (list)

Список значений, которые Amazon Lex V2 определяет как возможные решения для входных данных пользователя. Первое значение соответствует interpretedValue.

(string)

shape -> (string)

Если значение shape равно List, это указывает на то, что поле values содержит список значений слотов. Если значение равно Scalar, это указывает на то, что поле value содержит одно значение.

values -> (list)

Список одного или нескольких значений, которые пользователь предоставил для слота. Например, если слот запрашивает начинки для пиццы, значения могут быть «пепперони» и «ананас».

(… рекурсивно…)

state -> (string)

Указывает состояние выполнения намерения. Значения каждого значения следующие:

  • Failed — Бот не смог выполнить намерение.
  • Fulfilled — Бот завершил выполнение намерения.
  • FulfillmentInProgress — Бот находится в процессе выполнения намерения.
  • InProgress — Бот находится в процессе извлечения значений слотов, необходимых для выполнения намерения.
  • ReadyForFulfillment — Бот извлёк все значения слотов для намерения и готов выполнить намерение.
  • Waiting — Бот ожидает ответа от пользователя (ограничено для потоковых разговоров).

confirmationState -> (string)

Указывает, было ли намерение Confirmed, Denied или None, если этап подтверждения еще не достигнут.

interpretationSource -> (string)

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

requestAttributes -> (map)

Атрибуты, отправленные в запросе.

key -> (string)

value -> (string)

sessionId -> (string)

Идентификатор используемой сессии.

recognizedBotMember -> (structure)

Член бота, который распознал текст.

botId -> (string)

Идентификатор члена бота, который обрабатывает запрос.

botName -> (string)

Имя члена бота, который обрабатывает запрос.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API