[ aws . lexv2-runtime ]
put-session
Описание
Создаёт новую сессию или изменяет существующую сессию с ботом Amazon Lex V2. Используйте эту операцию, чтобы позволить вашему приложению установить состояние бота.
См. также: Документация AWS API
Синтаксис
put-session
--bot-id <value>
--bot-alias-id <value>
--locale-id <value>
--session-id <value>
[--messages <value>]
--session-state <value>
[--request-attributes <value>]
[--response-content-type <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 (строка)
--messages (список)
Список сообщений для отправки пользователю. Сообщения отправляются в порядке их определения в списке.
(структура)
Контейнер для текста, возвращаемого пользователю.
content -> (строка)
contentType -> (строка)
imageResponseCard -> (структура)
Карта, отображаемая пользователю платформой обмена сообщениями. Вы определяете содержимое карты, платформа её отображает.
При использовании карты ответа, ответ пользователя ограничен текстом, связанным с кнопкой на карте.
title -> (строка)
subtitle -> (строка)
imageUrl -> (строка)
buttons -> (список)
Список кнопок, которые должны быть отображены на карте ответа. Расположение кнопок определяется платформой, отображающей кнопки.
(структура)
Кнопка, отображаемая на карте ответа пользователю.
text -> (строка)
value -> (строка)
Синтаксис JSON:
[
{
"content": "string",
"contentType": "CustomPayload"|"ImageResponseCard"|"PlainText"|"SSML",
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
}
...
]
--session-state (структура)
Устанавливает состояние сессии с пользователем. Вы можете использовать это для установки текущего намерения, атрибутов, контекста и действия диалога. Используйте действие диалога, чтобы определить следующий шаг, который Amazon Lex V2 должен использовать в разговоре с пользователем.
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 -> (строка)
interpretedValue -> (строка)
resolvedValues списке.resolvedValues -> (список)
Список значений, которые Amazon Lex V2 определяет как возможные решения для входных данных пользователя. Первое значение соответствует interpretedValue .
(строка)
shape -> (строка)
shape равно List, это указывает, что поле values содержит список значений слотов. Когда значение равно Scalar, это указывает, что поле value содержит одно значение.values -> (список)
Список одного или нескольких значений, которые пользователь предоставил для слота. Например, если слот запрашивает добавки к пицце, значениями могут быть «пепперони» и «ананас».
(структура)
Значение, которое Amazon Lex V2 использует для выполнения намерения.
value -> (структура)
Текущее значение слота.
originalValue -> (строка)
interpretedValue -> (строка)
resolvedValues списке.resolvedValues -> (список)
Список значений, которые Amazon Lex V2 определяет как возможные решения для входных данных пользователя. Первое значение соответствует interpretedValue .
(строка)
shape -> (строка)
shape равно List, это указывает, что поле values содержит список значений слотов. Когда значение равно Scalar, это указывает, что поле value содержит одно значение.values -> (список)
Список одного или нескольких значений, которые пользователь предоставил для слота. Например, если слот запрашивает добавки к пицце, значениями могут быть «пепперони» и «ананас».
( … рекурсивно … )
subSlots -> (карта)
Составные подслоты составного слота.
key -> (строка)
( … рекурсивно … )
subSlots -> (карта)
Составные подслоты составного слота.
key -> (строка)
value -> (структура)
Значение, которое Amazon Lex V2 использует для выполнения намерения.
value -> (структура)
Текущее значение слота.
originalValue -> (строка)
interpretedValue -> (строка)
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 -> (целое число)
turnsToLive -> (целое число)
contextAttributes -> (карта)
Список контекстов, активных для запроса. Контекст может быть активирован при выполнении предыдущего намерения или путем включения контекста в запрос.
Если вы не указываете список контекстов, Amazon Lex V2 будет использовать текущий список контекстов для сессии. Если вы укажете пустой список, все контексты сессии будут очищены.
key -> (строка)
value -> (строка)
sessionAttributes -> (карта)
Карта пар ключ/значение, представляющих контекстную информацию, специфичную для сессии. Она содержит информацию о приложении, передаваемую между Amazon Lex V2 и приложением-клиентом.
key -> (строка)
value -> (строка)
originatingRequestId -> (строка)
runtimeHints -> (структура)
Подсказки для фраз, которые клиент, вероятно, использует для слота. Amazon Lex V2 использует подсказки, чтобы определить правильное значение слота.
slotHints -> (карта)
Список слотов в интенте, для которых должны быть добавлены подсказки во время выполнения, и фразы, которые должны быть добавлены для каждого слота.
Первый уровень карты slotHints — имя интента. Второй уровень — имя слота внутри интента. Дополнительную информацию см. в разделе Использование подсказок для повышения точности.
Имя интента и имя слота должны существовать.
ключ -> (строка)
значение -> (карта)
ключ -> (строка)
значение -> (структура)
Предоставляет массив фраз, которым следует отдавать предпочтение при разрешении значений для слота.
runtimeHintValues -> (список)
Одна или несколько строк, которые Amazon Lex V2 должен искать во вводе бота. Каждая фраза получает преимущество при определении значений слотов.
(структура)
Предоставляет фразу, которую Amazon Lex V2 должен искать во вводе пользователя боту.
фраза -> (строка)
subSlotHints -> (карта)
Карта имен составляющих подслотов внутри составного слота в интенте и фраз, которые должны быть добавлены для каждого подслота. Внутри подсказок каждого составного слота эта структура предоставляет механизм добавления подробных фраз подслотов. Для составных слотов поддерживаются только подсказки подслотов. Имя интента, имя составного слота и имена составляющих подслотов должны существовать.
ключ -> (строка)
значение -> (структура)
Предоставляет массив фраз, которым следует отдавать предпочтение при разрешении значений для слота.
runtimeHintValues -> (список)
Одна или несколько строк, которые Amazon Lex V2 должен искать во вводе бота. Каждая фраза получает преимущество при определении значений слотов.
(структура)
Предоставляет фразу, которую 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 (карта)
Информация, специфичная для запроса, передаваемая между Amazon Lex V2 и приложением-клиентом.
Пространство имен x-amz-lex: зарезервировано для специальных атрибутов. Не создавайте атрибуты запроса с префиксом x-amz-lex:.
ключ -> (строка)
значение -> (строка)
Сокращенный синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--response-content-type (строка)
Сообщение, которое Amazon Lex V2 возвращает в ответе, может быть текстом или речью в зависимости от значения этого параметра.
- Если значение равно
text/plain; charset=utf-8, Amazon Lex V2 возвращает текст в ответе.
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.
Вывод
contentType -> (строка)
responseContentType в запросе.messages -> (строка)
sessionState -> (строка)
requestAttributes -> (строка)
requestAttribute в вызове операции PutSession.sessionId -> (строка)
audioStream -> (потоковый блок)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
