StartCallAnalyticsJob

Transkribiert das Audio eines Kundendienstanrufs und wendet alle zusätzlichen Anforderungsparameter an, die Sie in Ihre Anfrage aufnehmen möchten.

Zusätzlich zu vielen standardmäßigen Transkriptionsfunktionen bietet Call Analytics Ihnen Anrufmerkmale, eine Zusammenfassung des Anrufs, die Stimmung des Sprechers und die optionale Bearbeitung Ihres Texttranskripts und Ihrer Audiodatei. Sie können auch benutzerdefinierte Kategorien anwenden, um bestimmte Bedingungen zu kennzeichnen. Weitere Informationen zu diesen Funktionen und Erkenntnissen finden Sie unter Analysieren von Callcenter-Audio mit Call Analytics.

Wenn Sie Kategorien auf Ihren Call Analytics-Job anwenden möchten, müssen Sie diese erstellen, bevor Sie Ihre Stellenanfrage abschicken. Kategorien können nicht rückwirkend auf eine Stelle angewendet werden. Verwenden Sie denCreateCallAnalyticsCategory Vorgang, um eine neue Kategorie zu erstellen. Weitere Informationen zu Call Analytics-Kategorien finden Sie unter Kategorien für Transkriptionen nach einem Anruf erstellen und Kategorien für Echtzeit-Transkriptionen erstellen.

Um eineStartCallAnalyticsJob Anfrage zu stellen, müssen Sie zuerst Ihre Mediendatei in einen Amazon S3 S3-Bucket hochladen. Anschließend können Sie den Amazon S3 S3-Speicherort der Datei mithilfe desMedia Parameters angeben.

Sie müssen die folgenden Parameter in IhrerStartCallAnalyticsJob Anfrage angeben:

• region: DerAWS-Region Ort, an dem Sie Ihre Anfrage stellen. Eine Liste der von Amazon TranscribeAWS-Regionen unterstützten Endpunkte und Kontingente finden Sie unter Amazon Transcribe Transcribe-Endpunkte und Kontingente.

• CallAnalyticsJobName: Ein benutzerdefinierter Name, den Sie für Ihren Transkriptionsauftrag erstellen und der innerhalb Ihres Unternehmens einzigartig istAWS-Konto.

• DataAccessRoleArn: Der Amazon-Ressourcenname (ARN) einer IAM-Rolle, die Berechtigung für den Zugriff auf den Amazon S3 S3-Bucket, der Ihre Eingabedateien enthält.

• Media(MediaFileUrioderRedactedMediaFileUri): Der Amazon S3 S3-Speicherort Ihrer Mediendatei.

Anmerkung

Mit Call Analytics können Sie das in Ihrer Mediendatei enthaltene Audio redigierenRedactedMediaFileUri, indem Sie statt dessen Speicherort angebenMediaFileUri, an dem sich das eingegebene Audio befindet. Wenn Sie Ihr Audio redigieren möchten, finden Sie Ihre redigierten Medien an der Stelle, die imRedactedMediaFileUri Feld Ihrer Antwort angegeben ist.

Anforderungssyntax

{
   "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"
   }
}

Anfrageparameter

Informationen zu den Parametern, die allen Aktionen gemeinsam sind, finden Sie unter Allgemeine Parameter.

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

CallAnalyticsJobName

Ein von Ihnen ausgewählter, eindeutiger Name für Ihren Call Analytics-Job.

Dieser Name unterscheidet zwischen Groß- und Kleinschreibung, darf keine Leerzeichen enthalten und muss innerhalb eines eindeutig seinAWS-Konto. Wenn Sie versuchen, einen neuen Job mit dem gleichen Namen wie ein vorhandener Job zu erstellen, erhalten Sie eineConflictException Fehlermeldung.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 1. Höchstlänge = 200 Zeichen.

Pattern: ^[0-9a-zA-Z._-]+

Erforderlich: Ja

ChannelDefinitions

Ermöglicht die Angabe, welcher Lautsprecher sich auf welchem Kanal befindet. Wenn Ihr Agent beispielsweise der erste Teilnehmer ist, der spricht, würden Sie auf0 (ChannelIdum den ersten Kanal anzugeben) und aufAGENT (ParticipantRoleum anzuzeigen, dass der Agent spricht) einstellen.

Typ: Array von ChannelDefinition-Objekten

Array-Mitglieder: Feste Anzahl von 2 Elementen.

Required: No

DataAccessRoleArn

Der Amazon-Ressourcenname (ARN) einer IAM-Rolle, die Berechtigung für den Zugriff auf den Amazon S3 S3-Bucket, der Ihre Eingabedateien enthält. Wenn die von Ihnen angegebene Rolle nicht über die entsprechenden Berechtigungen für den Zugriff auf den angegebenen Amazon S3-Standort verfügt, schlägt Ihre Anfrage fehl.

IAM-Rollen-ARNs haben das Formatarn:partition:iam::account:role/role-name-with-path. Zum Beispiel: arn:aws:iam::111122223333:role/Admin.

Weitere Informationen finden Sie unter IAM ARNs.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 2048 Zeichen.

Pattern: ^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}$

Erforderlich: Nein

Media

Beschreibt den Amazon S3 S3-Speicherort der Mediendatei, die Sie in Ihrer Call Analytics-Anfrage verwenden möchten.

Typ: Media Objekt

Erforderlich: Ja

OutputEncryptionKMSKeyId

Der KMS-Schlüssel, den Sie zum Verschlüsseln Ihrer Call Analytics-Ausgabe verwenden möchten.

Wenn Sie einen Schlüssel verwenden, der sich im aktuellen befindetAWS-Konto, können Sie Ihren KMS-Schlüssel auf eine von vier Arten angeben:

1. Verwenden Sie die KMS-Schlüssel-ID selbst. Zum Beispiel 1234abcd-12ab-34cd-56ef-1234567890ab.

2. Verwenden Sie einen Alias für die KMS-Schlüssel-ID. Zum Beispiel alias/ExampleAlias.

3. Verwenden Sie Amazon Resource Name (ARN) für die KMS-Schlüssel-ID. Zum Beispiel arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

4. Verwenden Sie den ARN für den Repliatschlüssel. Zum Beispiel arn:aws:kms:region:account-ID:alias/ExampleAlias.

Wenn Sie einen Schlüssel verwenden, der sich in einem anderenAWS-Konto als dem aktuellen befindetAWS-Konto, können Sie Ihren KMS-Schlüssel auf eine von zwei Arten angeben:

1. Verwenden Sie den ARN für die KMS-Schlüssel-ID. Zum Beispiel arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

2. Verwenden Sie den ARN für den Repliatschlüssel. Zum Beispiel arn:aws:kms:region:account-ID:alias/ExampleAlias.

Wenn Sie keinen Verschlüsselungsschlüssel angeben, wird Ihre Ausgabe mit dem Standardschlüssel Amazon S3-Schlüssel (SSE-S3) verschlüsselt.

Wenn Sie einen KMS-Schlüssel zum Verschlüsseln Ihrer Ausgabe angeben, müssen Sie mithilfe desOutputLocation Parameters auch einen Ausgabeort angeben.

Beachten Sie, dass die Rolle, dieStartCallAnalyticsJob Anforderung stellt, den ausgewählten KMS-Schlüssel zu verwenden.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 2048 Zeichen.

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

Erforderlich: Nein

OutputLocation

Der Amazon S3 S3-Standort, an dem Ihre Transkriptionsausgabe von Call Analytics gespeichert werden soll. Sie können eines der folgenden Formate verwenden, um den Ausgabeort anzugeben:

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

Sofern Sie keinen Dateinamen angeben (Option 3), hat der Name Ihrer Ausgabedatei einen Standardwert, der dem Namen entspricht, den Sie für Ihren Transkriptionsjob mit demCallAnalyticsJobName Parameter angegeben haben.

Mit demOutputEncryptionKMSKeyId Parameter können Sie einen KMS-Schlüssel angeben, um Ihre Ausgabe zu verschlüsseln. Wenn Sie keinen KMS-Schlüssel angeben, verwendet Amazon Transcribe den Amazon S3-Schlüssel für serverseitige Verschlüsselung.

Wenn Sie nichts angebenOutputLocation, wird Ihr Transkript in einem vom Service verwalteten Amazon S3 S3-Bucket abgelegt und Sie erhalten eine URI für den Zugriff auf Ihr Transkript.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 1. Maximale Länge von 2000.

Pattern: (s3://|http(s*)://).+

Erforderlich: Nein

Settings

Geben Sie in IhrerStartCallAnalyticsJob Anfrage zusätzliche optionale Einstellungen an, einschließlich Inhaltsredaktion. Ermöglicht es Ihnen, benutzerdefinierte Sprachmodelle, Vokabelfilter und benutzerdefinierte Vokabeln auf Ihren Call Analytics-Job anzuwenden.

Typ: CallAnalyticsJobSettings Objekt

Erforderlich: Nein

Antwortsyntax

{
   "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"
      }
   }
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

CallAnalyticsJob

Stellt detaillierte Informationen zum aktuellen Call Analytics-Job bereit, einschließlich des Auftragsstatus und, falls zutreffend, der Fehlerursache.

Typ: CallAnalyticsJob Objekt

Fehler

Hinweise zu den Fehlern, die allen Aktionen gemeinsam sind, finden Sie unterHäufige Fehler.

BadRequestException

Ihre Anfrage hat einen oder mehrere Validierungstests nicht bestanden. Dies kann vorkommen, wenn die Entität, die Sie löschen möchten, nicht existiert oder wenn sie sich in einem nicht terminalen Zustand befindet (z. B.IN PROGRESS). Weitere Informationen finden Sie unter Ausnahmemeldung.

HTTP Status Code: 400

ConflictException

Eine Ressource mit diesem Namen ist bereits vorhanden. Ressourcennamen müssen innerhalb eines -Kontos eindeutig seinAWS-Konto.

HTTP Status Code: 400

InternalFailureException

Es ist ein interner Fehler aufgetreten. Überprüfen Sie die Fehlermeldung, korrigieren Sie das Problem und versuchen Sie erneut mit der Anfrage.

HTTP Status Code: 500

LimitExceededException

Sie haben entweder zu viele Anfragen gesendet oder Ihre Eingabedatei ist zu lang. Warten Sie, bevor Sie Ihre Anfrage erneut versuchen, oder verwenden Sie eine kleinere Datei und versuchen Sie es erneut.

HTTP Status Code: 400

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS-SDKs finden Sie unter:

• AWS-Befehlszeilenschnittstelle

• AWS-SDK für .NET

• AWS-SDK für C++

• AWS-SDK for Go

• AWS-SDK für Java V2

• AWSSDK für JavaScript

• AWS SDK für PHP V3

• AWS SDK für Python

• AWS SDK für Ruby V3