Anforderungssyntax Anfrageparameter Antwortsyntax Antwortelemente Errors Weitere Informationen finden Sie auch unter:

StartTranscriptionJob

Startet einen asynchronen Auftrag zum Transkribieren von Sprache in Text

Anforderungssyntax


{
   "ContentRedaction": { 
      "RedactionOutput": "string",
      "RedactionType": "string"
   },
   "IdentifyLanguage": boolean,
   "JobExecutionSettings": { 
      "AllowDeferredExecution": boolean,
      "DataAccessRoleArn": "string"
   },
   "KMSEncryptionContext": { 
      "string" : "string" 
   },
   "LanguageCode": "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" ]
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TranscriptionJobName": "string"
}

Anfrageparameter

Informationen zu den Parametern, die allen Aktionen gemeinsam sind, finden Sie unterGeläufige Parameteraus.

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

ContentRedaction

Ein Objekt, das die Anforderungsparameter für die Redaktion von Inhalten enthält.

Typ: ContentRedaction Objekt

: Erforderlich Nein

IdentifyLanguage

Stellen Sie dieses Feld auftrueum die automatische Sprachenidentifizierung zu ermöglichen. Die automatische Sprachenidentifikation ist standardmäßig deaktiviert. Du erhältst einBadRequestExceptionFehler, wenn Sie einen Wert für eineLanguageCodeaus.

Type: Boolesch

: Erforderlich Nein

JobExecutionSettings

Liefert Informationen darüber, wie ein Transkriptionsjob ausgeführt wird. Verwenden Sie dieses Feld, um anzugeben, dass der Job für die verzögerte Ausführung in die Warteschlange gestellt werden kann, wenn das Parallelitätslimit erreicht ist und keine Steckplätze verfügbar sind, um den Job sofort auszuführen.

Typ: JobExecutionSettings Objekt

: Erforderlich Nein

KMSEncryptionContext

Eine Karte von Nur-Text-, nicht geheimen Schlüssel:Wert-Paaren, bekannt als Verschlüsselungskontextpaare, die eine zusätzliche Sicherheitsebene für Ihre Daten bieten.

Type: Zeichenfolge-zu-Zeichenfolge-Zuweisung

Map-Einträge: Die maximale Anzahl beträgt 10 Elemente.

Einschränkungen: Mindestlänge 1. Maximale Länge beträgt 2000.

Schlüssel-Muster: .*\S.*

Beschränkungen für Wertlänge: Mindestlänge 1. Maximale Länge beträgt 2000.

Wert-Pattern:.*\S.*

: Erforderlich Nein

LanguageCode

Der Sprachcode für die Sprache, die in der Eingabemediendatei verwendet wird.

Um Sprache in Modern Standard Arabic (AR-SA) zu transkribieren, muss Ihre Audio- oder Videodatei mit einer Abtastrate von 16.000 Hz oder höher codiert sein.

Type: Zeichenfolge

: Erforderlich Nein

LanguageOptions

Ein Objekt, das eine Liste von Sprachen enthält, die möglicherweise in Ihrer Sammlung von Audiodateien vorhanden sind. Die automatische Sprachenidentifizierung wählt eine Sprache aus, die am besten mit dem Quellaudio aus dieser Liste übereinstimmt.

Um Sprache in Modern Standard Arabic (AR-SA) zu transkribieren, muss Ihre Audio- oder Videodatei mit einer Abtastrate von 16.000 Hz oder höher codiert sein.

Type: Zeichenfolgen-Array

Array-Mitglieder: Die Mindestanzahl beträgt 1 Element.

: Erforderlich Nein

Media

Ein Objekt, das das Eingabemedium für einen Transkriptionsauftrag beschreibt.

Typ: Media Objekt

: Erforderlich Ja

MediaFormat

Das Format der Eingabemediendatei.

Type: Zeichenfolge

Zulässige Werte: mp3 | mp4 | wav | flac | ogg | amr | webm

: Erforderlich Nein

MediaSampleRateHertz

Die Abtastrate der Audiospur in Hertz in der Eingangs-Mediendatei.

Wenn Sie die Abtastrate für Medien nicht angeben, bestimmt Amazon Transcribe die Abtastrate. Wenn Sie die Abtastrate angeben, muss sie mit der von Amazon Transcribe erkannten Abtastrate übereinstimmen. In den meisten Fällen sollten Sie denMediaSampleRateHertzFeld leer und lassen Sie Amazon Transcribe die Abtastrate bestimmen.

Type: Ganzzahl

Gültiger Bereich: Der Mindestwert ist 8000. Maximaler Wert von 48000.

: Erforderlich Nein

ModelSettings

Wählen Sie in diesem Parameter das benutzerdefinierte Sprachmodell aus, das Sie für Ihren Transkriptionsauftrag verwenden.

Typ: ModelSettings Objekt

: Erforderlich Nein

OutputBucketName

Der Ort, an dem die Transkriptionsdaten gespeichert wird.

Wenn Sie dieOutputBucketNameplatziert Amazon Transcribe das Transkribe in den angegebenen S3-Bucket. Wenn du die GetTranscriptionJob -Operation gibt die Operation diesen Speicherort imTranscriptFileUrifield. Wenn Sie die Redaktion von Inhalten aktivieren, wird das redigierte Transkript inRedactedTranscriptFileUriaus. Wenn Sie die Redaktion von Inhalten aktivieren und ein nicht redigiertes Transkript ausgeben möchten, wird der Speicherort dieses Transkripts weiterhin imTranscriptFileUriaus. Der S3-Bucket muss über Berechtigungen verfügen, die es Amazon Transcribe ermöglichen, Dateien in den Bucket zu legen. Weitere Informationen finden Sie unterErforderliche Berechtigungen für IAM-Benutzerrollenaus.

Sie können eineAWSDer Schlüssel des Key Management Service (Key Management Service) zur Verschlüsselung der Ausgabe Ihrer Transkription unter Verwendung derOutputEncryptionKMSKeyId-Parameter. Wenn Sie keinen KMS-Schlüssel angeben, verwendet Amazon Transcribe den standardmäßigen Amazon S3 S3-Schlüssel für die serverseitige Verschlüsselung von Transkripten, die an Ihren S3-Bucket übermittelt werden.

Wenn Sie dasOutputBucketNamegeneriert Amazon Transcribe eine vorsignierte URL, eine teilbare URL, die sicheren Zugriff auf Ihre Transkription ermöglicht, und gibt sie imTranscriptFileUrifield. Verwenden Sie diese URL, um die Transkription herunterzuladen.

Type: Zeichenfolge

Einschränkungen: Höchstlänge = 64 Zeichen.

Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]

: Erforderlich Nein

OutputEncryptionKMSKeyId

Der Amazon-Ressourcenname (ARN) desAWSDer Schlüssel des Key Management Service (Key Management Service), der verwendet wird, um die Ausgabe des Transkriptionsauftrags zu verschlüsseln. Der Benutzer ruftStartTranscriptionJob-Operation muss über die Berechtigung zum Verwenden des angegebenen KMS-Schlüssels verfügen.

Sie können mit einer der folgenden Optionen einen KMS-Schlüssel im aktuellen Konto identifizieren:

KMS-Schlüssel-ID: „1234abcd-12ab-34cd-56ef-1234567890ab“
KMS-Schlüsselalias: „alias/BeispielAlias“

Sie können eine der folgenden Optionen verwenden, um einen KMS-Schlüssel im aktuellen Konto oder einem anderen Konto zu identifizieren:

Amazon-Ressourcenname (ARN) eines KMS-Schlüssels: „arn:aws:kms:region:Konto-ID:key/1234ABCD-12AB-34CD-56ef-1234567890AB“
ARN eines KMS-Schlüsselalias: „arn:aws:kms:Region:alias/BeispielAlias“

Wenn Sie keinen Verschlüsselungsschlüssel angeben, wird die Ausgabe des Transkriptionsauftrags mit dem standardmäßigen Amazon S3-Schlüssel (SSE-S3) verschlüsselt.

Wenn Sie einen KMS-Schlüssel angeben, um Ihre Ausgabe zu verschlüsseln, müssen Sie auch einen Ausgabespeicherort in derOutputBucketName-Parameter.

Type: Zeichenfolge

Einschränkungen: Mindestlänge 1. Maximale Länge beträgt 2048 Zeichen.

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

: Erforderlich Nein

OutputKey

Sie können einen Speicherort in einem Amazon S3 S3-Bucket angeben, um die Ausgabe Ihres Transkriptionsauftrags zu speichern.

Wenn Sie keinen Ausgabeschlüssel angeben, speichert Amazon Transcribe die Ausgabe Ihres Transkriptionsauftrags im von Ihnen angegebenen Amazon S3 S3-Bucket. Standardmäßig ist der Objektschlüssel „your-transcription-job-name.json“.

Sie können Ausgabeschlüssel verwenden, um das Amazon S3-Präfix und den Dateinamen der Transkriptionsausgabe anzugeben. Wenn Sie beispielsweise das Amazon S3-Präfix „folder1/folder2/“ als Ausgabeschlüssel angeben, würde dazu führen, dass die Ausgabe als „ordner1/ordner2/your-transcription-job-name.json“ gespeichert wird. Wenn Sie „meine-other-job-name.json“ als Ausgabeschlüssel angeben, wird der Objektschlüssel in „meine-other-job-name.json“ geändert. Sie können einen Ausgabeschlüssel verwenden, um sowohl das Präfix als auch den Dateinamen zu ändern, zum Beispiel „ordner/meine-andere-job-name.json“.

Wenn Sie einen Ausgabeschlüssel angeben, müssen Sie auch einen S3-Bucket imOutputBucketName-Parameter.

Type: Zeichenfolge

Einschränkungen: Mindestlänge 1. Maximale Länge beträgt 1024 Zeichen.

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

: Erforderlich Nein

Settings

ASettings-Objekt, das optionale Einstellungen für einen Transkriptionsauftrag bereitstellt.

Typ: Settings Objekt

: Erforderlich Nein

Subtitles

Fügen Sie Ihrem Batch-Transkriptionsauftrag Untertitel hinzu.

Typ: Subtitles Objekt

: Erforderlich Nein

Tags

Fügen Sie einem Amazon Transcribe-Transkriptionsauftrag Tags hinzu.

Type: Array von Tag &S3;-Buckets

Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Die maximale Anzahl beträgt 200 Elemente.

: Erforderlich Nein

TranscriptionJobName

Der Name des Auftrags. Sie können die Strings nicht verwenden“.„oder“..„Name der Aufgabe. Der Name muss darüber hinaus innerhalb einer eindeutig seinAWSKonto. Wenn Sie versuchen, einen Transkriptionsauftrag mit dem gleichen Namen wie ein vorheriger Transkriptionsjob zu erstellen, erhalten Sie einenConflictExceptionFehler.

Type: Zeichenfolge

Einschränkungen: Mindestlänge 1. Höchstlänge = 200 Zeichen.

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

: Erforderlich Ja

Antwortsyntax


{
   "TranscriptionJob": { 
      "CompletionTime": number,
      "ContentRedaction": { 
         "RedactionOutput": "string",
         "RedactionType": "string"
      },
      "CreationTime": number,
      "FailureReason": "string",
      "IdentifiedLanguageScore": number,
      "IdentifyLanguage": boolean,
      "JobExecutionSettings": { 
         "AllowDeferredExecution": boolean,
         "DataAccessRoleArn": "string"
      },
      "LanguageCode": "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" ],
         "SubtitleFileUris": [ "string" ]
      },
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "Transcript": { 
         "RedactedTranscriptFileUri": "string",
         "TranscriptFileUri": "string"
      },
      "TranscriptionJobName": "string",
      "TranscriptionJobStatus": "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.

TranscriptionJob

Ein Objekt, das Details des asynchronen Transkriptionsauftrags enthält.

Typ: TranscriptionJob Objekt

Errors

Informationen zu den Fehlern, die allen Aktionen gemeinsam sind, finden Sie unterHäufige Fehleraus.

BadRequestException

Ihre Anfrage hat einen oder mehrere Validierungstests nicht bestanden. Zum Beispiel, wenn die Entität, die Sie löschen möchten, nicht existiert oder wenn sie sich in einem nicht terminalen Zustand befindet (z. B. Siehe die AusnahmeMessagefür weitere Informationen.

HTTP-Statuscode: 400

ConflictException

Es gibt bereits eine Ressource mit diesem Namen.

HTTP-Statuscode: 400

InternalFailureException

Es ist ein interner Fehler aufgetreten. Überprüfen Sie die Fehlermeldung und versuchen Sie es erneut.

HTTP-Statuscode: 500

LimitExceededException

Entweder haben Sie zu viele Anfragen gesendet oder Ihre Eingabedatei ist zu lang. Warten Sie, bevor Sie Ihre Anfrage erneut senden, oder verwenden Sie eine kleinere Datei und senden Sie die Anfrage erneut.

HTTP-Statuscode: 400

Weitere Informationen finden Sie auch unter:

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

Warnung JavaScript ist in Ihrem Browser nicht verfügbar oder deaktiviert.

Zur Nutzung der AWS-Dokumentation muss JavaScript aktiviert sein. Weitere Informationen finden auf den Hilfe-Seiten Ihres Browsers.

Dokumentkonventionen

StartMedicalTranscriptionJob

TagResource