StartCallAnalyticsJob - 转录
请求语法请求参数响应语法响应元素错误另请参阅
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅中国的 Amazon Web Services 服务入门。

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

StartCallAnalyticsJob

注意

并非所有区域都支持呼叫分析。

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

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

如果要将类别应用于您的 Call Analytics 作业，则必须在提交工作请求之前创建类别。类别不能追溯应用于工作。要创建新类别，请使用CreateCallAnalyticsCategoryoperation. 要了解有关呼叫分析类别的更多信息，请参阅创建类别.

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

您必须将以下参数包含在StartCallAnalyticsJob请求:

  • region: 该Amazon Web Services 区域你在哪里提出请求。对于列表Amazon Web Services 区域受Amazon Transcribe 支持，请参阅Amazon Transcribe 终端节点和配额.

  • CallAnalyticsJobName: 您为转录作业创建的自定义名称，在您的Amazon Web Services 账户.

  • DataAccessRoleArn：具有访问包含输入文件的 Amazon S3 存储桶的 IAM 角色的 Amazon 资源名称 (ARN)。

  • Media(MediaFileUri要么RedactedMediaFileUri): 媒体文件的 Amazon S3 位置。

注意

借助 Call Analytics，您可以通过以下方式编辑媒体文件中包含的音频RedactedMediaFileUri，而不是MediaFileUri，指定输入音频的位置。如果您选择编辑音频，则可以在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

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

此名称区分大小写，不能包含空格，并且在Amazon Web Services 账户. 如果您尝试创建与现有作业具有相同名称的新作业，则会获得ConflictException错误消息。

类型: 字符串

长度约束：最小长度为 1。最大长度为 200。

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

必需：是

ChannelDefinitions

可以指定哪个扬声器在哪个声道上。例如，如果您的座席是第一个发言的参与者，则应设置ChannelId到0（表示第一个频道）和ParticipantRole到AGENT（表示是座席在说话）。

类型: 数组ChannelDefinition对象

数组成员：固定 2 项。

必需：否

DataAccessRoleArn

具有访问包含输入文件的 Amazon S3 存储桶的 IAM 角色的 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

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

如果使用位于当前的 Amazon Web Services 账户，您可以通过以下四种方法指定您的 KMS 密钥：

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

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

  3. 使用亚马逊资源名称 (ARN)。例如，arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab。

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

如果使用位于不同的 Amazon Web Services 账户比当前Amazon Web Services 账户，您可以通过以下两种方式指定您的 KMS 密钥：

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

  2. 使用 KARN S 密钥别名。例如，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参数。

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

如果您没有指定OutputLocation，您的成绩单将被放置在服务托管的 Amazon S3 存储桶中，并向您提供一个用于访问您的脚本的 URI。

类型: 字符串

长度约束：最小长度为 1。最大长度为 2000。

模式：(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

已存在具有此名称的资源。资源名称必须唯一Amazon Web Services 账户.

HTTP 状态代码：400

InternalFailureException

发生内部服务器错误。检查错误消息并更正问题，然后重试发送您的请求。

HTTP 状态代码：500

LimitExceededException

您已经发送过多的请求或输入文件太长。等待，然后再重试发送您的请求，或使用较小的文件，然后重试发送您的请求。

HTTP 状态代码：400

另请参阅

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