Spec-Zone.ru › AWS CLI v2

[ aws . lexv2-runtime ]

get-session

Описание

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

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

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

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

Синтаксис

  get-session
--bot-id <value>
--bot-alias-id <value>
--locale-id <value>
--session-id <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 (строка)

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

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

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

Вывод

sessionId -> (строка)

Идентификатор возвращённой сессии.

messages -> (список)

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

(структура)

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

content -> (строка)

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

contentType -> (строка)

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

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

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

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

title -> (строка)

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

subtitle -> (строка)

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

imageUrl -> (строка)

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

buttons -> (список)

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

(структура)

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

text -> (строка)

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

value -> (строка)

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

interpretations -> (список)

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

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

(структура)

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

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

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

score -> (вещественное число)

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

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

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

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

sentiment -> (строка)

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

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

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

positive -> (вещественное число)

Уровень уверенности Amazon Comprehend в точности определения настроения POSITIVE.

negative -> (вещественное число)

Уровень уверенности Amazon Comprehend в точности определения настроения NEGATIVE.

neutral -> (вещественное число)

Уровень уверенности Amazon Comprehend в точности определения настроения NEUTRAL.

mixed -> (вещественное число)

Уровень уверенности Amazon Comprehend в точности определения настроения MIXED.

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

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

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 , если этап подтверждения еще не достигнут.

interpretationSource -> (строка)

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

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

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

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

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 должен искать во входных данных пользователя боту.

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

Spec-Zone.ru

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