Syntaxe de la requête Paramètres de demande Syntaxe de la réponse Eléments de réponse Erreurs Voir aussi

StartTranscriptionJob

Transcrit le son d'un fichier multimédia et applique tous les paramètres de demande supplémentaires que vous choisissez d'inclure dans votre demande.

Pour faire uneStartTranscriptionJob 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 votreStartTranscriptionJob 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.
TranscriptionJobName: nom personnalisé que vous créez pour votre tâche de transcription et qui est unique au sein de votreCompte AWS.
Media(MediaFileUri) : emplacement Amazon S3 de votre fichier multimédia.
L'une desLanguageCode optionsIdentifyLanguageIdentifyMultipleLanguages suivantes : Si vous connaissez la langue de votre fichier multimédia, spécifiez-la à l'aide duLanguageCode paramètre ; vous trouverez tous les codes de langue valides dans le tableau des langues prises en charge. Si vous ne connaissez pas les langues parlées dans vos médias, utilisez l'uneIdentifyLanguage ou l'autreIdentifyMultipleLanguages et laissez Amazon Transcribe les identifier pour vous.

Syntaxe de la requête


{
   "ContentRedaction": { 
      "PiiEntityTypes": [ "string" ],
      "RedactionOutput": "string",
      "RedactionType": "string"
   },
   "IdentifyLanguage": boolean,
   "IdentifyMultipleLanguages": boolean,
   "JobExecutionSettings": { 
      "AllowDeferredExecution": boolean,
      "DataAccessRoleArn": "string"
   },
   "KMSEncryptionContext": { 
      "string" : "string" 
   },
   "LanguageCode": "string",
   "LanguageIdSettings": { 
      "string" : { 
         "LanguageModelName": "string",
         "VocabularyFilterName": "string",
         "VocabularyName": "string"
      }
   },
   "LanguageOptions": [ "string" ],
   "Media": { 
      "MediaFileUri": "string",
      "RedactedMediaFileUri": "string"
   },
   "MediaFormat": "string",
   "MediaSampleRateHertz": number,
   "ModelSettings": { 
      "LanguageModelName": "string"
   },
   "OutputBucketName": "string",
   "OutputEncryptionKMSKeyId": "string",
   "OutputKey": "string",
   "Settings": { 
      "ChannelIdentification": boolean,
      "MaxAlternatives": number,
      "MaxSpeakerLabels": number,
      "ShowAlternatives": boolean,
      "ShowSpeakerLabels": boolean,
      "VocabularyFilterMethod": "string",
      "VocabularyFilterName": "string",
      "VocabularyName": "string"
   },
   "Subtitles": { 
      "Formats": [ "string" ],
      "OutputStartIndex": number
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TranscriptionJobName": "string"
}

Paramètres de demande

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

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

ContentRedaction

Permet de supprimer ou de signaler certaines informations d'identification personnelle (PII) dans votre relevé de notes. Si vous utilisezContentRedaction, vous devez également inclure les sous-paramètres :PiiEntityTypesRedactionOutput, etRedactionType.

Type : objet ContentRedaction

Obligatoire : non

IdentifyLanguage

Permet l'identification automatique de la langue dans votre demande de transcription. Utilisez ce paramètre si votre fichier multimédia ne contient qu'une seule langue. Si votre média contient plusieurs langues, utilisez-leIdentifyMultipleLanguages plutôt.

Si vous incluezIdentifyLanguage, vous pouvez éventuellement inclure une liste de codes de langue, en utilisantLanguageOptions, qui, selon vous, peuvent être présents dans votre fichier multimédia. L'inclusion deLanguageOptions restrictionsIdentifyLanguage aux seules options de langue que vous spécifiez, ce qui peut améliorer la précision de la transcription.

Si vous souhaitez appliquer un modèle de langue personnalisé, un vocabulaire personnalisé ou un filtre de vocabulaire personnalisé à votre demande d'identification automatique de la langue, incluez-leLanguageIdSettings avec les sous-paramètres pertinents (VocabularyNameLanguageModelName, etVocabularyFilterName). Si vous incluezLanguageIdSettings, incluez égalementLanguageOptions.

Notez que vous devez inclure l'un desLanguageCodeIdentifyLanguage, ouIdentifyMultipleLanguages dans votre demande. Si vous incluez plusieurs de ces paramètres, votre tâche de transcription échoue.

Type : booléen

Obligatoire : non

IdentifyMultipleLanguages

Permet l'identification automatique en plusieurs langues dans votre demande de travail de transcription. Utilisez ce paramètre si votre fichier multimédia contient plusieurs langues. Si votre média ne contient qu'une seule langue, utilisez-la à laIdentifyLanguage place.

Si vous incluezIdentifyMultipleLanguages, vous pouvez éventuellement inclure une liste de codes de langue, en utilisantLanguageOptions, qui, selon vous, peuvent être présents dans votre fichier multimédia. L'inclusion deLanguageOptions restrictionsIdentifyLanguage aux seules options de langue que vous spécifiez, ce qui peut améliorer la précision de la transcription.

Si vous souhaitez appliquer un vocabulaire personnalisé ou un filtre de vocabulaire personnalisé à votre demande d'identification automatique de la langue, incluez-leLanguageIdSettings avec les sous-paramètres pertinents (VocabularyNameetVocabularyFilterName). Si vous incluezLanguageIdSettings, incluez égalementLanguageOptions.

Type : booléen

Obligatoire : non

JobExecutionSettings

Permet de contrôler la façon dont votre travail de transcription est traité. Actuellement, la seuleJobExecutionSettings modification que vous pouvez choisir est d'activer la mise en file d'attente des tâches à l'aide duAllowDeferredExecution sous-paramètre.

Si vous les incluezJobExecutionSettings dans votre demande, vous devez également inclure les sous-paramètres :AllowDeferredExecution etDataAccessRoleArn.

Type : objet JobExecutionSettings

Obligatoire : non

KMSEncryptionContext

Une carte de paires clé:valeur non secrètes en texte brut, appelées paires de contextes de chiffrement, qui fournissent un niveau de sécurité supplémentaire à vos données. Pour plus d'informations, consultez les sections Contexte deAWS KMS chiffrement et Clés asymétriques dansAWS KMS.

Type : mappage chaîne/chaîne

Entrées de mappage : Nombre maximum de 10 éléments.

Contraintes de longueur de clé : longueur minimale de 1. Longueur maximale de 2000.

Modèle de clé :.*\S.*

Contraintes de longueur de valeur : longueur minimale de 1. Longueur maximale de 2000.

Modèle de valeur :.*\S.*

Obligatoire : non

LanguageCode

Code de langue qui représente la langue parlée dans le fichier multimédia d'entrée.

Si vous n'êtes pas certain de la langue parlée dans votre fichier multimédia, pensez à utiliserIdentifyLanguage ouIdentifyMultipleLanguages à activer l'identification automatique de la langue.

Pour obtenir la liste des langues prises en charge et leurs codes de langue associés, consultez le tableau des langues prises en charge.

Note

Pour transcrire un discours en arabe standard moderne (ar-SA), votre fichier multimédia doit être codé à une fréquence d'échantillonnage de 16 000 Hz ou plus.

Type : String

Obligatoire : non

LanguageIdSettings

Si vous utilisez l'identification automatique de la langue dans votre demande et que vous souhaitez appliquer un modèle linguistique personnalisé, un vocabulaire personnalisé ou un filtre de vocabulaire personnalisé, incluez-leLanguageIdSettings avec les sous-paramètres appropriés (VocabularyNameLanguageModelName, etVocabularyFilterName). Notez que l'identification multilingue (IdentifyMultipleLanguages) ne prend pas en charge les modèles linguistiques personnalisés.

LanguageIdSettingsprend en charge deux à cinq codes de langue. Chaque code de langue que vous incluez peut être associé à un modèle de langue personnalisé, à un vocabulaire personnalisé et à un filtre de vocabulaire personnalisé. Les codes de langue que vous spécifiez doivent correspondre aux langues des modèles linguistiques personnalisés, des vocabulaires personnalisés et des filtres de vocabulaire personnalisés associés.

Il est recommandé de l'inclureLanguageOptions lors de l'utilisationLanguageIdSettings pour vous assurer que le dialecte correct est identifié. Par exemple, si vous spécifiez un vocabulaire personnalisé qui se trouve dans,en-US mais qu'Amazon Transcribe détermine que c'est la langue parlée dans votre médiaen-AU, votre vocabulaire personnalisé n'est pas appliqué à votre transcription. Si vous incluezLanguageOptions et incluez enen-US tant que seul dialecte de langue anglaise, votre vocabulaire personnalisé est appliqué à votre transcription.

Si vous souhaitez inclure un modèle de langue personnalisé dans votre demande, mais que vous ne souhaitez pas utiliser l'identification automatique de la langue, utilisez plutôt leModelSettings paramètre avec leLanguageModelName sous-paramètre. Si vous souhaitez inclure un vocabulaire personnalisé ou un filtre de vocabulaire personnalisé (ou les deux) dans votre demande, mais que vous ne souhaitez pas utiliser l'identification automatique de la langue, utilisez plutôt leSettings paramètre avec le sous-paramètreVocabularyName ouVocabularyFilterName (ou les deux).

Type : mappage de chaîne àLanguageIdSettings objet

Entrées de mappage : nombre maximal de 5 éléments.

Obligatoire : non

LanguageOptions

Vous pouvez spécifier deux codes de langue ou plus qui représentent les langues qui, selon vous, peuvent être présentes dans vos médias. Il n'est pas recommandé d'en inclure plus de cinq. Si vous n'êtes pas certain des langues présentes, n'incluez pas ce paramètre.

Si vous incluezLanguageOptions dans votre demande, vous devez également inclureIdentifyLanguage.

Pour plus d'informations, consultez la section Langues prises en charge.

Pour transcrire un discours en arabe standard moderne (ar-SA), votre fichier multimédia doit être codé à une fréquence d'échantillonnage de 16 000 Hz ou plus.

Type : tableau de chaînes

Membres du tableau : Nombre minimum de 1 élément.

Obligatoire : non

Media

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

Type : objet Media

Obligatoire : oui

MediaFormat

Spécifiez le format de votre fichier multimédia d'entrée.

Type : String

Valeurs valides : mp3 | mp4 | wav | flac | ogg | amr | webm

Obligatoire : non

MediaSampleRateHertz

Fréquence d'échantillonnage, en hertz, de la piste audio de votre fichier multimédia d'entrée.

Si vous ne spécifiez pas de fréquence d'échantillonnage multimédia, Amazon Transcribe la détermine pour vous. Si vous spécifiez la fréquence d'échantillonnage, elle doit correspondre à la fréquence détectée par Amazon Transcribe. S'il existe une différence entre la valeur que vous spécifiez et la valeur détectée, votre tâche échoue. Dans la plupart des cas, vous pouvez omettre Amazon TranscribeMediaSampleRateHertz et laisser Amazon Transcribe déterminer la fréquence d'échantillonnage.

Type : entier

Plage valide : Valeur minimum de 8. Valeur maximum de 48 000.

Obligatoire : non

ModelSettings

Spécifiez le modèle linguistique personnalisé que vous souhaitez inclure dans votre travail de transcription. Si vous l'incluezModelSettings dans votre demande, vous devez inclure leLanguageModelName sous-paramètre.

Pour de plus amples informations, veuillez consulterModèles de langage personnalisés.

Type : objet ModelSettings

Obligatoire : non

OutputBucketName

Le nom du compartiment Amazon S3 dans lequel vous souhaitez stocker votre sortie de transcription. N'incluez pas leS3:// préfixe du compartiment spécifié.

Si vous souhaitez que votre sortie soit dirigée vers un sous-dossier de ce compartiment, spécifiez-le à l'aide duOutputKey paramètre ;OutputBucketName seul le nom d'un compartiment est accepté.

Par exemple, si vous souhaitez que votre sortie soit enregistrée dansS3://DOC-EXAMPLE-BUCKET, réglez-laOutputBucketName surDOC-EXAMPLE-BUCKET. Toutefois, si vous souhaitez que votre sortie soit enregistréeS3://DOC-EXAMPLE-BUCKET/test-files/,OutputBucketName réglez-la surDOC-EXAMPLE-BUCKET etOutputKey surtest-files/.

Notez qu'Amazon Transcribe doit être autorisé à utiliser l'emplacement spécifié. Vous pouvez modifier les autorisations Amazon S3 à l'aide du AWS Management Console. Reportez-vous également à la section Autorisations requises pour les rôles d'utilisateur IAM.

Si vous ne le spécifiez pasOutputBucketName, 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 maximale de 64.

Modèle : [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]

Obligatoire : non

OutputEncryptionKMSKeyId

clé KMS que vous souhaitez utiliser pour chiffrer votre sortie de transcription.

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 :

Utilisez l'ID de clé KMS lui-même. Par exemple, 1234abcd-12ab-34cd-56ef-1234567890ab.
Utilisez un alias pour l'ID de la clé KMS. Par exemple, alias/ExampleAlias.
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.
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 :

Utilisez l'ARN pour l'ID de clé KMS. Par exemple, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
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é de chiffrement, votre sortie est chiffrée avec la clé Amazon S3 par défaut (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 à l'origine de laStartCallAnalyticsJob demande doit être autorisé à utiliser la clé KMS sélectionnée.

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

OutputKey

Utilisez-le en combinaison avecOutputBucketName pour spécifier l'emplacement de sortie de votre transcription et, éventuellement, un nom unique pour votre fichier de sortie. Le nom par défaut de votre sortie de transcription est le même que celui que vous avez spécifié pour votre tâche de transcription (TranscriptionJobName).

Voici quelques exemples de la façon dont vous pouvez utiliserOutputKey :

Si vous spécifiez « DOC-EXAMPLE-BUCKET » commeOutputBucketName et « my-transcript.json » commeOutputKey, le chemin de sortie de votre transcription ests3://DOC-EXAMPLE-BUCKET/my-transcript.json.
Si vous spécifiezmy-first-transcription « » commeTranscriptionJobName, « DOC-EXAMPLE-BUCKET » comme et « my-transcript » commeOutputKey, le chemin de sortie de votre transcription ests3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.OutputBucketName
Si vous spécifiez « DOC-EXAMPLE-BUCKET » commeOutputBucketName et « test-files/my-transcript.json » commeOutputKey, le chemin de sortie de votre transcription ests3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
Si vous spécifiezmy-first-transcription « » commeTranscriptionJobName, « DOC-EXAMPLE-BUCKET » comme et « test-files/my-transcript » commeOutputKey, le chemin de sortie de votre transcription ests3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.OutputBucketName

Si vous spécifiez le nom d'un sous-dossier de compartiment Amazon S3 qui n'existe pas, un sous-dossier est créé pour vous.

Type : String

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

Modèle : [a-zA-Z0-9-_.!*'()/]{1,1024}$

Obligatoire : non

Settings

Spécifiez des paramètres facultatifs supplémentaires dans votreStartTranscriptionJob demande, notamment l'identification des chaînes, les transcriptions alternatives, le partitionnement des haut-parleurs. Vous pouvez l'utiliser pour appliquer des vocabulaires et des filtres de vocabulaire personnalisés.

Si vous souhaitez inclure un vocabulaire personnalisé ou un filtre de vocabulaire personnalisé (ou les deux) dans votre demande, mais que vous ne souhaitez pas utiliser l'identification automatique de la langue,Settings utilisez-le avec le sous-paramètreVocabularyName ouVocabularyFilterName (ou les deux).

Si vous utilisez l'identification automatique de la langue avec votre demande et que vous souhaitez inclure un modèle de langue personnalisé, un vocabulaire personnalisé ou un filtre de vocabulaire personnalisé, utilisez plutôt leLanguageIdSettings paramètre avec lesLanguageModelNameVocabularyName ou desVocabularyFilterName sous-paramètres.

Type : objet Settings

Obligatoire : non

Subtitles

Produit des fichiers de sous-titres pour vos supports d'entrée. Vous pouvez spécifier les formats WebVTT (*.vtt) et SubRip (*.srt).

Type : objet Subtitles

Obligatoire : non

Tags

Ajoute une ou plusieurs balises personnalisées, chacune sous la forme d'une paire clé:valeur, à une nouvelle tâche de transcription au moment où vous commencez cette nouvelle tâche.

Pour en savoir plus sur l'utilisation des balises avec Amazon Transcribe, veuillez consulter Amazon Transcribe, veuillez consulter Ressources de balisage.

Type : tableau d’objets Tag

Membres du tableau : Nombre minimum de 1 élément. Nombre maximum de 200 éléments.

Obligatoire : non

TranscriptionJobName

Un nom unique, que vous avez choisi, pour votre travail de transcription. Le nom que vous spécifiez est également utilisé comme nom par défaut de votre fichier de sortie de transcription. Si vous souhaitez spécifier un nom différent pour la sortie de votre transcription, utilisez leOutputKey paramètre.

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 unConflictException message d'erreur.

Type : String

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

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

Obligatoire : oui

Syntaxe de la réponse


{
   "TranscriptionJob": { 
      "CompletionTime": number,
      "ContentRedaction": { 
         "PiiEntityTypes": [ "string" ],
         "RedactionOutput": "string",
         "RedactionType": "string"
      },
      "CreationTime": number,
      "FailureReason": "string",
      "IdentifiedLanguageScore": number,
      "IdentifyLanguage": boolean,
      "IdentifyMultipleLanguages": boolean,
      "JobExecutionSettings": { 
         "AllowDeferredExecution": boolean,
         "DataAccessRoleArn": "string"
      },
      "LanguageCode": "string",
      "LanguageCodes": [ 
         { 
            "DurationInSeconds": number,
            "LanguageCode": "string"
         }
      ],
      "LanguageIdSettings": { 
         "string" : { 
            "LanguageModelName": "string",
            "VocabularyFilterName": "string",
            "VocabularyName": "string"
         }
      },
      "LanguageOptions": [ "string" ],
      "Media": { 
         "MediaFileUri": "string",
         "RedactedMediaFileUri": "string"
      },
      "MediaFormat": "string",
      "MediaSampleRateHertz": number,
      "ModelSettings": { 
         "LanguageModelName": "string"
      },
      "Settings": { 
         "ChannelIdentification": boolean,
         "MaxAlternatives": number,
         "MaxSpeakerLabels": number,
         "ShowAlternatives": boolean,
         "ShowSpeakerLabels": boolean,
         "VocabularyFilterMethod": "string",
         "VocabularyFilterName": "string",
         "VocabularyName": "string"
      },
      "StartTime": number,
      "Subtitles": { 
         "Formats": [ "string" ],
         "OutputStartIndex": number,
         "SubtitleFileUris": [ "string" ]
      },
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "Transcript": { 
         "RedactedTranscriptFileUri": "string",
         "TranscriptFileUri": "string"
      },
      "TranscriptionJobName": "string",
      "TranscriptionJobStatus": "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.

TranscriptionJob

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

Type : objet TranscriptionJob

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, veuillez consulter le champ de message d'exception.

Code d'état HTTP : 400

ConflictException

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

Code d'état HTTP : 400

InternalFailureException

Une erreur interne s'est produite. Vérifiez le message d'erreur, corrigez le problème et réessayez de répondre à votre demande.

Code d'état HTTP : 500

LimitExceededException

Vous avez envoyé trop de demandes ou votre fichier d'entrée est trop long. Patientez 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 :

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

StartMedicalTranscriptionJob

TagResource