Spec-Zone.ru › AWS CLI v2

[ aws . lexv2-модели ]

рекомендация-ботов-запуска

Описание

Используйте этот метод, чтобы предоставить данные транскрипта и запустить процесс рекомендации ботов.

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

Синтаксис

  start-bot-recommendation
--bot-id <value>
--bot-version <value>
--locale-id <value>
--transcript-source-setting <value>
[--encryption-setting <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 (строка)

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

--transcript-source-setting (структура)

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

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

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

s3BucketName -> (строка)

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

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

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

objectPrefixes -> (список)

Список префиксов Amazon S3, указывающих на подпапки в Amazon S3-ведре. Укажите этот список, если вы хотите, чтобы Amazon 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-ведpa. Используйте это поле только в том случае, если ваше ведро зашифровано с помощью управляемого клиентом ключа KMS.

Синтаксис JSON:

{
  "s3BucketTranscriptSource": {
    "s3BucketName": "string",
    "pathFormat": {
      "objectPrefixes": ["string", ...]
    },
    "transcriptFormat": "Lex",
    "transcriptFilter": {
      "lexTranscriptFilter": {
        "dateRangeFilter": {
          "startDateTime": timestamp,
          "endDateTime": timestamp
        }
      }
    },
    "kmsKeyArn": "string"
  }
}

--encryption-setting (структура)

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

kmsKeyArn -> (строка)

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

botLocaleExportPassword -> (строка)

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

associatedTranscriptsPassword -> (строка)

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

Краткая запись:

kmsKeyArn=string,botLocaleExportPassword=string,associatedTranscriptsPassword=string

Синтаксис JSON:

{
  "kmsKeyArn": "string",
  "botLocaleExportPassword": "string",
  "associatedTranscriptsPassword": "string"
}

--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-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическую запрос параметров ввода CLI.

Вывод

botId -> (строка)

Уникальный идентификатор бота, содержащий рекомендацию по боту.

botVersion -> (строка)

Версия бота, содержащего рекомендацию по боту.

localeId -> (строка)

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

botRecommendationStatus -> (строка)

Статус рекомендации по боту.

Если статус Failed, причины отказа указаны в поле failureReasons.

botRecommendationId -> (строка)

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

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

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

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

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

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

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

s3BucketName -> (строка)

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

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

Объект, содержащий формат пути, который будет применяться при чтении Amazon Lex файла стенограммы в указанном ведре. Укажите этот объект, если вы хотите, чтобы 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 -> (строка)

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

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

Spec-Zone.ru

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