Spec-Zone.ru › AWS CLI v2

[ aws . lex-runtime ]

получить-сессию

Описание

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

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

Синтаксис

  get-session
--bot-name <value>
--bot-alias <value>
--user-id <value>
[--checkpoint-label-filter <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-name (строка)

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

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

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

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

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

--checkpoint-label-filter (строка)

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

При указании фильтра возвращаются только интенты, у которых поле checkpointLabel установлено в эту строку.

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

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

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

--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.

Вывод

recentIntentSummaryView -> (список)

Массив информации об интентах, используемых в сеансе. Массив может содержать максимум три сводки. Если в сеансе используется более трёх интентов, операция recentIntentSummaryView содержит информацию о последних трёх использованных интентах.

Если вы зададите параметр checkpointLabelFilter в запросе, массив будет содержать только интенты с указанной меткой.

(структура)

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

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 -> (строка)

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

sessionAttributes -> (отображение)

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

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

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

sessionId -> (строка)

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

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

Описание текущего состояния бота.

type -> (строка)

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

  • 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-объект, содержащий одно или несколько сообщений. Дополнительную информацию см. в разделе Группы сообщений.

activeContexts -> (список)

Список активных контекстов для сеанса. Контекст может быть установлен при выполнении интента или вызовом операций PostContent, PostText или PutSession.

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

(структура)

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

name -> (строка)

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

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

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

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

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

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

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

parameters -> (отображение)

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

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

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

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

Spec-Zone.ru

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