StartCallAnalyticsJob - 转录
请求语法请求参数响应语法响应元素错误另请参阅

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

StartCallAnalyticsJob

转录来自客户服务电话的音频，并应用您选择包含在请求中的任何其他请求参数。

除了许多标准转录功能外，Call Analytics 还为您提供通话特征、通话摘要、说话者情绪以及对文本记录和音频文件的可选编辑。您也可以应用自定义类别来标记指定条件。要了解有关这些功能和见解的更多信息，请参阅使用呼叫分析分析呼叫中心音频。

如果您想将类别应用于 Call Analytics 职位，则必须在提交工作请求之前创建这些类别。类别不能追溯应用于职务。要创建新类别，请使用CreateCallAnalyticsCategory操作。要了解有关 Call Analytics 类别的更多信息，请参阅为通话后转录创建类别和为实时转录创建类别。

要发出StartCallAnalyticsJob请求，您必须先将您的媒体文件上传到 Amazon S3 存储桶；然后您可以使用Media参数指定文件的 Amazon S3 位置。

您必须在StartCallAnalyticsJob请求中包含以下参数：

  • region: 您提出请求AWS 区域的地方。有关 Amazon TranscribeAWS 区域 支持的列表，请参阅 Amazon Transcribe 终端节点和配额。

  • CallAnalyticsJobName: 您为转录作业创建的自定义名称，该名称在您的转录工作中是独一无二的AWS 账户。

  • DataAccessRoleArn：具有访问包含您的输入文件的 Amazon S3 存储桶的权限的 Amazon 资源名称（ARN）的权限。

  • Media(MediaFileUri或RedactedMediaFileUri)：您的媒体文件的 Amazon S3 位置。

注意

使用 Call Analytics，您可以通过添加而不是指定输入音频的MediaFileUri位置来编辑媒体文件中包含的音频。RedactedMediaFileUri如果您选择编辑音频，则可以在回复RedactedMediaFileUri字段中指定的位置找到已编辑的媒体。

请求语法

{
   "CallAnalyticsJobName": "string",
   "ChannelDefinitions": [ 
      { 
         "ChannelId": number,
         "ParticipantRole": "string"
      }
   ],
   "DataAccessRoleArn": "string",
   "Media": { 
      "MediaFileUri": "string",
      "RedactedMediaFileUri": "string"
   },
   "OutputEncryptionKMSKeyId": "string",
   "OutputLocation": "string",
   "Settings": { 
      "ContentRedaction": { 
         "PiiEntityTypes": [ "string" ],
         "RedactionOutput": "string",
         "RedactionType": "string"
      },
      "LanguageIdSettings": { 
         "string" : { 
            "LanguageModelName": "string",
            "VocabularyFilterName": "string",
            "VocabularyName": "string"
         }
      },
      "LanguageModelName": "string",
      "LanguageOptions": [ "string" ],
      "VocabularyFilterMethod": "string",
      "VocabularyFilterName": "string",
      "VocabularyName": "string"
   }
}

请求参数

有关所有操作通用的参数的信息，请参阅常用参数。

请求接受采用 JSON 格式的以下数据。

CallAnalyticsJobName

由您为呼叫分析工作选择的唯一名称。

此名称区分大小写，不能包含空格，并且在内必须是唯一的AWS 账户。如果您尝试创建与现有任务具有相同的名称，则遇到了ConflictException错误。

类型：字符串

长度限制：最小长度为 1。最大长度为 200。

模式：^[0-9a-zA-Z._-]+

必需：是

ChannelDefinitions

可以指定哪个扬声器在哪个频道上。例如，如果您的代理是第一个发言的参与者，则ChannelId应将设置为0（表示第一个频道）和ParticipantRole toAGENT（表示是代理人在讲话）。

类型：ChannelDefinition 对象数组

数组成员：固定数量的 2 项。

必需：否

DataAccessRoleArn

具有访问包含您的输入文件的 Amazon S3 存储桶的权限的 Amazon 资源名称（ARN）的权限。如果您指定的角色没有访问指定的 Amazon S3 位置的相应权限，则您的请求将失败。

IAM 角色 ARN 的格式为arn:partition:iam::account:role/role-name-with-path。例如：arn:aws:iam::111122223333:role/Admin。

有关更多信息，请参阅 IAM ARN。

类型：字符串

长度限制：最小长度为 20。最大长度为 2048。

模式：^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$

必需：否

Media

描述您要在呼叫分析请求中使用的媒体文件的 Amazon S3 位置。

类型：Media 对象

必需：是

OutputEncryptionKMSKeyId

要用于加密呼叫分析输出的 KMM 密钥的 KMM 密钥。

如果使用当前AWS 账户密钥，则可以通过以下四种方式之一指定 KMS 密钥：

  1. 使用 KMS 密钥 ID 本身。例如，1234abcd-12ab-34cd-56ef-1234567890ab。

  2. 使用别名作KMM密钥ID 的别名。例如，alias/ExampleAlias。

  3. 使用Amazon 资源名称（ARN）作KMM密钥ID。例如，arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab。

  4. 使用 ARN 作KMM密钥别名。例如，arn:aws:kms:region:account-ID:alias/ExampleAlias。

如果使用的密钥与当前密钥AWS 账户不同AWS 账户，则可以通过以下两种方式之一指定 KMS 密钥：

  1. 使用 ARN 作为 KMS 密钥 ID。例如，arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab。

  2. 使用 ARN 作KMM密钥别名。例如，arn:aws:kms:region:account-ID:alias/ExampleAlias。

如果您不指定加密密钥，则您的输出将使用默认 Amazon S3 密钥加密（SSE-S3）。

如果您指定 KMS 密钥来加密输出，则还必须使用OutputLocation参数指定输出位置。

请注意，StartCallAnalyticsJob发出请求的角色必须拥有使用指定 KMS 密钥的权限。

类型：字符串

长度限制：最小长度为 1。最大长度为 2048。

模式：^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$

必需：否

OutputLocation

您想要存储呼叫分析转录输出的 Amazon S3 位置。您可以使用以下任何格式来指定输出位置：

  1. s3://DOC-EXAMPLE-BUCKET

  2. s3://DOC-EXAMPLE-BUCKET/my-output-folder/

  3. s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json

除非您指定文件名（选项 3），否则输出文件的名称的默认值与您使用CallAnalyticsJobName参数为转录作业指定的名称相匹配。

您可以使用OutputEncryptionKMSKeyId参数指定 KMS 密钥来加密您的输出。如果您不指定 KMMS 密钥，Amazon Transcribe 使用默认的 Amazon S3 密钥进行服务器端加密。

如果您未指定OutputLocation，则您的脚本将放置在服务管理的 Amazon S3 存储桶中，并为您提供访问脚本的 URI。

类型：字符串

长度限制：最小长度为 1。最大长长长长长长长长度长

模式：(s3://|http(s*)://).+

必需：否

Settings

在StartCallAnalyticsJob请求中指定其他可选设置，包括内容编辑；允许您将自定义语言模型、词汇过滤器和自定义词汇应用于 Call Analytics 作业。

类型：CallAnalyticsJobSettings 对象

必需：否

响应语法

{
   "CallAnalyticsJob": { 
      "CallAnalyticsJobName": "string",
      "CallAnalyticsJobStatus": "string",
      "ChannelDefinitions": [ 
         { 
            "ChannelId": number,
            "ParticipantRole": "string"
         }
      ],
      "CompletionTime": number,
      "CreationTime": number,
      "DataAccessRoleArn": "string",
      "FailureReason": "string",
      "IdentifiedLanguageScore": number,
      "LanguageCode": "string",
      "Media": { 
         "MediaFileUri": "string",
         "RedactedMediaFileUri": "string"
      },
      "MediaFormat": "string",
      "MediaSampleRateHertz": number,
      "Settings": { 
         "ContentRedaction": { 
            "PiiEntityTypes": [ "string" ],
            "RedactionOutput": "string",
            "RedactionType": "string"
         },
         "LanguageIdSettings": { 
            "string" : { 
               "LanguageModelName": "string",
               "VocabularyFilterName": "string",
               "VocabularyName": "string"
            }
         },
         "LanguageModelName": "string",
         "LanguageOptions": [ "string" ],
         "VocabularyFilterMethod": "string",
         "VocabularyFilterName": "string",
         "VocabularyName": "string"
      },
      "StartTime": number,
      "Transcript": { 
         "RedactedTranscriptFileUri": "string",
         "TranscriptFileUri": "string"
      }
   }
}

响应元素

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回的以下数据。

CallAnalyticsJob

提供有关当前 Call Analytics 作业的详细信息，包括任务状态和失败原因（如果适用）。

类型：CallAnalyticsJob 对象

错误

有关所有操作常见错误的信息，请参阅常见错误。

BadRequestException

您的请求未通过一项或多项验证测试。当您要删除的实体不存在或处于非终端状态（例如IN PROGRESS）时，可能会发生这种情况。有关更多信息，请参阅异常消息字段。

HTTP 状态代码：400

ConflictException

使用此名称的资源已经存在。资源名称在内必须唯一AWS 账户。

HTTP 状态代码：400

InternalFailureException

遇到了内部错误。检查错误消息、更正问题，然后重试您的请求。

HTTP 状态代码：500

LimitExceededException

你要么发送了太多的请求，要么你的输入文件太长。请稍候，然后重试您的请求，或者使用较小的文件重试您的请求。

HTTP 状态代码：400

另请参阅

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息，请参阅以下内容：