Spec-Zone.ru › AWS CLI v2

[ aws . lex-models ]

get-bot

Описание

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

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

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

Синтаксис

  get-bot
--name <value>
--version-or-alias <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 (строка)

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

--version-or-alias (строка)

Версия или псевдоним бота.

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

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

intents -> (список)

Массив объектов intent. Для получения дополнительной информации, см. PutBot.

(структура)

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

intentName -> (строка)

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

intentVersion -> (строка)

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

enableModelImprovements -> (булево)

Указывает, использует ли бот улучшения точности. true указывает, что бот использует улучшения, в противном случае, false.

nluIntentConfidenceThreshold -> (двойное)

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

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

Сообщение, которое Amazon Lex использует, когда не понимает запрос пользователя. Для получения дополнительной информации, см. PutBot.

messages -> (список)

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

(структура)

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

contentType -> (строка)

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

content -> (строка)

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

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

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

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

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

responseCard -> (строка)

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

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

Сообщение, которое Amazon Lex возвращает, когда пользователь выбирает завершить разговор без его завершения. Для получения дополнительной информации, см. PutBot.

messages -> (список)

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

(структура)

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

contentType -> (строка)

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

content -> (строка)

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

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

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

responseCard -> (строка)

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

status -> (строка)

Статус бота.

Когда статус BUILDING, Amazon Lex создает бота для тестирования и использования.

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

Если при построении бота возникла проблема, статус FAILED, и поле failureReason объясняет, почему бот не был построен.

Если бот был сохранён, но не построен, статус NOT_BUILT.

failureReason -> (строка)

Если status равно FAILED, Amazon Lex объясняет, почему не удалось создать бота.

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

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

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

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

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

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

voiceId -> (строка)

Идентификатор голоса Amazon Polly, который Amazon Lex использует для голосового взаимодействия с пользователем. Для получения дополнительной информации, см. PutBot.

checksum -> (строка)

Контрольная сумма бота, используемая для идентификации определенной ревизии версии $LATEST бота.

version -> (строка)

Версия бота. Для нового бота версия всегда $LATEST.

locale -> (строка)

Целевой язык бота.

childDirected -> (булево)

Для каждого созданного бота Amazon Lex с помощью Amazon Lex Model Building Service необходимо указать, относится ли ваше использование Amazon Lex к веб-сайту, программе или другому приложению, направленному или ориентированному, полностью или частично, на детей младше 13 лет, подпадающему под действие Закона о защите частной жизни детей в Интернете (COPPA), указав true или false в поле childDirected. Указав true в поле childDirected, вы подтверждаете, что ваше использование Amazon Lex относится к веб-сайту, программе или другому приложению, направленному или ориентированному, полностью или частично, на детей младше 13 лет и подпадающему под действие COPPA. Указав false в поле childDirected, вы подтверждаете, что ваше использование Amazon Lex не относится к веб-сайту, программе или другому приложению, направленному или ориентированному, полностью или частично, на детей младше 13 лет и подпадающему под действие COPPA. Вы не можете указать значение по умолчанию для поля childDirected, которое не точно отражает, связано ли ваше использование Amazon Lex с веб-сайтом, программой или другим приложением, направленным или ориентированным, полностью или частично, на детей младше 13 лет и подпадающим под действие COPPA.

Если ваше использование Amazon Lex относится к веб-сайту, программе или другому приложению, направленному или ориентированному, полностью или частично, на детей младше 13 лет, вы должны получить необходимое подтвержденное родительское согласие в соответствии с COPPA. Сведения об использовании Amazon Lex в связи с веб-сайтами, программами или другими приложениями, направленными или ориентированными, полностью или частично, на детей младше 13 лет, см. в FAQ Amazon Lex.

detectSentiment -> (булево)

Указывает, должны ли пользовательские высказывания отправляться в Amazon Comprehend для анализа настроения.

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

Spec-Zone.ru

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