put-session

Описание

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

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

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

Синтаксис

  put-session
--bot-name <value>
--bot-alias <value>
--user-id <value>
[--session-attributes <value>]
[--dialog-action <value>]
[--recent-intent-summary-view <value>]
[--accept <value>]
[--active-contexts <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-name (строка)

Имя бота, содержащего данные сессии.

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

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

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

Идентификатор пользователя клиентского приложения. Amazon Lex использует его для идентификации разговора пользователя с вашим ботом.

--session-attributes (массив)

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

ключ -> (строка)

значение -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--dialog-action (структура)

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

тип -> (строка)

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

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

intentName -> (строка)

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

slots -> (массив)

Массив собранных слотов и их значений.

ключ -> (строка)

значение -> (строка)

slotToElicit -> (строка)

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

fulfillmentState -> (строка)

Состояние выполнения намерения. Возможные значения:

Failed - Функция Lambda, связанная с намерением, не смогла выполнить намерение.
Fulfilled - Намерение выполнено связанной функцией Lambda.
ReadyForFulfillment - Вся необходимая информация для намерения присутствует, и намерение готово к выполнению клиентским приложением.

message -> (строка)

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

messageFormat -> (строка)

PlainText - Сообщение содержит обычный текст UTF-8.
CustomPayload - Сообщение имеет пользовательский формат для клиента.
SSML - Сообщение содержит текст, отформатированный для голосового вывода.
Composite - Сообщение содержит закодированный JSON-объект, содержащий одно или несколько сообщений. Для получения дополнительной информации см. Группы сообщений.

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

type=string,intentName=string,slots={KeyName1=string,KeyName2=string},slotToElicit=string,fulfillmentState=string,message=string,messageFormat=string

Синтаксис JSON:

{
  "type": "ElicitIntent"|"ConfirmIntent"|"ElicitSlot"|"Close"|"Delegate",
  "intentName": "string",
  "slots": {"string": "string"
    ...},
  "slotToElicit": "string",
  "fulfillmentState": "Fulfilled"|"Failed"|"ReadyForFulfillment",
  "message": "string",
  "messageFormat": "PlainText"|"CustomPayload"|"SSML"|"Composite"
}

--recent-intent-summary-view (список)

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

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

intentName
имен слотов
slotToElict

Если вы отправите параметр recentIntentSummaryView в запросе PutSession, содержимое нового представления сводки заменит старое. Например, если запрос GetSession возвращает три намерения в представлении сводки, и вы вызываете PutSession с одним намерением в представлении сводки, следующий вызов GetSession вернёт только одно намерение.

(структура)

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

intentName -> (строка)

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

checkpointLabel -> (строка)

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

Используйте параметр checkpointLabelFilter операции GetSessionRequest для фильтрации возвращаемых намерений только по указанной метке.

slots -> (массив)

Массив собранных слотов и их значений.

ключ -> (строка)

значение -> (строка)

confirmationStatus -> (строка)

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

Confirmed - Пользователь ответил «Да» на подтверждающий запрос, подтверждая, что намерение выполнено и готово к выполнению.
Denied - Пользователь ответил «Нет» на подтверждающий запрос.
None - Пользователю никогда не предлагалось подтверждение; или пользователю предлагалось подтверждение, но он не подтвердил или не отклонил запрос.

dialogActionType -> (строка)

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

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

fulfillmentState -> (строка)

Состояние выполнения намерения. Возможные значения:

Failed - Функция Lambda, связанная с намерением, не смогла выполнить намерение.
Fulfilled - Намерение выполнено связанной функцией Lambda.
ReadyForFulfillment - Вся необходимая информация для намерения присутствует, и намерение готово к выполнению клиентским приложением.

slotToElicit -> (строка)

Следующий слот для получения от пользователя. Если слота для получения нет, поле пустое.

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

intentName=string,checkpointLabel=string,slots={KeyName1=string,KeyName2=string},confirmationStatus=string,dialogActionType=string,fulfillmentState=string,slotToElicit=string ...

Синтаксис JSON:

[
  {
    "intentName": "string",
    "checkpointLabel": "string",
    "slots": {"string": "string"
      ...},
    "confirmationStatus": "None"|"Confirmed"|"Denied",
    "dialogActionType": "ElicitIntent"|"ConfirmIntent"|"ElicitSlot"|"Close"|"Delegate",
    "fulfillmentState": "Fulfilled"|"Failed"|"ReadyForFulfillment",
    "slotToElicit": "string"
  }
  ...
]

--accept (строка)

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

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

--active-contexts (список)

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

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

(структура)

Контекст — это переменная, которая содержит информацию о текущем состоянии разговора между пользователем и Amazon Lex. Контекст может быть установлен автоматически Amazon Lex при выполнении намерения или может быть установлен во время выполнения с помощью операции PutContent, PutText или PutSession.

name -> (строка)

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

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

Продолжительность времени или количество ходов, в течение которых контекст остается активным.

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

Количество секунд, в течение которых контекст должен быть активным после первоначальной отправки в ответ PostContent или PostText. Вы можете установить значение от 5 до 86 400 секунд (24 часа).

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

Количество ходов разговора, в течение которых контекст должен быть активным. Один ход разговора - один запрос PostContent или PostText и соответствующий ответ от Amazon Lex.

parameters -> (массив)

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

ключ -> (строка)

значение -> (строка)

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

name=string,timeToLive={timeToLiveInSeconds=integer,turnsToLive=integer},parameters={KeyName1=string,KeyName2=string} ...

Синтаксис JSON:

[
  {
    "name": "string",
    "timeToLive": {
      "timeToLiveInSeconds": integer,
      "turnsToLive": integer
    },
    "parameters": {"string": "string"
      ...}
  }
  ...
]

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

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

--debug (boolean)

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

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

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (строка)

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

json
text
table
yaml
yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

on
off
auto

--no-sign-request (boolean)

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

--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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку fileb:// всегда будет обрабатываться как двоичное и будет использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

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

--cli-auto-prompt (boolean)

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

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

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

Вывод

contentType -> (строка)

Тип содержимого, как указано в заголовке HTTP Accept в запросе.

intentName -> (строка)

Имя текущего намерения.

slots -> (JSON)

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

Amazon Lex создаёт список разрешений, содержащий возможные значения для слота. Возвращаемое значение определяется выбранным значением valueSelectionStrategy при создании или обновлении типа слота. Если valueSelectionStrategy установлено в значение ORIGINAL_VALUE, то возвращается значение, предоставленное пользователем, если значение пользователя аналогично значениям слота. Если valueSelectionStrategy установлено в значение TOP_RESOLUTION, Amazon Lex возвращает первое значение в списке разрешений или, если список разрешений отсутствует, null. Если вы не указываете значение valueSelectionStrategy, по умолчанию используется значение ORIGINAL_VALUE.

sessionAttributes -> (JSON)

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

message -> (строка)

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

Вы можете использовать это поле только в локалиях de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR и it-IT. Во всех остальных локалиях поле message имеет значение null. Вы должны использовать поле encodedMessage вместо него.

encodedMessage -> (строка)

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

Поле encodedMessage закодировано в base-64. Вам необходимо декодировать поле перед использованием значения.

messageFormat -> (строка)

Формат сообщения ответа. Одно из следующих значений:

PlainText - Сообщение содержит обычный текст UTF-8.
CustomPayload - Сообщение имеет пользовательский формат для клиента.
SSML - Сообщение содержит текст, отформатированный для голосового вывода.
Composite - Сообщение содержит закодированный JSON-объект, содержащий одно или несколько сообщений из групп, которым сообщения были назначены при создании намерения.

dialogState -> (строка)

ConfirmIntent - Amazon Lex ожидает ответа «да» или «нет» для подтверждения намерения перед выполнением намерения.
ElicitIntent - Amazon Lex хочет получить намерение пользователя.
ElicitSlot - Amazon Lex ожидает значение слота для текущего намерения.
Failed - Указывает на то, что разговор с пользователем завершился неудачей. Это может произойти по разным причинам, включая то, что пользователь не предоставляет соответствующего ответа на запросы службы или если функция Lambda не выполняет намерение.
Fulfilled - Указывает на то, что функция Lambda успешно выполнила намерение.
ReadyForFulfillment - Указывает на то, что клиент должен выполнить намерение.

slotToElicit -> (строка)

Если значение dialogState равно значению ElicitSlot, возвращает имя слота, для которого Amazon Lex запрашивает значение.

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

Аудиоверсия сообщения для передачи пользователю.

sessionId -> (строка)

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

activeContexts -> (JSON)

Список активных контекстов для сеанса.