[ aws . transcribe ]
start-call-analytics-job
Описание
Транскрибирует аудио из телефонного звонка службы поддержки клиентов и применяет любые дополнительные параметры запроса, которые вы хотите включить в свой запрос.
Помимо многих стандартных функций транскрипции, Call Analytics предоставляет вам характеристики звонка, сводку звонка, эмоциональную окраску говорящего и (по желанию) удаление текста транскрипта и аудиофайла. Вы также можете применять настраиваемые категории для флагования определённых условий. Чтобы узнать больше об этих функциях и возможностях, обратитесь к разделу Анализ аудио звонков центра поддержки клиентов с помощью Call Analytics.
Если вы хотите применить категории к своей задаче Call Analytics, вы должны создать их до отправки запроса на задание. Категории не могут быть применены к задаче задним числом. Чтобы создать новую категорию, используйте операцию. Чтобы узнать больше о категориях Call Analytics, ознакомьтесь со статьями Создание категорий для постзвонковой транскрипции и Создание категорий для транскрипции в реальном времени.
Для отправки запроса StartCallAnalyticsJob, сначала необходимо загрузить ваш медиафайл в Amazon S3-ведро; затем вы можете указать расположение файла Amazon S3 с помощью параметра Media.
Для задач Call Analytics доступна очередь задач. Если вы передаете DataAccessRoleArn в своём запросе и превышаете свой лимит одновременных задач, ваша задача автоматически добавится в очередь для обработки, как только количество одновременных задач станет меньше лимита.
Вы должны включить следующие параметры в свой запрос StartCallAnalyticsJob:
-
region: Регион Amazon Web Services, в котором вы отправляете запрос. Список поддерживаемых Amazon Web Services регионов Amazon Transcribe можно найти в документации по конечным точкам и квотам Amazon Transcribe. -
CallAnalyticsJobName: Настраиваемое имя для вашей задачи транскрипции, уникальное в рамках вашей учётной записи Amazon Web Services. -
Media(MediaFileUriилиRedactedMediaFileUri): Расположение медиафайла в Amazon S3.
Примечание
С Call Analytics вы можете удалять аудио, содержащееся в медиафайле, включивRedactedMediaFileUri вместо MediaFileUri для указания расположения входного аудио. Если вы решили удалить аудио, вы можете найти удалённый медиафайл по адресу, указанному в поле RedactedMediaFileUri вашего ответа.См. также: AWS API Documentation
Синопсис
start-call-analytics-job
--call-analytics-job-name <value>
--media <value>
[--output-location <value>]
[--output-encryption-kms-key-id <value>]
[--data-access-role-arn <value>]
[--settings <value>]
[--tags <value>]
[--channel-definitions <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]
Параметры
--call-analytics-job-name (строка)
Уникальное имя, выбранное вами, для вашей задачи Call Analytics.
Это имя чувствительно к регистру, не может содержать пробелы и должно быть уникальным в рамках учётной записи Amazon Web Services. Если вы попытаетесь создать новую задачу с тем же именем, что и у существующей задачи, будет получена ошибка ConflictException.
--media (структура)
Описывает расположение файла медиа в Amazon S3, которое вы хотите использовать в своём запросе Call Analytics.
MediaFileUri -> (строка)
Расположение медиафайла в Amazon S3, который вы хотите транскрибировать. Например:
s3://DOC-EXAMPLE-BUCKET/my-media-file.flacs3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
Обратите внимание, что Amazon S3-ведро, содержащее входной медиафайл, должно находиться в том же регионе Amazon Web Services, в котором вы отправляете запрос на транскрипцию.
RedactedMediaFileUri -> (строка)
Расположение медиафайла в Amazon S3, который вы хотите удалить. Например:
s3://DOC-EXAMPLE-BUCKET/my-media-file.flacs3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
Обратите внимание, что Amazon S3-ведро, содержащее входной медиафайл, должно находиться в том же регионе Amazon Web Services, в котором вы отправляете запрос на транскрипцию.
Предупреждение
RedactedMediaFileUri создаёт удалённый аудиофайл в дополнение к удалённому транскрипту. Он поддерживается только для запросов транскрипции Call Analytics (StartCallAnalyticsJob).Сокращённый синтаксис:
MediaFileUri=string,RedactedMediaFileUri=string
Синтаксис JSON:
{
"MediaFileUri": "string",
"RedactedMediaFileUri": "string"
}
--output-location (строка)
Расположение в Amazon S3, где вы хотите сохранить выходные данные транскрипции Call Analytics. Вы можете использовать любой из следующих форматов для указания расположения выходных данных:
- s3://DOC-EXAMPLE-BUCKET
- s3://DOC-EXAMPLE-BUCKET/my-output-folder/
- s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json
Если вы не укажете имя файла (вариант 3), имя выходного файла по умолчанию соответствует имени, указанному для задачи транскрипции с помощью параметра CallAnalyticsJobName.
Вы можете указать ключ KMS для шифрования выходных данных с помощью параметра OutputEncryptionKMSKeyId. Если вы не укажете ключ KMS, Amazon Transcribe использует ключ Amazon S3 по умолчанию для шифрования на стороне сервера.
Если вы не укажете OutputLocation, ваш транскрипт будет размещён в управляемом службой Amazon S3-ведре, и вам будет предоставлен URI для доступа к транскрипту.
--output-encryption-kms-key-id (строка)
Ключ KMS, который вы хотите использовать для шифрования выходных данных Call Analytics.
Если используете ключ из текущей учётной записи Amazon Web Services, вы можете указать ключ KMS четырьмя способами:
- Используйте сам идентификатор ключа KMS. Например,
1234abcd-12ab-34cd-56ef-1234567890ab. - Используйте псевдоним для идентификатора ключа KMS. Например,
alias/ExampleAlias. - Используйте Amazon Resource Name (ARN) для идентификатора ключа KMS. Например,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Используйте ARN для псевдонима ключа KMS. Например,
arn:aws:kms:region:account-ID:alias/ExampleAlias.
Если используете ключ из другой учётной записи Amazon Web Services, чем текущая, вы можете указать ключ KMS двумя способами:
- Используйте ARN для идентификатора ключа KMS. Например,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Используйте ARN для псевдонима ключа KMS. Например,
arn:aws:kms:region:account-ID:alias/ExampleAlias.
Если вы не укажете ключ шифрования, ваши выходные данные будут зашифрованы с помощью ключа Amazon S3 по умолчанию (SSE-S3).
Если вы укажете ключ KMS для шифрования выходных данных, вы также должны указать расположение выходных данных с помощью параметра OutputLocation.
Обратите внимание, что роль, отправляющая запрос, должна иметь разрешение на использование указанного ключа KMS.
--data-access-role-arn (строка)
Amazon Resource Name (ARN) роли IAM, имеющей разрешения на доступ к Amazon S3-ведру, содержащему ваши входные файлы. Если у указанной роли нет соответствующих разрешений для доступа к указанному расположению Amazon S3, ваш запрос завершится ошибкой.
ARN ролей IAM имеют формат arn:partition:iam::account:role/role-name-with-path. Например: arn:aws:iam::111122223333:role/Admin.
Дополнительную информацию см. в IAM ARNs.
--settings (структура)
Укажите дополнительные необязательные параметры в запросе, включая редактирование содержимого; позволяет применять пользовательские языковые модели, фильтры словаря и пользовательские словари к вашему заданию Call Analytics.
VocabularyName -> (строка)
VocabularyFilterName -> (строка)
Имя пользовательского фильтра словаря, который вы хотите включить в запрос транскрипции Call Analytics. Названия пользовательских фильтров словаря чувствительны к регистру.
Обратите внимание, что если вы включаете VocabularyFilterName в свой запрос, вы также должны включить VocabularyFilterMethod.
VocabularyFilterMethod -> (строка)
Укажите, как вы хотите применить пользовательский фильтр словаря к вашей транскрипции.
Чтобы заменить слова на ***, выберите mask.
Чтобы удалить слова, выберите remove.
Чтобы пометить слова без их изменения, выберите tag.
LanguageModelName -> (строка)
Название пользовательской языковой модели, которую вы хотите использовать при обработке вашего задания Call Analytics. Обратите внимание, что названия пользовательских языковых моделей чувствительны к регистру.
Язык указанной пользовательской языковой модели должен соответствовать коду языка, который вы указываете в запросе транскрипции. Если языки не совпадают, пользовательская языковая модель не применяется. Несоответствие языков не сопровождается ошибками или предупреждениями.
ContentRedaction -> (структура)
Позволяет редактировать или помечать определенную личную идентифицируемую информацию (PII) в вашей транскрипции. Если вы используете ContentRedaction, вы также должны включить подпараметры: RedactionOutput и RedactionType. Вы можете необязательно включить PiiEntityTypes, чтобы выбрать типы PII, которые вы хотите редактировать.
RedactionType -> (строка)
PII (личная идентифицируемая информация) — единственное допустимое значение. Вы можете использовать PiiEntityTypes, чтобы выбрать типы PII, которые вы хотите отредактировать. Если вы не включаете PiiEntityTypes в свой запрос, вся PII редактируется.RedactionOutput -> (строка)
Укажите, хотите ли вы только отредактированную транскрипцию или отредактированную и неотредактированную транскрипцию.
При выборе redacted Amazon Transcribe создает только отредактированную транскрипцию.
При выборе redacted_and_unredacted Amazon Transcribe создает отредактированную и неотредактированную транскрипцию (в виде двух отдельных файлов).
PiiEntityTypes -> (список)
Укажите типы личной идентифицируемой информации (PII), которую вы хотите отредактировать в своей транскрипции. Вы можете включить любое количество типов или выбрать ALL. Если вы не включаете PiiEntityTypes в свой запрос, вся PII редактируется.
(строка)
LanguageOptions -> (список)
Вы можете указать два или более кодов языка, которые представляют языки, которые, по вашему мнению, могут присутствовать в вашем медиафайле. Включение более пяти кодов не рекомендуется. Если вы не уверены, какие языки присутствуют, не включайте этот параметр.
Включение параметров языка может повысить точность определения языка.
Список языков, поддерживаемых Call Analytics, см. в таблице Поддерживаемые языки.
Для транскрипции речи на современном стандартном арабском языке (ar-SA) в Amazon Web Services GovCloud (US) (US-West, us-gov-west-1), Amazon Web Services GovCloud (US) (US-East, us-gov-east-1), Канада (Калгари) ca-west-1 и Африка (Кейптаун) af-south-1, ваш медиафайл должен быть закодирован со скоростью дискретизации 16 000 Гц или выше.
(строка)
LanguageIdSettings -> (карта)
Если вы используете автоматическое определение языка в своем запросе и хотите применить пользовательскую языковую модель, пользовательский словарь или пользовательский фильтр словаря, включите LanguageIdSettings с соответствующими подпараметрами (VocabularyName, LanguageModelName и VocabularyFilterName).
LanguageIdSettings поддерживает от двух до пяти кодов языка. Каждый включенный вами код языка может иметь соответствующую пользовательскую языковую модель, пользовательский словарь и пользовательский фильтр словаря. Коды языков, которые вы указываете, должны соответствовать языкам соответствующих пользовательских языковых моделей, пользовательских словарей и пользовательских фильтров словарей.Рекомендуется включить LanguageOptions при использовании LanguageIdSettings, чтобы гарантировать идентификацию правильного диалекта языка. Например, если вы указываете пользовательский словарь, который находится на языке en-US, но Amazon Transcribe определяет, что язык, на котором говорят в вашем медиафайле, это en-AU, ваш пользовательский словарь не применяется к вашей транскрипции. Если вы включите LanguageOptions и включите en-US в качестве единственного диалекта английского языка, ваш пользовательский словарь применяется к вашей транскрипции.
Если вы хотите включить пользовательскую языковую модель, пользовательский словарь или пользовательский фильтр словаря со своим запросом, но не хотите использовать автоматическое определение языка, используйте вместо этого параметр с подпараметрами LanguageModelName, VocabularyName или VocabularyFilterName.
Список языков, поддерживаемых Call Analytics, см. в разделе Поддерживаемые языки и языковые особенности.
key -> (строка)
value -> (структура)
Если вы используете автоматическое определение языка в своем запросе и хотите применить пользовательскую языковую модель, пользовательский словарь или пользовательский фильтр словаря, включите LanguageIdSettings с соответствующими подпараметрами (VocabularyName, LanguageModelName и VocabularyFilterName). Обратите внимание, что многоязычное определение (IdentifyMultipleLanguages) не поддерживает пользовательские языковые модели.
LanguageIdSettings поддерживает от двух до пяти кодов языка. Каждый включенный вами код языка может иметь соответствующую пользовательскую языковую модель, пользовательский словарь и пользовательский фильтр словаря. Коды языков, которые вы указываете, должны соответствовать языкам соответствующих пользовательских языковых моделей, пользовательских словарей и пользовательских фильтров словарей.Рекомендуется включить LanguageOptions при использовании LanguageIdSettings, чтобы гарантировать идентификацию правильного диалекта языка. Например, если вы указываете пользовательский словарь, который находится на языке en-US, но Amazon Transcribe определяет, что язык, на котором говорят в вашем медиафайле, это en-AU, ваш пользовательский словарь не применяется к вашей транскрипции. Если вы включите LanguageOptions и включите en-US в качестве единственного диалекта английского языка, ваш пользовательский словарь применяется к вашей транскрипции.
Если вы хотите включить пользовательскую языковую модель со своим запросом, но не хотите использовать автоматическое определение языка, используйте вместо этого параметр с подпараметром LanguageModelName. Если вы хотите включить пользовательский словарь или пользовательский фильтр словаря (или оба) со своим запросом, но не хотите использовать автоматическое определение языка, используйте вместо этого параметр с подпараметрами VocabularyName или VocabularyFilterName (или обоими).
VocabularyName -> (строка)
Название пользовательского словаря, который вы хотите использовать при обработке задания транскрипции. Названия пользовательских словарей чувствительны к регистру.
Язык указанного пользовательского словаря должен соответствовать коду языка, который вы указываете в запросе транскрипции. Если языки не совпадают, пользовательский словарь не применяется. Несоответствие языков не сопровождается ошибками или предупреждениями.
VocabularyFilterName -> (строка)
Название пользовательского фильтра словаря, который вы хотите использовать при обработке задания транскрипции. Названия пользовательских фильтров словаря чувствительны к регистру.
Язык указанного пользовательского фильтра словаря должен соответствовать коду языка, который вы указываете в запросе транскрипции. Если языки не совпадают, пользовательский фильтр словаря не применяется. Несоответствие языков не сопровождается ошибками или предупреждениями.
Обратите внимание, что если вы включаете VocabularyFilterName в свой запрос, вы также должны включить VocabularyFilterMethod.
LanguageModelName -> (строка)
Название пользовательской языковой модели, которую вы хотите использовать при обработке задания транскрипции. Обратите внимание, что названия пользовательских языковых моделей чувствительны к регистру.
Язык указанной пользовательской языковой модели должен соответствовать коду языка, который вы указываете в запросе транскрипции. Если языки не совпадают, пользовательская языковая модель не применяется. Несоответствие языков не сопровождается ошибками или предупреждениями.
Summarization -> (структура)
Содержит GenerateAbstractiveSummary, который является обязательным параметром, если вы хотите включить генеративное обобщение вызовов в своем запросе Call Analytics.
GenerateAbstractiveSummary -> (булево)
Включает генеративное обобщение вызовов в вашем запросе Call Analytics
Генеративное обобщение вызовов предоставляет резюме транскрипции, включая важные компоненты, обсуждавшиеся в разговоре.
Дополнительную информацию см. в разделе Включение генеративного обобщения вызовов.
Синтаксис сокращенной формы:
VocabularyName=string,VocabularyFilterName=string,VocabularyFilterMethod=string,LanguageModelName=string,ContentRedaction={RedactionType=string,RedactionOutput=string,PiiEntityTypes=[string,string]},LanguageOptions=string,string,LanguageIdSettings={KeyName1={VocabularyName=string,VocabularyFilterName=string,LanguageModelName=string},KeyName2={VocabularyName=string,VocabularyFilterName=string,LanguageModelName=string}},Summarization={GenerateAbstractiveSummary=boolean}
Синтаксис JSON:
{
"VocabularyName": "string",
"VocabularyFilterName": "string",
"VocabularyFilterMethod": "remove"|"mask"|"tag",
"LanguageModelName": "string",
"ContentRedaction": {
"RedactionType": "PII",
"RedactionOutput": "redacted"|"redacted_and_unredacted",
"PiiEntityTypes": ["BANK_ACCOUNT_NUMBER"|"BANK_ROUTING"|"CREDIT_DEBIT_NUMBER"|"CREDIT_DEBIT_CVV"|"CREDIT_DEBIT_EXPIRY"|"PIN"|"EMAIL"|"ADDRESS"|"NAME"|"PHONE"|"SSN"|"ALL", ...]
},
"LanguageOptions": ["af-ZA"|"ar-AE"|"ar-SA"|"da-DK"|"de-CH"|"de-DE"|"en-AB"|"en-AU"|"en-GB"|"en-IE"|"en-IN"|"en-US"|"en-WL"|"es-ES"|"es-US"|"fa-IR"|"fr-CA"|"fr-FR"|"he-IL"|"hi-IN"|"id-ID"|"it-IT"|"ja-JP"|"ko-KR"|"ms-MY"|"nl-NL"|"pt-BR"|"pt-PT"|"ru-RU"|"ta-IN"|"te-IN"|"tr-TR"|"zh-CN"|"zh-TW"|"th-TH"|"en-ZA"|"en-NZ"|"vi-VN"|"sv-SE"|"ab-GE"|"ast-ES"|"az-AZ"|"ba-RU"|"be-BY"|"bg-BG"|"bn-IN"|"bs-BA"|"ca-ES"|"ckb-IQ"|"ckb-IR"|"cs-CZ"|"cy-WL"|"el-GR"|"et-ET"|"eu-ES"|"fi-FI"|"gl-ES"|"gu-IN"|"ha-NG"|"hr-HR"|"hu-HU"|"hy-AM"|"is-IS"|"ka-GE"|"kab-DZ"|"kk-KZ"|"kn-IN"|"ky-KG"|"lg-IN"|"lt-LT"|"lv-LV"|"mhr-RU"|"mi-NZ"|"mk-MK"|"ml-IN"|"mn-MN"|"mr-IN"|"mt-MT"|"no-NO"|"or-IN"|"pa-IN"|"pl-PL"|"ps-AF"|"ro-RO"|"rw-RW"|"si-LK"|"sk-SK"|"sl-SI"|"so-SO"|"sr-RS"|"su-ID"|"sw-BI"|"sw-KE"|"sw-RW"|"sw-TZ"|"sw-UG"|"tl-PH"|"tt-RU"|"ug-CN"|"uk-UA"|"uz-UZ"|"wo-SN"|"zh-HK"|"zu-ZA", ...],
"LanguageIdSettings": {"af-ZA"|"ar-AE"|"ar-SA"|"da-DK"|"de-CH"|"de-DE"|"en-AB"|"en-AU"|"en-GB"|"en-IE"|"en-IN"|"en-US"|"en-WL"|"es-ES"|"es-US"|"fa-IR"|"fr-CA"|"fr-FR"|"he-IL"|"hi-IN"|"id-ID"|"it-IT"|"ja-JP"|"ko-KR"|"ms-MY"|"nl-NL"|"pt-BR"|"pt-PT"|"ru-RU"|"ta-IN"|"te-IN"|"tr-TR"|"zh-CN"|"zh-TW"|"th-TH"|"en-ZA"|"en-NZ"|"vi-VN"|"sv-SE"|"ab-GE"|"ast-ES"|"az-AZ"|"ba-RU"|"be-BY"|"bg-BG"|"bn-IN"|"bs-BA"|"ca-ES"|"ckb-IQ"|"ckb-IR"|"cs-CZ"|"cy-WL"|"el-GR"|"et-ET"|"eu-ES"|"fi-FI"|"gl-ES"|"gu-IN"|"ha-NG"|"hr-HR"|"hu-HU"|"hy-AM"|"is-IS"|"ka-GE"|"kab-DZ"|"kk-KZ"|"kn-IN"|"ky-KG"|"lg-IN"|"lt-LT"|"lv-LV"|"mhr-RU"|"mi-NZ"|"mk-MK"|"ml-IN"|"mn-MN"|"mr-IN"|"mt-MT"|"no-NO"|"or-IN"|"pa-IN"|"pl-PL"|"ps-AF"|"ro-RO"|"rw-RW"|"si-LK"|"sk-SK"|"sl-SI"|"so-SO"|"sr-RS"|"su-ID"|"sw-BI"|"sw-KE"|"sw-RW"|"sw-TZ"|"sw-UG"|"tl-PH"|"tt-RU"|"ug-CN"|"uk-UA"|"uz-UZ"|"wo-SN"|"zh-HK"|"zu-ZA": {
"VocabularyName": "string",
"VocabularyFilterName": "string",
"LanguageModelName": "string"
}
...},
"Summarization": {
"GenerateAbstractiveSummary": true|false
}
}
--tags (список)
Добавляет один или несколько пользовательских тегов, каждый в виде пары ключ:значение, к новому заданию Call Analytics в момент запуска этого нового задания.
Дополнительную информацию об использовании тегов с Amazon Transcribe см. в разделе Маркировка ресурсов.
(структура)
Добавляет метаданные в виде пары ключ:значение к указанному ресурсу.
Например, вы можете добавить тег Department:Sales к ресурсу, чтобы указать, что он относится к отделу продаж вашей организации. Вы также можете использовать теги для управления доступом на основе тегов.
Дополнительную информацию о тегах см. в разделе Маркировка ресурсов.
Key -> (строка)
Department:Sales ключом является «Department».Value -> (строка)
Вторая часть пары ключ:значение, которая образует тег, связанный с данным ресурсом. Например, в теге Department:Sales значением является «Sales».
Обратите внимание, что вы можете установить значение тега в пустую строку, но не можете установить значение тега в null. Пропуск значения тега эквивалентен использованию пустой строки.
Синтаксис сокращенной формы:
Key=string,Value=string ...
Синтаксис JSON:
[
{
"Key": "string",
"Value": "string"
}
...
]
--channel-definitions (список)
Позволяет указать, какой говорящий находится на каком канале. Например, если ваш агент — первый участник, который заговорит, вы установите ChannelId на 0 (чтобы указать первый канал) и ParticipantRole на AGENT (чтобы указать, что говорит агент).
(структура)
Позволяет указать, какой говорящий находится на каком канале. Например, если ваш агент — первый участник, который заговорит, вы установите ChannelId на 0 (чтобы указать первый канал) и ParticipantRole на AGENT (чтобы указать, что говорит агент).
ChannelId -> (целое число)
ParticipantRole -> (строка)
Сокращенная синтаксическая запись:
ChannelId=integer,ParticipantRole=string ...
Синтаксис JSON:
[
{
"ChannelId": integer,
"ParticipantRole": "AGENT"|"CUSTOMER"
}
...
]
--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
- таблица
- 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 версии 1, а двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного параметра cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (логическое значение)
Отключить пейджер командной строки для вывода.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода командной строки.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запросить параметры ввода командной строки.
Вывод
CallAnalyticsJob -> (структура)
Предоставляет подробную информацию о текущей задаче Call Analytics, включая состояние задачи и, при необходимости, причину ошибки.
CallAnalyticsJobName -> (строка)
CallAnalyticsJobStatus -> (строка)
Предоставляет состояние указанной задачи Call Analytics.
Если состояние равно COMPLETED, задача завершена, и вы можете найти результаты по указанному расположению в TranscriptFileUri (или RedactedTranscriptFileUri, если вы запросили удаление транскрипта). Если состояние равно FAILED, FailureReason содержит подробности о причинах сбоя вашей задачи транскрипции.
CallAnalyticsJobDetails -> (структура)
Предоставляет подробную информацию о задаче аналитики звонка, включая информацию о пропущенных функциях аналитики.
Skipped -> (список)
Содержит информацию о любых пропущенных функциях аналитики во время анализа задачи аналитики звонка.
Этот массив перечисляет все пропущенные функции аналитики вместе с соответствующим кодом причины и сообщением.
(структура)
Представляет пропущенную функцию аналитики во время анализа задачи аналитики звонка.
Поле Feature указывает тип пропущенной функции аналитики.
Поле Message содержит дополнительную информацию или сообщение, объясняющее, почему функция аналитики была пропущена.
Поле ReasonCode содержит код, указывающий причину пропуска функции аналитики.
Feature -> (строка)
ReasonCode -> (строка)
Message -> (строка)
LanguageCode -> (строка)
Код языка, используемый для создания вашей задачи Call Analytics. Список поддерживаемых языков и соответствующих кодов языков см. в таблице Поддерживаемые языки.
Если вы не знаете язык, на котором произнесено содержимое вашего файла мультимедиа, вы можете опустить это поле и позволить Amazon Transcribe автоматически определить язык вашего мультимедиа. Для повышения точности определения языка вы можете включить несколько кодов языков, и Amazon Transcribe выберет наиболее подходящий вариант для вашей транскрипции.
MediaSampleRateHertz -> (целое число)
MediaFormat -> (строка)
Media -> (структура)
Предоставляет расположение Amazon S3 файла мультимедиа, который вы использовали в запросе Call Analytics.
MediaFileUri -> (строка)
Расположение файла мультимедиа в Amazon S3, который вы хотите транскрибировать. Например:
s3://DOC-EXAMPLE-BUCKET/my-media-file.flacs3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
Обратите внимание, что ведро Amazon S3, содержащее ваш входной файл мультимедиа, должно находиться в той же зоне Amazon Web Services, где вы делаете запрос транскрипции.
RedactedMediaFileUri -> (строка)
Расположение файла мультимедиа для удаления в Amazon S3. Например:
s3://DOC-EXAMPLE-BUCKET/my-media-file.flacs3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
Обратите внимание, что ведро Amazon S3, содержащее ваш входной файл мультимедиа, должно находиться в той же зоне Amazon Web Services, где вы делаете запрос транскрипции.
Предупреждение
RedactedMediaFileUri генерирует заблокированный аудиофайл в дополнение к заблокированному транскрипту. Он поддерживается только для запросов транскрипции Call Analytics (StartCallAnalyticsJob).Transcript -> (структура)
Предоставляет URI Amazon S3, который вы можете использовать для доступа к вашему транскрипту.
TranscriptFileUri -> (строка)
Расположение вашего транскрипта в Amazon S3. Вы можете использовать этот URI для доступа или загрузки вашего транскрипта.
Если вы включили OutputBucketName в запрос своей задачи транскрипции, это URI этого ведра. Если вы также включили OutputKey в свой запрос, ваш результат находится в указанном в запросе пути.
Если вы не включили OutputBucketName в запрос своей задачи транскрипции, ваш транскрипт хранится в управляемом службой ведре, и TranscriptFileUri предоставляет вам временный URI для безопасного доступа к вашему транскрипту.
Примечание
Временные URI для управляемых службой Amazon S3 ведер действительны только в течение 15 минут. Если вы получите ошибкуAccesDenied, вы можете получить новый временный URI, выполнив запрос GetTranscriptionJob или ListTranscriptionJob.RedactedTranscriptFileUri -> (строка)
Расположение вашего заблокированного транскрипта в Amazon S3. Вы можете использовать этот URI для доступа или загрузки вашего транскрипта.
Если вы включили OutputBucketName в запрос своей задачи транскрипции, это URI этого ведра. Если вы также включили OutputKey в свой запрос, ваш результат находится в указанном в запросе пути.
Если вы не включили OutputBucketName в запрос своей задачи транскрипции, ваш транскрипт хранится в управляемом службой ведре, и RedactedTranscriptFileUri предоставляет вам временный URI для безопасного доступа к вашему транскрипту.
Примечание
Временные URI для управляемых службой Amazon S3 ведер действительны только в течение 15 минут. Если вы получите ошибкуAccesDenied, вы можете получить новый временный URI, выполнив запрос GetTranscriptionJob или ListTranscriptionJob.StartTime -> (метка времени)
Дата и время начала обработки указанной задачи Call Analytics.
Метки времени имеют формат YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. Например, 2022-05-04T12:32:58.789000-07:00 представляет задачу транскрипции, которая начала обработку в 12:32 по UTC-7 4 мая 2022 г.
CreationTime -> (метка времени)
Дата и время создания запроса на указанную задачу Call Analytics.
Метки времени имеют формат YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. Например, 2022-05-04T12:32:58.761000-07:00 представляет задачу транскрипции, которая начала обработку в 12:32 по UTC-7 4 мая 2022 г.
CompletionTime -> (метка времени)
Дата и время завершения обработки указанной задачи Call Analytics.
Метки времени имеют формат YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. Например, 2022-05-04T12:33:13.922000-07:00 представляет задачу транскрипции, которая начала обработку в 12:33 по UTC-7 4 мая 2022 г.
FailureReason -> (строка)
Если CallAnalyticsJobStatus равно FAILED, FailureReason содержит информацию о причинах сбоя запроса задачи Call Analytics.
Поле FailureReason содержит одно из следующих значений:
-
Unsupported media format. Указанный вMediaFormatформат мультимедиа недействителен. Обратитесь к параметруMediaFormatдля списка поддерживаемых форматов. -
The media format provided does not match the detected media format. Указанный вMediaFormatформат мультимедиа не соответствует формату входного файла. Проверьте формат мультимедиа вашего файла и исправьте указанное значение. -
Invalid sample rate for audio file. Указанная вMediaSampleRateHertzчастота дискретизации недействительна. Частота дискретизации должна находиться в диапазоне от 8000 до 48000 герц. -
The sample rate provided does not match the detected sample rate. Указанная вMediaSampleRateHertzчастота дискретизации не соответствует частоте дискретизации, обнаруженной в вашем входном файле мультимедиа. Проверьте частоту дискретизации вашего файла мультимедиа и исправьте указанное значение. -
Invalid file size: file size too large. Размер вашего файла мультимедиа превышает обрабатываемый Amazon Transcribe. Дополнительная информация представлена в разделе квоты сервиса. -
Invalid number of channels: number of channels too large. Ваш аудиофайл содержит больше каналов, чем может обработать Amazon Transcribe. Дополнительная информация представлена в разделе квоты сервиса.
DataAccessRoleArn -> (строка)
IdentifiedLanguageScore -> (вещественное число)
Оценка доверия, связанная с языком, определенным в вашем файле мультимедиа.
Оценки доверия представляют собой значения от 0 до 1; более высокое значение указывает на более высокую вероятность того, что определенный язык соответствует языку, на котором произнесено содержимое вашего файла мультимедиа.
Settings -> (структура)
Предоставляет информацию о любых дополнительных настройках, которые были включены в ваш запрос. Дополнительные настройки включают параметры редакции контента и определения языка.
VocabularyName -> (строка)
VocabularyFilterName -> (строка)
Название пользовательского фильтра словаря, который вы хотите включить в запрос транскрипции Call Analytics. Названия пользовательских фильтров словаря чувствительны к регистру.
Обратите внимание, что если вы включите VocabularyFilterName в свой запрос, вам также необходимо включить VocabularyFilterMethod .
VocabularyFilterMethod -> (строка)
Укажите, как вы хотите применить пользовательский фильтр словаря к вашей транскрипции.
Чтобы заменить слова на *** , выберите mask .
Чтобы удалить слова, выберите remove .
Чтобы пометить слова, не изменяя их, выберите tag .
LanguageModelName -> (строка)
Название пользовательской модели языка, которую вы хотите использовать при обработке вашей работы Call Analytics. Обратите внимание, что имена пользовательских моделей языка чувствительны к регистру.
Язык указанной пользовательской модели языка должен соответствовать коду языка, который вы указываете в своем запросе транскрипции. Если языки не совпадают, пользовательская модель языка не применяется. Несоответствие языков не сопровождается ошибками или предупреждениями.
ContentRedaction -> (структура)
Позволяет отредактировать или пометить определенную конфиденциальную информацию (PII) в вашей транскрипции. Если вы используете ContentRedaction , вам также необходимо включить подпараметры: RedactionOutput и RedactionType . Вы можете дополнительно включить PiiEntityTypes, чтобы выбрать типы PII, которые вы хотите отредактировать.
RedactionType -> (строка)
PII (персонально идентифицируемая информация) является единственным допустимым значением. Вы можете использовать PiiEntityTypes, чтобы выбрать типы PII, которые вы хотите отредактировать. Если вы не включите PiiEntityTypes в свой запрос, вся PII будет отредактирована.RedactionOutput -> (строка)
Укажите, хотите ли вы только отредактированную транскрипцию или отредактированную и неотредактированную транскрипцию.
При выборе redacted Amazon Transcribe создаёт только отредактированную транскрипцию.
При выборе redacted_and_unredacted Amazon Transcribe создаёт отредактированную и неотредактированную транскрипцию (как два отдельных файла).
PiiEntityTypes -> (список)
Укажите типы персонально идентифицируемой информации (PII), которые вы хотите отредактировать в своей транскрипции. Вы можете включить любое количество типов или выбрать ALL . Если вы не включите PiiEntityTypes в свой запрос, вся PII будет отредактирована.
(строка)
LanguageOptions -> (список)
Вы можете указать два или более кодов языка, которые представляют языки, которые, по вашему мнению, могут присутствовать в вашем медиаконтенте. Включение более пяти кодов не рекомендуется. Если вы не уверены в присутствующих языках, не включайте этот параметр.
Включение параметров языка может повысить точность определения языка.
Список языков, поддерживаемых Call Analytics, см. в таблице Поддерживаемые языки.
Для транскрипции речи на современном стандартном арабском языке (ar-SA) в Amazon Web Services GovCloud (US) (US-West, us-gov-west-1), Amazon Web Services GovCloud (US) (US-East, us-gov-east-1), Канаде (Калгари) ca-west-1 и Африке (Кейптаун) af-south-1, файл вашего медиа должен быть закодирован со скоростью дискретизации 16 000 Гц или выше.
(строка)
LanguageIdSettings -> (карта)
Если вы используете автоматическое определение языка в своем запросе и хотите применить пользовательскую модель языка, пользовательский словарь или пользовательский фильтр словаря, включите LanguageIdSettings с соответствующими подпараметрами (VocabularyName, LanguageModelName и VocabularyFilterName).
LanguageIdSettings поддерживает два-пять кодов языка. Каждый включенный вами код языка может иметь связанную пользовательскую модель языка, пользовательский словарь и пользовательский фильтр словаря. Коды языка, которые вы указываете, должны соответствовать языкам связанных пользовательских моделей языка, пользовательских словарей и пользовательских фильтров словарей.Рекомендуется включать LanguageOptions при использовании LanguageIdSettings, чтобы гарантировать идентификацию правильного диалекта языка. Например, если вы указали пользовательский словарь на языке en-US, но Amazon Transcribe определит, что язык, на котором ведется речь в вашем медиа, — это en-AU, ваш пользовательский словарь не будет применен к вашей транскрипции. Если вы включите LanguageOptions и укажете en-US в качестве единственного диалекта английского языка, ваш пользовательский словарь будет применён к вашей транскрипции.
Если вы хотите включить пользовательскую модель языка, пользовательский словарь или пользовательский фильтр словаря в свой запрос, но не хотите использовать автоматическое определение языка, используйте параметр с подпараметрами LanguageModelName, VocabularyName или VocabularyFilterName.
Список языков, поддерживаемых Call Analytics, см. в разделе Поддерживаемые языки и языковые особенности.
ключ -> (строка)
значение -> (структура)
Если вы используете автоматическое определение языка в своем запросе и хотите применить пользовательскую модель языка, пользовательский словарь или пользовательский фильтр словаря, включите LanguageIdSettings с соответствующими подпараметрами (VocabularyName, LanguageModelName и VocabularyFilterName). Обратите внимание, что многоязычное определение (IdentifyMultipleLanguages) не поддерживает пользовательские модели языка.
LanguageIdSettings поддерживает два-пять кодов языка. Каждый включенный вами код языка может иметь связанную пользовательскую модель языка, пользовательский словарь и пользовательский фильтр словаря. Коды языка, которые вы указываете, должны соответствовать языкам связанных пользовательских моделей языка, пользовательских словарей и пользовательских фильтров словарей.Рекомендуется включать LanguageOptions при использовании LanguageIdSettings, чтобы гарантировать идентификацию правильного диалекта языка. Например, если вы указали пользовательский словарь на языке en-US, но Amazon Transcribe определит, что язык, на котором ведётся речь в вашем медиа, — это en-AU, ваш пользовательский словарь не будет применён к вашей транскрипции. Если вы включите LanguageOptions и укажете en-US в качестве единственного диалекта английского языка, ваш пользовательский словарь будет применён к вашей транскрипции.
Если вы хотите включить пользовательскую модель языка в свой запрос, но не хотите использовать автоматическое определение языка, используйте параметр с подпараметром LanguageModelName. Если вы хотите включить пользовательский словарь или пользовательский фильтр словаря (или оба) в свой запрос, но не хотите использовать автоматическое определение языка, используйте вместо этого параметр с подпараметром VocabularyName или VocabularyFilterName (или оба).
VocabularyName -> (строка)
Название пользовательского словаря, который вы хотите использовать при обработке вашей работы по транскрипции. Названия пользовательских словарей чувствительны к регистру.
Язык указанного пользовательского словаря должен соответствовать коду языка, который вы указываете в своем запросе транскрипции. Если языки не совпадают, пользовательский словарь не применяется. Несоответствие языков не сопровождается ошибками или предупреждениями.
VocabularyFilterName -> (строка)
Название пользовательского фильтра словаря, который вы хотите использовать при обработке вашей работы по транскрипции. Названия пользовательских фильтров словаря чувствительны к регистру.
Язык указанного пользовательского фильтра словаря должен соответствовать коду языка, который вы указываете в своем запросе транскрипции. Если языки не совпадают, пользовательский фильтр словаря не применяется. Несоответствие языков не сопровождается ошибками или предупреждениями.
Обратите внимание, что если вы включите VocabularyFilterName в свой запрос, вам также необходимо включить VocabularyFilterMethod .
LanguageModelName -> (строка)
Название пользовательской модели языка, которую вы хотите использовать при обработке вашей работы по транскрипции. Обратите внимание, что имена пользовательских моделей языка чувствительны к регистру.
Язык указанной пользовательской модели языка должен соответствовать коду языка, который вы указываете в своем запросе транскрипции. Если языки не совпадают, пользовательская модель языка не применяется. Несоответствие языков не сопровождается ошибками или предупреждениями.
Summarization -> (структура)
Содержит GenerateAbstractiveSummary, что является обязательным параметром, если вы хотите включить генеративную сводку звонка в свой запрос Call Analytics.
GenerateAbstractiveSummary -> (булево)
Включает генеративную сводку звонка в ваш запрос Call Analytics
Генеративная сводка звонка предоставляет сводку транскрипции, включая важные компоненты, обсуждавшиеся в разговоре.
Дополнительную информацию см. в разделе Включение генеративной сводки звонка.
ChannelDefinitions -> (список)
Указывает, какой говорящий находится на каком канале.
(структура)
Позволяет указать, какой говорящий находится на каком канале. Например, если ваш агент является первым участником, который говорит, вы бы установили ChannelId в значение 0 (чтобы указать первый канал) и ParticipantRole в значение AGENT (чтобы указать, что говорит агент).
ChannelId -> (целое число)
ParticipantRole -> (строка)
Tags -> (список)
Теги, каждый в виде пары ключ:значение, присвоенные указанной работе по анализу звонков.
(структура)
Добавляет метаданные в виде пары ключ:значение к указанному ресурсу.
Например, вы можете добавить тег Department:Sales к ресурсу, чтобы указать, что он относится к отделу продаж вашей организации. Вы также можете использовать теги для управления доступом на основе тегов.
Дополнительную информацию о тегах см. в разделе Добавление тегов к ресурсам.
Key -> (строка)
Department:Sales ключ — это «Отдел».Value -> (строка)
Вторая часть пары ключ:значение, образующей тег, связанный с данным ресурсом. Например, в теге Department:Sales значение — это «Продажи».
Обратите внимание, что вы можете установить значение тега в пустую строку, но вы не можете установить значение тега в null. Пропуск значения тега эквивалентен использованию пустой строки.
© Copyright 2025, Amazon Web Services. Created using Sphinx.