Spec-Zone.ru › AWS CLI v2

[ aws . lex-models ]

get-intent

Описание

Возвращает информацию об интенте. Помимо имени интента, необходимо указать версию интента.

Для выполнения этой операции требуются разрешения на выполнение действия lex:GetIntent.

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

Синтаксис

  get-intent
--name <value>
--intent-version <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]

Параметры

--name (строка)

Имя интента. Имя чувствительно к регистру.

--intent-version (строка)

Версия интента.

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

Вывод

name -> (строка)

Имя интента.

description -> (строка)

Описание интента.

slots -> (список)

Массив слотов интента, настроенных для него.

(структура)

Идентифицирует версию конкретного слота.

name -> (строка)

Имя слота.

description -> (строка)

Описание слота.

slotConstraint -> (строка)

Указывает, является ли слот обязательным или необязательным.

slotType -> (строка)

Тип слота, либо настраиваемый тип слота, который вы определили, либо один из встроенных типов слотов.

slotTypeVersion -> (строка)

Версия типа слота.

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

Подсказка, которую Amazon Lex использует для получения значения слота от пользователя.

messages -> (список)

Массив объектов, каждый из которых предоставляет строку сообщения и её тип. Вы можете указать строку сообщения в виде простого текста или в формате Speech Synthesis Markup Language (SSML).

(структура)

Объект сообщения, который предоставляет текст сообщения и его тип.

contentType -> (строка)

Тип содержимого строки сообщения.

content -> (строка)

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

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

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

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

Количество попыток запроса информации у пользователя.

responseCard -> (строка)

Карта ответа. Amazon Lex использует эту подсказку во время выполнения, в ответе API PostText. Она подставляет атрибуты сеанса и значения слотов в качестве заполнитель в карте ответа. Для получения дополнительной информации см. ex-resp-card.

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

Указывает Amazon Lex порядок извлечения значения слота от пользователя. Например, если интент имеет два слота с приоритетами 1 и 2, AWS Amazon Lex сначала извлекает значение для слота с приоритетом 1.

Если несколько слотов имеют одинаковый приоритет, порядок, в котором Amazon Lex извлекает значения, является произвольным.

sampleUtterances -> (список)

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

(строка)

responseCard -> (строка)

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

obfuscationSetting -> (строка)

Определяет, замаскирован ли слот в журналах разговоров и сохранённых высказываниях. Когда вы замаскируете слот, значение заменяется именем слота в фигурных скобках ({}). Например, если имя слота «full_name», замаскированные значения заменяются на «{full_name}». Для получения дополнительной информации см. Замаскирование слотов.

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

Список значений по умолчанию для слота. Значения по умолчанию используются, когда Amazon Lex не определил значение для слота. Вы можете указать значения по умолчанию из переменных контекста, атрибутов сеанса и определённых значений.

defaultValueList -> (список)

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

Выбранное значение по умолчанию выбирается на основе порядка, в котором вы их указываете в списке. Например, если вы указываете переменную контекста и фиксированное значение в этом порядке, Amazon Lex использует переменную контекста, если она доступна, в противном случае использует фиксированное значение.

(структура)

Значение по умолчанию для слота.

defaultValue -> (строка)

Значение по умолчанию для слота. Вы можете указать одно из следующих:

  • #context-name.slot-name - Значение слота «slot-name» в контексте «context-name».
  • {attribute} - Значение слота атрибута сеанса «attribute».
  • 'value' - Дискретное значение «value».

sampleUtterances -> (список)

Массив образцов высказываний, настроенных для интента.

(строка)

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

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

messages -> (список)

Массив объектов, каждый из которых предоставляет строку сообщения и её тип. Вы можете указать строку сообщения в виде простого текста или в формате Speech Synthesis Markup Language (SSML).

(структура)

Объект сообщения, который предоставляет текст сообщения и его тип.

contentType -> (строка)

Тип содержимого строки сообщения.

content -> (строка)

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

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

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

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

Количество попыток запроса информации у пользователя.

responseCard -> (строка)

Карта ответа. Amazon Lex использует эту подсказку во время выполнения, в ответе API PostText. Она подставляет атрибуты сеанса и значения слотов в качестве заполнитель в карте ответа. Для получения дополнительной информации см. ex-resp-card.

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

Если пользователь отвечает «нет» на вопрос, определённый в confirmationPrompt, Amazon Lex отвечает этой фразой, чтобы подтвердить отмену интента.

messages -> (список)

Коллекция объектов сообщений.

(структура)

Объект сообщения, который предоставляет текст сообщения и его тип.

contentType -> (строка)

Тип содержимого строки сообщения.

content -> (строка)

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

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

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

responseCard -> (строка)

При выполнении, если клиент использует API PostText, Amazon Lex включает карту ответа в ответ. Она подставляет все атрибуты сеанса и значения слотов в качестве заполнитель в карте ответа.

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

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

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

Подсказки для получения информации от пользователя.

messages -> (список)

Массив объектов, каждый из которых предоставляет строку сообщения и её тип. Вы можете указать строку сообщения в виде простого текста или в формате Speech Synthesis Markup Language (SSML).

(структура)

Объект сообщения, который предоставляет текст сообщения и его тип.

contentType -> (строка)

Тип содержимого строки сообщения.

content -> (строка)

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

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

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

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

Количество попыток запроса информации у пользователя.

responseCard -> (строка)

Карта ответа. Amazon Lex использует эту подсказку во время выполнения, в ответе API PostText. Она подставляет атрибуты сеанса и значения слотов в качестве заполнитель в карте ответа. Для получения дополнительной информации см. ex-resp-card.

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

Если пользователь отвечает «нет» на вопрос, определённый в поле prompt, Amazon Lex отвечает этой фразой, чтобы подтвердить отмену интента.

messages -> (список)

Коллекция объектов сообщений.

(структура)

Объект сообщения, который предоставляет текст сообщения и его тип.

contentType -> (строка)

Тип содержимого строки сообщения.

content -> (строка)

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

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

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

responseCard -> (строка)

При выполнении, если клиент использует API PostText, Amazon Lex включает карту ответа в ответ. Она подставляет все атрибуты сеанса и значения слотов в качестве заполнитель в карте ответа.

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

После выполнения интента Lambda-функцией, указанной в элементе fulfillmentActivity, Amazon Lex передаёт это сообщение пользователю.

messages -> (список)

Коллекция объектов сообщений.

(структура)

Объект сообщения, который предоставляет текст сообщения и его тип.

contentType -> (строка)

Тип содержимого строки сообщения.

content -> (строка)

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

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

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

responseCard -> (строка)

При выполнении, если клиент использует API PostText, Amazon Lex включает карту ответа в ответ. Она подставляет все атрибуты сеанса и значения слотов в качестве заполнитель в карте ответа.

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

Если определено в боте, Amazon Lex вызывает эту Lambda-функцию для каждого ввода пользователя. Для получения дополнительной информации см. PutIntent.

uri -> (строка)

Идентификатор ресурса Amazon (ARN) Lambda-функции.

messageVersion -> (строка)

Версия запроса-ответа, которую вы хотите, чтобы Amazon Lex использовал для вызова вашей Lambda-функции. Для получения дополнительной информации см. using-lambda.

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

Описание того, как выполняется интент. Для получения дополнительной информации см. PutIntent.

type -> (строка)

Способ выполнения интента, либо запуск Lambda-функции, либо возврат данных слота в приложение-клиент.

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

Описание Lambda-функции, которая выполняется для выполнения интента.

uri -> (строка)

Идентификатор ресурса Amazon (ARN) Lambda-функции.

messageVersion -> (строка)

Версия запроса-ответа, которую вы хотите, чтобы Amazon Lex использовал для вызова вашей Lambda-функции. Для получения дополнительной информации см. using-lambda.

parentIntentSignature -> (строка)

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

lastUpdatedDate -> (временная метка)

Дата обновления интента. При создании ресурса дата создания и последнего обновления совпадают.

createdDate -> (временная метка)

Дата создания интента.

version -> (строка)

Версия интента.

checksum -> (строка)

Контрольная сумма интента.

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

Информация о конфигурации, если необходимо, для подключения к индексу Amazon Kendra с интентом AMAZON.KendraSearchIntent.

kendraIndex -> (строка)

Идентификатор ресурса Amazon (ARN) индекса Amazon Kendra, который вы хотите использовать для поиска интентом AMAZON.KendraSearchIntent. Индекс должен находиться в той же учетной записи и регионе, что и бот Amazon Lex. Если индекс Amazon Kendra не существует, при вызове операции PutIntent возникает исключение.

queryFilterString -> (строка)

Фильтр запроса, который Amazon Lex отправляет в Amazon Kendra для фильтрации ответа от запроса. Фильтр имеет формат, определенный Amazon Kendra. Дополнительную информацию см. в разделе Фильтрация запросов.

Вы можете переопределить эту строку фильтра в режиме реального времени.

role -> (строка)

Идентификатор ресурса Amazon (ARN) роли IAM, имеющей разрешения на поиск в индексе Amazon Kendra. Роль должна находиться в той же учетной записи и регионе, что и бот Amazon Lex. Если роль не существует, при вызове операции PutIntent возникает исключение.

inputContexts -> (список)

Массив объектов InputContext, который перечисляет контексты, которые должны быть активны для того, чтобы Amazon Lex выбрал интент в разговоре с пользователем.

(структура)

Имя контекста, который должен быть активен для того, чтобы Amazon Lex выбрал интент.

name -> (строка)

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

outputContexts -> (список)

Массив объектов OutputContext, который перечисляет контексты, которые интент активирует при выполнении интента.

(структура)

Описание выходного контекста, который устанавливается при выполнении интента.

name -> (строка)

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

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

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

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

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

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

Spec-Zone.ru

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