StartCallAnalyticsJob - 轉錄
請求語法請求參數回應語法回應元素錯誤另請參閱

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

StartCallAnalyticsJob

轉錄來自客戶服務電話的音訊，並套用您選擇包含在請求中的任何其他「要求參數」。

除了許多標準轉錄功能之外，Call Analytics 還為您提供通話特徵，通話摘要，揚聲器情緒以及文本記錄和音頻文件的可選編輯。您也可以套用自訂類別來標記指定的條件。若要深入瞭解這些功能和深入解析，請參閱使用呼叫分析分析來分析客服中心音訊。

如果您想要將類別套用至您的通話分析工作，則必須先建立類別，然後再提交工作要求。類別無法追溯套用至工作。若要建立新品類，請使用此CreateCallAnalyticsCategory作業。若要深入瞭解通話分析類別，請參閱建立通話後轉譯的類別和建立即時轉錄的類別。

若StartCallAnalyticsJob要提出請求，您必須先將媒體檔案上傳到 Amazon S3 儲存貯體；然後您可以使用Media參數指定檔案的 Amazon S3 位置。

您必須在StartCallAnalyticsJob要求中包含下列參數：

  • region：您提出請求的位AWS 區域置。如需 Amazon 轉錄AWS 區域支援的清單，請參閱 Amazon Transcribe 端點和配額。

  • CallAnalyticsJobName：您為轉錄工作創建的自定義名稱，在您的AWS 帳戶.

  • DataAccessRoleArn：具備可存取包含您的輸入檔案的 Amazon S3 儲存貯體許可。

  • Media(MediaFileUri或RedactedMediaFileUri)：媒體檔案的 Amazon S3 位置。

注意

使用通話分析，您可以通過包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

您為通話分析工作選擇的唯一名稱。

此名稱區分大小寫，不能包含空格，且在AWS 帳戶. 如果您嘗試建立與現有工作相同名稱的新工作，就會收到ConflictException錯誤訊息。

類型：String

長度限制：長度下限為 1。長度上限為 200。

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

必要：是

ChannelDefinitions

可以指定哪個揚聲器在哪個頻道上。例如，如果您的代理是第一個發言的參與者，您可ChannelId以設置為0（表示第一個頻道）和ParticipantRoleAGENT（表示它是代理發言者）。

類型：ChannelDefinition 物件陣列

陣列成員：固定項目數為 2。

必要：否

DataAccessRoleArn

IAM 角色的 Amazon Resource Name (ARN)，具備可存取包含您的輸入檔案的 Amazon S3 儲存貯體許可。如果您指定的角色沒有適當的權限來存取指定的 Amazon S3 位置，則您的請求會失敗。

IAM 角色 ARN 具有以下格式arn:partition:iam::account:role/role-name-with-path。例如︰arn:aws:iam::111122223333:role/Admin。

如需詳細資訊，請參閱 IAM ARN。

類型：String

長度限制︰長度下限為 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 key (您希望用來加密 CMS)

如果使用位於目前的金鑰AWS 帳戶，您可以使用下列四種方式之一來指定 KMS 金鑰：

  1. 使用 KMS 金鑰識別碼本身。例如：1234abcd-12ab-34cd-56ef-1234567890ab。

  2. 使用 KMS key Name (KMS) 例如：alias/ExampleAlias。

  3. 使用 Amazon Resource Name (ARN) 作為 KMS key (ARN)。例如：arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab。

  4. 使用 ARN 作為 KMS key (KMS) 例如：arn:aws:kms:region:account-ID:alias/ExampleAlias。

如果使用與目前金鑰AWS 帳戶不同的金鑰AWS 帳戶，您可以使用下列其中一種方式指定 KMS 金鑰：

  1. 使用 ARN 做為 KMS 金鑰識別碼。例如：arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab。

  2. 使用 ARN 作為 KMS key (KMS) 例如：arn:aws:kms:region:account-ID:alias/ExampleAlias。

如果您沒有指定加密 key (Amazon S3))，您的輸出將使用預設的 Amazon S3 S3 key (SSE-S3))))))

如果您指定 KMS 金鑰來加密輸出，則還必須使用OutputLocation參數指定輸出位置。

請注意，發出StartCallAnalyticsJob請求的角色必須得到許可才能使用指定的 KMS key (提供許可)

類型：String

長度限制：長度下限為 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-foldermy-call-analytics-job

除非您指定檔案名稱 (選項 3)，否則輸出檔案名稱的預設值與您使用該CallAnalyticsJobName參數為轉錄工作指定的名稱相符。

您可以指定 KMS 金鑰，以使用OutputEncryptionKMSKeyId參數加密輸出。如果您未指定 KMS 金鑰，Amazon Transcribe 使用預設的 Amazon S3 金鑰進行伺服器端加密。

如果未指定OutputLocation，您的成績單會放置在服務管理的 Amazon S3 儲存貯體中，並提供 URI 以存取您的成績單。

類型：String

長度限制：長度下限為 1。長度上限為 2000。

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

必要：否

Settings

在StartCallAnalyticsJob要求中指定其他選用設定，包括內容密文；可讓您將自訂語言模型、字彙篩選器和自訂字彙套用至「通話分析」工作。

類型：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

提供有關目前呼叫分析工作的詳細資訊，包括工作狀態和失敗原因 (如果適用)。

類型：CallAnalyticsJob 物件

錯誤

如需所有動作常見的錯誤相關資訊，請參閱常見錯誤。

BadRequestException

您的要求未通過一或多個驗證測試。當您嘗試刪除的實體不存在或處於非終端狀態（例如IN PROGRESS）時，可能會發生這種情況。如需詳細資訊，請參閱例外訊息欄位。

HTTP 狀態碼：400

ConflictException

具有此名稱的資源已存在。資源名稱在內必須是唯一的AWS 帳戶。

HTTP 狀態碼：400

InternalFailureException

發生內部錯誤。檢查錯誤訊息，更正問題，然後再試一次。

HTTP 狀態碼：500

LimitExceededException

您可能傳送太多要求，或輸入檔案太長。請先等候再重試您的要求，或使用較小的檔案再試一次。

HTTP 狀態碼：400

另請參閱

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：