Spec-Zone.ru › AWS CLI v2

[ aws . lexv2-models ]

describe-bot-recommendation

Описание

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

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

Синопсис

  describe-bot-recommendation
--bot-id <value>
--bot-version <value>
--locale-id <value>
--bot-recommendation-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-version (строка)

Версия бота, связанного с рекомендацией бота.

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

Идентификатор языка и региональной настройки рекомендации бота для описания. Строка должна соответствовать одному из поддерживаемых регионов. Дополнительная информация находится в разделе Поддерживаемые языки.

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

Вывод

botId -> (строка)

Идентификатор бота, связанного с рекомендацией бота.

botVersion -> (строка)

Версия бота, связанного с рекомендацией бота.

localeId -> (строка)

Идентификатор языка и региональной настройки рекомендации бота для описания.

botRecommendationStatus -> (строка)

Состояние рекомендации бота. Если состояние Failed, причины сбоя перечислены в поле failureReasons.

botRecommendationId -> (строка)

Идентификатор описываемой рекомендации бота.

failureReasons -> (список)

Если botRecommendationStatus равен Failed, Amazon Lex объясняет причину.

(строка)

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

Дата и время создания рекомендации бота.

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

Дата и время последнего обновления рекомендации бота.

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

Объект, представляющий Amazon S3-ведро, содержащее транскрипт, а также связанные метаданные.

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

Указывает настройки Amazon S3-ведра, где хранится транскрипт.

s3BucketName -> (строка)

Имя ведра, содержащего транскрипт и связанные метаданные.

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

Объект, содержащий формат пути, который будет применен при чтении Amazon Lex файла транскрипта в указанном вами ведре Amazon S3. Укажите этот объект, если вы хотите, чтобы Lex считывал только подмножество файлов в вашем Amazon S3-ведре.

objectPrefixes -> (список)

Список префиксов Amazon S3, которые указывают на подпапки в Amazon S3-ведре. Укажите этот список, если вы хотите, чтобы Lex считывал только файлы в этих подпапках.

(строка)

transcriptFormat -> (строка)

Формат содержимого транскрипта. В настоящее время Genie поддерживает только формат транскрипта Amazon Lex.

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

Объект, содержащий фильтр, который будет применен при чтении Amazon Lex через Amazon S3-ведро. Укажите этот объект, если вы хотите, чтобы Amazon Lex считывал только подмножество Amazon S3-ведра на основе предоставленного вами фильтра.

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

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

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

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

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

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

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

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

kmsKeyArn -> (строка)

ARN ключа KMS, который клиент использует для шифрования своего Amazon S3-ведра. Используйте это поле только в том случае, если ваше ведро зашифровано с помощью управляемого клиентом ключа KMS.

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

Объект, представляющий пароли, которые использовались для шифрования данных, связанных с результатами рекомендации бота, а также ARN ключа KMS, используемого для шифрования связанных метаданных.

kmsKeyArn -> (строка)

ARN ключа KMS, используемого для шифрования метаданных, связанных с рекомендацией бота.

botLocaleExportPassword -> (строка)

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

associatedTranscriptsPassword -> (строка)

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

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

Объект, представляющий URL определения бота, URL связанного транскрипта и статистический свод результатов рекомендации бота.

botLocaleExportUrl -> (строка)

Предзаписанная ссылка URL рекомендуемого определения бота.

associatedTranscriptsUrl -> (строка)

Предзаписанная ссылка URL связанного транскрипта.

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

Статистический свод результатов рекомендации бота.

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

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

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

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

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

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

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

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

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

Spec-Zone.ru

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