StartCallAnalyticsJob - Transcribe
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursVoir aussi

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

StartCallAnalyticsJob

Transcrit le son d'un appel au service client et applique tous les paramètres de demande supplémentaires que vous choisissez d'inclure dans votre demande.

Outre de nombreuses fonctionnalités de transcription standard, Call Analytics vous fournit les caractéristiques des appels, le résumé des appels, le sentiment du locuteur et la rédaction facultative de votre transcription textuelle et de votre fichier audio. Vous pouvez également appliquer des catégories personnalisées pour signaler des conditions spécifiques. Pour en savoir plus sur ces fonctionnalités et informations, consultez la section Analyse du son du centre d'appels avec Call Analytics.

Si vous souhaitez appliquer des catégories à votre travail d'analyse des appels, vous devez les créer avant de soumettre votre demande d'emploi. Les catégories ne peuvent pas être appliquées rétroactivement à un emploi. Pour créer une nouvelle catégorie, utilisez l'CreateCallAnalyticsCategoryopération. Pour en savoir plus sur les catégories d'analyse des appels, voir Création de catégories pour les transcriptions post-appel et Création de catégories pour les transcriptions en temps réel.

Pour faire uneStartCallAnalyticsJob demande, vous devez d'abord charger votre fichier multimédia dans un compartiment Amazon S3 ; vous pouvez ensuite spécifier l'emplacement Amazon S3 du fichier à l'aide duMedia paramètre.

Vous devez inclure les paramètres suivants dans votreStartCallAnalyticsJob demande :

  • region: L'Région AWSendroit où vous faites votre demande. Pour obtenir la liste des points de terminaison et quotasRégions AWS pris en charge par Amazon Transcribe, consultez la section Points de terminaison et quotas Amazon Transcribe.

  • CallAnalyticsJobName: nom personnalisé que vous créez pour votre tâche de transcription et qui est unique au sein de votreCompte AWS.

  • DataAccessRoleArn: L'Amazon Resource Name (ARN) d'un rôle IAM qui est autorisé à accéder au compartiment Amazon S3 qui contient vos fichiers d'entrée.

  • Media(MediaFileUriouRedactedMediaFileUri) : l'emplacement Amazon S3 de votre fichier multimédia.

Note

Avec Call Analytics, vous pouvez modifier le contenu audio contenu dans votre fichier multimédia en incluantRedactedMediaFileUri, au lieu de spécifierMediaFileUri, l'emplacement de votre audio d'entrée. Si vous choisissez de rédiger votre audio, vous pouvez trouver votre média expurgé à l'emplacement indiqué dans leRedactedMediaFileUri champ de votre réponse.

Syntaxe de la requête

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

Paramètres de demande

Pour plus d'informations sur les paramètres communs à toutes les actions, voir Paramètres communs.

Cette demande accepte les données suivantes au format JSON.

CallAnalyticsJobName

Un nom unique, que vous avez choisi, pour votre tâche d'analyse des appels.

Ce nom distingue les majuscules des minuscules, ne peut pas contenir d'espaces et doit être unique au sein d'unCompte AWS. Si vous essayez de créer une nouvelle tâche portant le même nom qu'une tâche existante, vous obtenez uneConflictException erreur.

Type : String

Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 200.

Modèle : ^[0-9a-zA-Z._-]+

Obligatoire : oui

ChannelDefinitions

Permet de spécifier quel haut-parleur se trouve sur quel canal. Par exemple, si votre agent est le premier participant à parler, vous devez régler sur0 (ChannelIdpour indiquer le premier canal) et surAGENT (ParticipantRolepour indiquer que c'est l'agent qui parle).

Type : tableau d’objets ChannelDefinition

Membres du tableau : nombre de 2 éléments.

Obligatoire : non

DataAccessRoleArn

L'Amazon Resource Name (ARN) d'un rôle IAM qui est autorisé à accéder au compartiment Amazon S3 qui contient vos fichiers d'entrée. Si le rôle que vous spécifiez ne dispose pas des autorisations appropriées pour accéder à l'emplacement Amazon S3 spécifié, votre demande échoue.

Les ARN du rôle IAM ont le formatarn:partition:iam::account:role/role-name-with-path. Par exemple : arn:aws:iam::111122223333:role/Admin.

Pour de plus amples informations, consultez ARN IAM.

Type : String

Contraintes de longueur : longueur minimale de 20. Longueur maximale de 2048.

Modèle : ^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}$

Obligatoire : non

Media

Décrit l'emplacement Amazon S3 du fichier multimédia que vous souhaitez utiliser dans votre demande Call Analytics.

Type : objet Media

Obligatoire : oui

OutputEncryptionKMSKeyId

La clé KMS que vous souhaitez utiliser pour chiffrer votre sortie Call Analytics.

Si vous utilisez une clé située dans la zone actuelleCompte AWS, vous pouvez spécifier votre clé KMS de l'une des quatre manières suivantes :

  1. Utilisez l'ID de clé KMS lui-même. Par exemple, 1234abcd-12ab-34cd-56ef-1234567890ab.

  2. Utilisez un alias pour l'ID de clé KMS. Par exemple, alias/ExampleAlias.

  3. Utilisez Amazon Resource Name (ARN) pour l'ID de clé KMS. Par exemple, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  4. Utilisez l'ARN pour l'alias de clé KMS. Par exemple, arn:aws:kms:region:account-ID:alias/ExampleAlias.

Si vous utilisez une clé située dans une autreCompte AWS zone que la clé actuelleCompte AWS, vous pouvez spécifier votre clé KMS de deux manières :

  1. Utilisez l'ARN pour l'ID de clé KMS. Par exemple, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  2. Utilisez l'ARN pour l'alias de clé KMS. Par exemple, arn:aws:kms:region:account-ID:alias/ExampleAlias.

Si vous ne spécifiez pas de clé Amazon S3 (SSE-S3), votre sortie est chiffrée avec la clé Amazon S3 (SSE-S3).

Si vous spécifiez une clé KMS pour crypter votre sortie, vous devez également spécifier un emplacement de sortie à l'aide duOutputLocation paramètre.

Notez que le rôle qui est à l'StartCallAnalyticsJoborigine de la demande doit être autorisé à utiliser la clé KMS.

Type : String

Contraintes de longueur : Longueur minimum de 1. Longueur maximale de 2048.

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

Obligatoire : non

OutputLocation

L'emplacement Amazon S3 dans lequel vous souhaitez stocker votre sortie de transcription Call Analytics. Vous pouvez utiliser les formats suivants pour spécifier l'emplacement de sortie :

  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

À moins que vous ne spécifiez un nom de fichier (option 3), le nom de votre fichier de sortie possède une valeur par défaut qui correspond au nom que vous avez spécifié pour votre tâche de transcription à l'aide duCallAnalyticsJobName paramètre.

Vous pouvez spécifier une clé KMS pour crypter votre sortie à l'aide duOutputEncryptionKMSKeyId paramètre. Si vous ne spécifiez pas de clé Amazon S3, Amazon Transcribe utilise la clé Amazon S3 S3 S3 pour le chiffrement côté serveur.

Si vous ne le spécifiez pasOutputLocation, votre transcription est placée dans un compartiment Amazon S3 géré par les services et un URI vous est fourni pour accéder à votre transcription.

Type : String

Contraintes de longueur : Longueur minimum de 1. Longueur de 2 000.

Modèle : (s3://|http(s*)://).+

Obligatoire : non

Settings

Spécifiez des paramètres facultatifs supplémentaires dans votreStartCallAnalyticsJob demande, notamment la rédaction de contenu ; vous pouvez appliquer des modèles linguistiques personnalisés, des filtres de vocabulaire et des vocabulaires personnalisés à votre tâche d'analyse des appels.

Type : objet CallAnalyticsJobSettings

Obligatoire : non

Syntaxe de la réponse

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

Eléments de réponse

Si l'action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

CallAnalyticsJob

Fournit des informations détaillées sur la tâche Call Analytics en cours, y compris l'état de la tâche et, le cas échéant, la raison de l'échec.

Type : objet CallAnalyticsJob

Erreurs

Pour plus d'informations sur les erreurs communes à toutes les actions, consultezErreurs courantes.

BadRequestException

Votre demande n'a pas passé un ou plusieurs tests de validation. Cela peut se produire lorsque l'entité que vous essayez de supprimer n'existe pas ou si elle est dans un état non terminal (par exempleIN PROGRESS). Pour plus d'informations, consultez.

Code d'état HTTP : 400

ConflictException

Une ressource portant ce nom existe déjà. Les noms de ressource doivent être uniques dans unCompte AWS.

Code d'état HTTP : 400

InternalFailureException

Une erreur interne. Vérifiez le message d'erreur, résolvez le problème et réessayez de faire votre demande.

Code d'état HTTP : 500

LimitExceededException

Vous avez envoyé trop de demandes ou votre fichier d'entrée est trop long. Attendez avant de réessayer votre demande, ou utilisez un fichier plus petit et réessayez.

Code d'état HTTP : 400

Voir aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des kits SDK AWS spécifiques au langage, consultez les ressources suivantes :