recognize-utterance

Описание

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

Следующие поля запроса необходимо сжать с помощью gzip и затем закодировать в base64 перед отправкой в Amazon Lex V2.

requestAttributes
sessionState

Следующие поля ответа сжимаются с помощью gzip и затем кодируются в base64 Amazon Lex V2. Перед использованием этих полей необходимо их декодировать и распаковать.

inputTranscript
interpretations
messages
requestAttributes
sessionState

Пример содержит приложение Java, которое сжимает и кодирует объект Java для отправки в Amazon Lex V2, и второе, которое декодирует и распаковывает ответ из Amazon Lex V2.

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

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

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

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

Синтаксис

  recognize-utterance
--bot-id <value>
--bot-alias-id <value>
--locale-id <value>
--session-id <value>
[--session-state <value>]
[--request-attributes <value>]
--request-content-type <value>
[--response-content-type <value>]
[--input-stream <value>]
<outfile>
[--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 (строка)

Идентификатор сессии.

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

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

Поле sessionState необходимо сжать с помощью gzip и затем закодировать в base64 перед отправкой в Amazon Lex V2.

--request-attributes (строка)

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

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

Поле requestAttributes необходимо сжать с помощью gzip и затем закодировать в base64 перед отправкой в Amazon Lex V2.

--request-content-type (строка)

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

Формат PCM, данные аудио должны быть в little-endian порядке байтов.
- audio/l16; rate=16000; channels=1
- audio/x-l16; sample-rate=16000; channel-count=1
- audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
Формат Opus
- audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4
Формат текста
- text/plain; charset=utf-8

--response-content-type (строка)

Сообщение, которое Amazon Lex V2 возвращает в ответе, может быть текстом или речью в зависимости от значения responseContentType.

Если значение равно text/plain;charset=utf-8, Amazon Lex V2 возвращает текст в ответе.
Если значение начинается с audio/, Amazon Lex V2 возвращает речь в ответе. Amazon Lex V2 использует Amazon Polly для генерации речи, используя конфигурацию, которую вы указали в параметре responseContentType. Например, если вы укажете audio/mpeg, Amazon Lex V2 вернет речь в формате MPEG.
Если значение равно audio/pcm, возвращаемая речь находится в формате audio/pcm со скоростью 16 КГц в 16-битном формате little-endian.
Допустимые значения:
- audio/mpeg
- audio/ogg
- audio/pcm (16 КГц)
- audio/* (по умолчанию mpeg)
- text/plain; charset=utf-8

--input-stream (потоковый блок)

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

Примечание

Этот аргумент имеет тип: потоковый блок. Его значение должно быть путем к файлу (например, path/to/file) и не должно начинаться с file:// или fileb://.

outfile (строка) Имя файла, где содержимое будет сохранено

Глобальные параметры

--debug (логическое)

Включить отладку.

--endpoint-url (строка)

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

--no-verify-ssl (логическое)

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

--no-paginate (логическое)

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

--output (строка)

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

json
текст
таблица
yaml
yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

вкл
выкл
авто

--no-sign-request (логическое)

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

--ca-bundle (строка)

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

--cli-read-timeout (целое число)

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

--cli-connect-timeout (целое число)

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

--cli-binary-format (строка)

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

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

--cli-auto-prompt (логическое)

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

--no-cli-auto-prompt (логическое)

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

Вывод

inputMode -> (строка)

Указывает, был ли ввод в операцию текстовым, речевым или с помощью тонального набора.

contentType -> (строка)

Тип контента, указанный в responseContentType в запросе.

messages -> (строка)

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

Поле messages сжато с помощью gzip и затем закодировано в base64. Перед использованием содержимого поля необходимо его декодировать и распаковать. См. пример для простой функции декодирования и распаковки содержимого.

interpretations -> (строка)

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

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

Поле interpretations сжато с помощью gzip и затем закодировано в base64. Перед использованием содержимого поля необходимо его декодировать и распаковать. См. пример для простой функции декодирования и распаковки содержимого.

sessionState -> (строка)

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

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

Поле sessionState сжато с помощью gzip и затем закодировано в base64. Перед использованием содержимого поля необходимо его декодировать и распаковать. См. пример для простой функции декодирования и распаковки содержимого.

requestAttributes -> (строка)

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

Поле requestAttributes сжато с помощью gzip и затем закодировано в base64. Перед использованием содержимого поля необходимо его декодировать и распаковать.

sessionId -> (строка)

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

inputTranscript -> (строка)

Текст, используемый для обработки запроса.

Если вход был потоком аудио, поле inputTranscript содержит текст, извлеченный из аудиопотока. Это текст, который фактически обрабатывается для распознавания намерений и значений слотов. Вы можете использовать эту информацию, чтобы определить, правильно ли Amazon Lex V2 обрабатывает отправленный вами аудио.

Поле inputTranscript сжато с помощью gzip и затем закодировано в base64. Перед использованием содержимого поля необходимо его декодировать и распаковать. См. пример для простой функции декодирования и распаковки содержимого.

audioStream -> (потоковый блок)

Запрос или утверждение, отправляемое пользователю. Это основано на конфигурации бота и контексте. Например, если Amazon Lex V2 не понял намерение пользователя, он отправляет clarificationPrompt, настроенный для бота. Если для намерения требуется подтверждение перед выполнением действия, отправляется confirmationPrompt. Другой пример: Предположим, что функция Lambda успешно выполнила намерение и отправила сообщение пользователю. Затем Amazon Lex V2 отправляет это сообщение в ответе.

recognizedBotMember -> (строка)

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