get-call-analytics-job

Описание

Предоставляет информацию о задании Call Analytics.

Для просмотра статуса задания, обратитесь к CallAnalyticsJobStatus . Если статус является COMPLETED , задание завершено. Вы можете найти завершённый транскрипт по URI, указанному в TranscriptFileUri . Если статус является FAILED , FailureReason предоставляет подробности о причинах сбоя задания транскрипции.

Если вы включили редактирование персональной идентификационной информации (PII), отредактированный транскрипт находится по адресу, указанному в RedactedTranscriptFileUri .

Если вы выбрали редактирование аудио в вашем медиафайле, вы можете найти отредактированный медиафайл по адресу, указанному в RedactedMediaFileUri .

Для получения списка ваших заданий Call Analytics используйте операцию.

См. также: AWS API Documentation

Синтаксис

  get-call-analytics-job
--call-analytics-job-name <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, информация о котором требуется. Имена заданий чувствительны к регистру.

--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-адрес команды на предоставленную.

--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-auto-prompt (логическое значение)

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

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

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

Вывод

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

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

CallAnalyticsJobName -> (строка)

Имя задания анализа звонков. Имена заданий чувствительны к регистру и должны быть уникальными в пределах учетной записи Amazon Web Services.

CallAnalyticsJobStatus -> (строка)

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

Если состояние равно COMPLETED , задание завершено, и вы можете найти результаты по указанному пути в TranscriptFileUri (или RedactedTranscriptFileUri , если вы запросили удаление транскрипта). Если состояние равно FAILED , FailureReason содержит подробную информацию о причинах сбоя задания транскрипции.

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

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

Skipped -> (список)

Содержит информацию о любых пропущенных функциях анализа во время анализа задания анализа звонков.

Этот массив перечисляет все пропущенные функции анализа вместе с соответствующим кодом причины и сообщением.

(структура)

Представляет пропущенную функцию анализа во время анализа задания анализа звонков.

Поле Feature указывает тип пропущенной функции анализа.

Поле Message содержит дополнительную информацию или сообщение, объясняющее, почему была пропущена функция анализа.

Поле ReasonCode содержит код, указывающий причину пропуска функции анализа.

Feature -> (строка)

Указывает тип функции анализа, который был пропущен во время анализа задания анализа звонков.

ReasonCode -> (строка)

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

Message -> (строка)

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

LanguageCode -> (строка)

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

Если вы не знаете язык, на котором записано аудио, вы можете опустить это поле и позволить Amazon Transcribe автоматически определить язык вашего медиа. Для повышения точности определения языка вы можете указать несколько кодов языка, и Amazon Transcribe выберет наиболее близкое соответствие для вашей транскрипции.

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

Частота дискретизации аудиодорожки в вашем входном медиафайле в герцах.

MediaFormat -> (строка)

Формат входного медиафайла.

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

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

MediaFileUri -> (строка)

Расположение медиафайла в Amazon S3, который вы хотите транскрибировать. Например:

s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

Обратите внимание, что ведро Amazon S3, содержащее ваш входной медиафайл, должно находиться в той же области Amazon Web Services, где вы отправляете запрос транскрипции.

RedactedMediaFileUri -> (строка)

Расположение медиафайла в Amazon S3, который вы хотите отредактировать. Например:

s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

Предупреждение

RedactedMediaFileUri создаёт отредактированный аудиофайл в дополнение к отредактированному транскрипту. Он поддерживается только для запросов транскрипции анализа звонков (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 в запросе задания транскрипции, ваша транскрипция хранится в управляемом сервисом ведре, и RedactedTranscriptFileUri предоставляет вам временный URI для безопасного доступа к вашей транскрипции.

Примечание

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

Дата и время начала обработки заданного задания анализа звонков.

Временные метки имеют формат YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . Например, 2022-05-04T12:32:58.789000-07:00 представляет задание транскрипции, которое начало обработку в 12:32 по времени UTC-7 4 мая 2022 года.

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

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

Временные метки имеют формат YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . Например, 2022-05-04T12:32:58.761000-07:00 представляет задание транскрипции, которое начало обработку в 12:32 по времени UTC-7 4 мая 2022 года.

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

Дата и время завершения обработки заданного задания анализа звонков.

Временные метки имеют формат 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 содержит информацию о причинах сбоя запроса на задание анализа звонков.

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

Включенный в запрос Amazon Resource Name (ARN).

IdentifiedLanguageScore -> (число с плавающей запятой)

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

Показатели уверенности — это значения от 0 до 1; большее значение указывает на более высокую вероятность того, что определённый язык правильно соответствует языку, на котором произнесено медиа.

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

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

VocabularyName -> (строка)

Название пользовательского словаря, который вы хотите включить в запрос транскрипции Call Analytics. Названия пользовательских словарей чувствительны к регистру.

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

Если вы хотите включить пользовательскую модель языка в свой запрос, но не хотите использовать автоматическое определение языка, используйте вместо этого параметр с подпараметром LanguageModelName. Если вы хотите включить пользовательский словарь или пользовательский фильтр словаря (или оба) в свой запрос, но не хотите использовать автоматическое определение языка, используйте вместо этого параметр с подпараметрами VocabularyName или VocabularyFilterName (или оба).

VocabularyName -> (строка)

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

Язык указанного пользовательского словаря должен соответствовать коду языка, который вы указываете в запросе транскрипции. Если языки не совпадают, пользовательский словарь не применяется. Несоответствие языков не приводит к ошибкам или предупреждениям.

VocabularyFilterName -> (строка)

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

Язык указанного пользовательского фильтра словаря должен соответствовать коду языка, который вы указываете в запросе транскрипции. Если языки не совпадают, пользовательский фильтр словаря не применяется. Несоответствие языков не приводит к ошибкам или предупреждениям.

Обратите внимание, что если вы включите VocabularyFilterName в свой запрос, вы также должны включить VocabularyFilterMethod.

LanguageModelName -> (строка)

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

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

Содержит GenerateAbstractiveSummary, что является обязательным параметром, если вы хотите включить генеративное обобщение звонков в свой запрос Call Analytics.

GenerateAbstractiveSummary -> (булево)

Включает генеративное обобщение звонков в вашем запросе Call Analytics.

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

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

ChannelDefinitions -> (список)

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

(структура)

Позволяет указать, какой говорящий находится на каком канале. Например, если ваш агент — первый участник, который говорит, вы установите ChannelId в 0 (чтобы указать первый канал) и ParticipantRole в AGENT (чтобы указать, что говорит агент).

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

Укажите аудиоканал, который вы хотите определить.

ParticipantRole -> (строка)

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

Tags -> (список)

Теги, каждый в виде пары ключ:значение, присвоенные указанной задаче Call Analytics.

(структура)

Добавляет метаданные в виде пары ключ:значение к указанному ресурсу.

Например, вы можете добавить тег Department:Sales к ресурсу, чтобы указать, что он относится к отделу продаж вашей организации. Вы также можете использовать теги для управления доступом на основе тегов.

Дополнительную информацию о тегах см. в разделе Тегирование ресурсов.

Key -> (строка)

Первая часть пары ключ:значение, которая образует тег, связанный с данным ресурсом. Например, в теге Department:Sales ключом является 'Department'.

Value -> (строка)

Вторая часть пары ключ:значение, которая образует тег, связанный с данным ресурсом. Например, в теге Department:Sales значением является 'Sales'.

Обратите внимание, что вы можете установить значение тега в пустую строку, но не можете установить значение тега в null. Опускание значения тега эквивалентно использованию пустой строки.