Spec-Zone.ru › AWS CLI v2

[ aws . voice-id ]

start-speaker-enrollment-job

Описание

Запускает новую партию задач по регистрации голоса с указанными деталями.

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

Синтаксис

  start-speaker-enrollment-job
[--client-token <value>]
--data-access-role-arn <value>
--domain-id <value>
[--enrollment-config <value>]
--input-data-config <value>
[--job-name <value>]
--output-data-config <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]

Параметры

--client-token (строка)

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете для обеспечения идемпотентности запроса. Если не указано, Amazon Web Services SDK заполняет это поле. Дополнительную информацию об идемпотентности см. в разделе Обеспечение безопасности повторных попыток с помощью идемпотентных API .

--data-access-role-arn (строка)

Идентификатор роли IAM (ARN), предоставляющий Voice ID разрешения на доступ к ведрам клиента для чтения входного файла манифеста и записи файла вывода задачи. Обратитесь к разделу Регистрация партий с использованием аудиоданных из предыдущих вызовов для получения необходимых разрешений в этой роли.

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

Идентификатор домена, содержащего задачу регистрации голоса, и в котором регистрируются голоса.

--enrollment-config (структура)

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

ExistingEnrollmentAction -> (строка)

Действие, которое следует предпринять, когда указанный говорящий уже зарегистрирован в указанном домене. Значение по умолчанию — SKIP, что пропускает регистрацию для существующего говорящего. Установка значения на OVERWRITE заменяет существующие отпечатки голоса и аудиозаписи регистрации для этого говорящего новыми данными, сгенерированными из последнего аудио.

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

Конфигурация обнаружения мошенничества для использования в задаче регистрации голоса.

FraudDetectionAction -> (строка)

Действие, которое следует предпринять, когда заданный говорящий был помечен системой обнаружения мошенничества. Значение по умолчанию — FAIL, что приводит к отказу в регистрации голоса. Изменение этого значения на IGNORE приводит к регистрации говорящего, даже если он помечен системой обнаружения мошенничества.

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

Пороговое значение для определения того, является ли говорящий высоким риском мошенничества. Если обнаруживаемый Voice ID рейтинг риска равен или превышает порог, говорящий считается мошенником.

WatchlistIds -> (список)

Идентификатор списков наблюдения, по которым выполняется обнаружение мошенничества.

(строка)

Сокращенный синтаксис:

ExistingEnrollmentAction=string,FraudDetectionConfig={FraudDetectionAction=string,RiskThreshold=integer,WatchlistIds=[string,string]}

Синтаксис JSON:

{
  "ExistingEnrollmentAction": "SKIP"|"OVERWRITE",
  "FraudDetectionConfig": {
    "FraudDetectionAction": "IGNORE"|"FAIL",
    "RiskThreshold": integer,
    "WatchlistIds": ["string", ...]
  }
}

--input-data-config (структура)

Конфигурация входных данных, содержащая расположение S3 для файла манифеста входных данных, который содержит список запросов на регистрацию голоса.

S3Uri -> (строка)

Расположение S3 для файла манифеста входных данных, содержащего список отдельных запросов на задание регистрации или регистрации.

Сокращенный синтаксис:

S3Uri=string

Синтаксис JSON:

{
  "S3Uri": "string"
}

--job-name (строка)

Имя вашей задачи по регистрации голоса.

--output-data-config (структура)

Конфигурация выходных данных, содержащая расположение S3, где Voice ID записывает файл вывода задания; вы также должны указать идентификатор ключа KMS для шифрования файла.

KmsKeyId -> (строка)

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

S3Uri -> (строка)

Путь S3 к папке, в которую Voice ID записывает файл вывода задания. У него расширение *.out. Например, если имя входного файла — input-file.json, а путь к выходной папке — s3://output-bucket/output-folder, полный путь к выходному файлу — s3://output-bucket/output-folder/job-Id/input-file.json.out.

Сокращенный синтаксис:

KmsKeyId=string,S3Uri=string

Синтаксис JSON:

{
  "KmsKeyId": "string",
  "S3Uri": "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 для вывода.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

Задача -> (структура)

Подробности о запущеной задаче регистрации голоса спикера.

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

Временная метка создания задачи регистрации голоса спикера.

DataAccessRoleArn -> (строка)

Идентификатор роли IAM (ARN), предоставляющий Voice ID права доступа к ведрам клиента для чтения файла входного манифеста и записи файла вывода задачи.

DomainId -> (строка)

Идентификатор домена, содержащего задачу регистрации голоса спикера.

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

Временная метка завершения задачи регистрации голоса спикера.

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

Настройка, определяющая действие, которое должно быть выполнено, когда спикер уже зарегистрирован в Voice ID, и FraudDetectionConfig, которое следует использовать.

ExistingEnrollmentAction -> (строка)

Действие, выполняемое, когда указанный спикер уже зарегистрирован в указанном домене. Значение по умолчанию - SKIP, что пропускает регистрацию для существующего спикера. Установка значения на OVERWRITE заменяет существующие голосовые отпечатки и аудиозаписи регистрации этого спикера новыми данными, сгенерированными из последнего аудио.

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

Настройка обнаружения мошенничества для задачи регистрации голоса спикера.

FraudDetectionAction -> (строка)

Действие, выполняемое, когда указанный спикер помечен системой обнаружения мошенничества. Значение по умолчанию - FAIL, что отклоняет регистрацию спикера. Изменение этого значения на IGNORE приводит к регистрации спикера, даже если он помечен системой обнаружения мошенничества.

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

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

WatchlistIds -> (список)

Идентификаторы списков наблюдения, по которым выполняется обнаружение мошенничества.

(строка)

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

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

Message -> (строка)

Описание ошибки, приведшей к сбою пакетной задачи.

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

Код HTTP-статуса, отражающий характер ошибки.

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

Настройка входных данных, содержащая URI S3 для файла входного манифеста, который содержит список запросов к задаче регистрации голоса спикера.

S3Uri -> (строка)

Расположение S3 для файла входного манифеста, содержащего список отдельных запросов на регистрацию или регистрацию.

JobId -> (строка)

Сгенерированный службой идентификатор задачи регистрации голоса спикера.

JobName -> (строка)

Указанное клиентом имя задачи регистрации голоса спикера.

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

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

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

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

JobStatus -> (строка)

Текущий статус задачи регистрации голоса спикера.

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

Настройка выходных данных, содержащая расположение S3, куда Voice ID записывает файл вывода задачи; вы также должны указать идентификатор KMS-ключа для шифрования файла.

KmsKeyId -> (строка)

Идентификатор KMS-ключа, который Voice ID должен использовать для шифрования файла вывода задачи регистрации голоса спикера/регистрации мошенников.

S3Uri -> (строка)

Путь S3 к папке, куда Voice ID записывает файл вывода задачи. Он имеет расширение *.out. Например, если имя входного файла - input-file.json, а путь к выходной папке - s3://output-bucket/output-folder, полный путь к выходному файлу - s3://output-bucket/output-folder/job-Id/input-file.json.out.

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

Spec-Zone.ru

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