StartTranscriptionJob - Transcribe
リクエストの構文リクエストパラメータレスポンスの構文レスポンス要素エラー以下の資料も参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

StartTranscriptionJob

メディアファイルからオーディオをトランスクリプションし、リクエストに含めることを選択した追加のリクエストパラメータを適用します。

StartTranscriptionJobリクエストを行うには、まずメディアファイルを Amazon S3 バケットにアップロードする必要があります。次に、Mediaパラメータを使用してファイルの Amazon S3 ロケーションを指定できます。

StartTranscriptionJobリクエストには次のパラメータが含まれます。

  • region:AWS リージョン リクエストを送信している場所。Amazon TranscribeAWS リージョン でサポートされているリストについては、「Amazon Transcribe エンドポイントとクォータ」を参照してください。

  • TranscriptionJobName: 文字起こしジョブ用に作成する、社内独自のカスタム名AWS アカウント。

  • Media(MediaFileUri): メディアファイルの Amazon S3 の場所。

  • LanguageCode、IdentifyLanguage、またはのいずれかIdentifyMultipleLanguages:メディアファイルの言語がわかっている場合は、LanguageCodeパラメータを使用して指定してください。有効な言語コードはすべて「サポートされる言語」の表で確認できます。メディアで話されている言語がわからない場合はIdentifyMultipleLanguages、IdentifyLanguageまたはを使用して Amazon Transcribe に言語を特定させてください。

リクエストの構文

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

リクエストパラメータ

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

リクエストは以下の JSON 形式のデータを受け入れます。

ContentRedaction

トランスクリプト内の特定の個人識別情報 (PII) を編集またはフラグ付けすることができます。を使用する場合はContentRedaction、、、などのサブパラメータも含める必要がありますRedactionType。PiiEntityTypesRedactionOutput

型: ContentRedaction オブジェクト

必須: いいえ

IdentifyLanguage

文字起こしジョブのリクエストで自動言語識別を有効にします。メディアファイルに 1 つの言語しか含まれていない場合は、このパラメータを使用してください。メディアに複数の言語が含まれている場合は、IdentifyMultipleLanguages代わりに使用してください。

含める場合はIdentifyLanguage、オプションで、メディアファイルにあると思われる言語コードのリストをLanguageOptions、を使用して含めることができます。IdentifyLanguage含めると、LanguageOptions指定した言語オプションのみに制限され、文字起こしの精度が向上します。

カスタム言語モデル、カスタムボキャブラリー、またはカスタムボキャブラリーフィルターを自動言語識別リクエストに適用する場合は、関連するサブパラメーター (VocabularyName、LanguageModelName、およびVocabularyFilterName) を含めてくださいLanguageIdSettings。含める場合はLanguageIdSettings、それも含めてくださいLanguageOptions。

リクエストにはLanguageCode、、IdentifyLanguage、IdentifyMultipleLanguagesのいずれかを含める必要があることに注意してください。これらのパラメータを複数含めると、文字起こしジョブは失敗します。

型: ブール

必須: いいえ

IdentifyMultipleLanguages

文字起こしジョブのリクエストで自動多言語識別を有効にします。メディアファイルに複数の言語が含まれている場合は、このパラメータを使用してください。メディアに1つの言語しか含まれていない場合は、IdentifyLanguage代わりに使用してください。

含める場合はIdentifyMultipleLanguages、オプションで、メディアファイルにあると思われる言語コードのリストをLanguageOptions、を使用して含めることができます。IdentifyLanguage含めると、LanguageOptions指定した言語オプションのみに制限され、文字起こしの精度が向上します。

自動言語識別リクエストにカスタムボキャブラリーまたはカスタムボキャブラリーフィルターを適用する場合は、関連するサブパラメーター (VocabularyNameとVocabularyFilterName) を含めてくださいLanguageIdSettings。含める場合はLanguageIdSettings、それも含めてくださいLanguageOptions。

リクエストにはLanguageCode、、IdentifyLanguage、IdentifyMultipleLanguagesのいずれかを含める必要があることに注意してください。これらのパラメータを複数含めると、文字起こしジョブは失敗します。

型: ブール

必須: いいえ

JobExecutionSettings

トランスクリプションジョブの処理方法を制御できます。現在、JobExecutionSettings選択できる唯一の変更は、AllowDeferredExecutionサブパラメータを使用してジョブキューを有効にすることです。

JobExecutionSettingsリクエストに含める場合は、サブパラメータ (と) も含める必要がありますDataAccessRoleArn。AllowDeferredExecution

型: JobExecutionSettings オブジェクト

必須: いいえ

KMSEncryptionContext

暗号化コンテキストペアとして知られる、プレーンテキスト、非機密キー:値ペアのマップで、データのセキュリティを強化します。詳細については、の「AWS KMS暗号化コンテキスト」と「非対称キー」を参照してくださいAWS KMS。

型: 文字列間のマッピング

マップエントリ: 項目の最大数は 10 です。

キーの長さ制限: 最小長さは 1 です。最大長は 2,000 です。

キーパターン: .*\S.*

値の長さの制限: 最小長は 1。最大長は 2,000 です。

値のパターン: .*\S.*

必須: いいえ

LanguageCode

入力メディアファイルで話されている言語を表す言語を表す言語コード。

メディアファイルで話されている言語が不明な場合は、IdentifyLanguageIdentifyMultipleLanguagesまたはを使用して自動言語識別を有効にすることを検討してください。

リクエストにはLanguageCode、、IdentifyLanguage、IdentifyMultipleLanguagesのいずれかを含める必要があることに注意してください。これらのパラメータを複数含めると、文字起こしジョブは失敗します。

サポートされる言語とそれに関連する言語コードのリストについては、「サポートされる言語」の表を参照してください。

注記

モダンスタンダードアラビア語 (ar-SA) で音声を文字起こしするには、メディアファイルを 16,000 Hz 以上のサンプルレートでエンコードする必要があります。

タイプ: 文字列

有効な値: af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ | vi-VN | sv-SE

必須: いいえ

LanguageIdSettings

リクエストで自動言語識別を使用していて、カスタム言語モデル、カスタムボキャブラリー、またはカスタムボキャブラリーフィルターを適用する場合は、関連するサブパラメーター (VocabularyName、LanguageModelName、およびVocabularyFilterName) を含めてくださいLanguageIdSettings。多言語識別 (IdentifyMultipleLanguages) はカスタム言語モデルをサポートしていないことに注意してください。

LanguageIdSettings2 つから 5 つの言語コードをサポートします。含める各言語コードには、カスタム言語モデル、カスタムボキャブラリ、カスタムボキャブラリフィルタを関連付けることができます。指定する言語コードは、関連するカスタム言語モデル、カスタムボキャブラリ、およびカスタムボキャブラリフィルターの言語と一致する必要があります。

LanguageOptions使用するときには、正しい言語の方言が識別されるように、LanguageIdSettings含めることをおすすめします。たとえば、あるカスタムボキャブラリーを指定しても、Amazon Transcribe がメディアで話されている言語がそれであると判断した場合en-AU、カスタムボキャブラリーはトランスクリプションには適用されません。en-USLanguageOptionsen-US英語の方言だけを含めて含めると、カスタムボキャブラリーが文字起こしに適用されます。

リクエストにカスタム言語モデルを含めたいが、自動言語識別は使いたくない場合は、 ModelSettings LanguageModelName代わりにサブパラメータ付きのパラメータを使用してください。リクエストにカスタムボキャブラリまたはカスタムボキャブラリフィルタ (あるいはその両方) を含めたいが、自動言語識別を使いたくない場合は、 Settings 代わりにパラメータとVocabularyName orVocabularyFilterName (または両方) サブパラメータを使用してください。

タイプ: LanguageIdSettings オブジェクトマップへの文字列です。

マップエントリー: 5 つの項目の最大数。

有効なキー: af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ | vi-VN | sv-SE

必須: いいえ

LanguageOptions

メディアに表示されていると思われる言語を表す言語コードを 2 つ以上指定できます。5 つ以上含めることはお勧めしません。どの言語が使用されているかわからない場合は、このパラメーターを含めないでください。

LanguageOptionsリクエストに含める場合は、それも含める必要がありますIdentifyLanguage。

詳細については、「サポートされる言語」を参照してください。

モダンスタンダードアラビア語 (ar-SA) で音声を文字起こしするには、メディアファイルを 16,000 Hz 以上のサンプルレートでエンコードする必要があります。

型: 文字列の配列

配列メンバー: 最小数は 1 項目です。

有効な値: af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ | vi-VN | sv-SE

必須: いいえ

Media

リクエストで使用するメディアファイルの Amazon S3 の場所について説明します。

型: Media オブジェクト

必須: はい

MediaFormat

入力メディアファイルの形式を指定します。

タイプ: 文字列

有効な値: mp3 | mp4 | wav | flac | ogg | amr | webm

必須: いいえ

MediaSampleRateHertz

入力メディアファイル内のオーディオトラックのサンプルレート (単位:ヘルツ)。

メディアのサンプルレートを指定しない場合、Amazon Transcribe がそれを判断します。サンプルレートを指定する場合は、Amazon Transcribe で検出されたレートと一致させる必要があります。指定した値と検出された値が一致しない場合、ジョブは失敗します。ほとんどの場合、Amazon TranscribeMediaSampleRateHertz にサンプルレートを決定させてください。

型: 整数

有効範囲: 最小値 は 8,000 です。48,000 の最大値。

必須: いいえ

ModelSettings

文字起こしジョブに含めるカスタム言語モデルを指定します。ModelSettingsリクエストに含める場合は、LanguageModelNameサブパラメータを含める必要があります。

詳細については、「カスタム言語モデル」を参照してください。

型: ModelSettings オブジェクト

必須: いいえ

OutputBucketName

文字起こし出力を保存する Amazon S3 バケットの名前です。S3://指定したバケットのプレフィックスを含めないでください。

出力をこのバケットのサブフォルダーに移動させたい場合は、OutputKeyパラメーターを使用して指定します。OutputBucketName使用できるのはバケットの名前のみです。

たとえば、出力をに保存する場合はS3://DOC-EXAMPLE-BUCKET、OutputBucketNameに設定しますDOC-EXAMPLE-BUCKET。ただし、出力をに保存する場合はS3://DOC-EXAMPLE-BUCKET/test-files/、OutputBucketNameDOC-EXAMPLE-BUCKETOutputKeyとに設定しますtest-files/。

Amazon Transcribe には、指定したロケーションを使用する許可を持っている必要があることに注意してください。Amazon S3 のアクセス権限は、を使用して変更できますAWS マネジメントコンソール。IAM ユーザーロールに必要な権限も参照してください。

指定しない場合OutputBucketName、トランスクリプトはサービス管理の Amazon S3 バケットに格納され、トランスクリプトにアクセスするための URI が提供されます。

タイプ: 文字列

長さの制限: 最大長は 64 です。

パターン: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]

必須: いいえ

OutputEncryptionKMSKeyId

文字起こし出力を暗号化するために使用する KMS キー。

現在のキーを使用する場合はAWS アカウント、次の 4 つの方法のいずれかで KMS キーを指定できます。

  1. KMS キー ID 自体を使用してください。例えば、1234abcd-12ab-34cd-56ef-1234567890ab。

  2. KMS キー ID にはエイリアスを使用します。例えば、alias/ExampleAlias。

  3. KMS キー ID には、Amazon リソースネーム (ARN) を使用します。例えば、arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab。

  4. KMS キーエイリアスには ARN を使用してください。例えば、arn:aws:kms:region:account-ID:alias/ExampleAlias。

AWS アカウント現在のキーとは異なるキーを使用する場合はAWS アカウント、次の 2 つの方法のいずれかで KMS キーを指定できます。

  1. KMS キー ID には ARN を使用してください。例えば、arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab。

  2. KMS キーエイリアスには ARN を使用してください。例えば、arn:aws:kms:region:account-ID:alias/ExampleAlias。

暗号化キーを指定しない場合、出力はデフォルトの Amazon S3 キー (SSE-S3) で暗号化されます。

KMS キーを指定して出力を暗号化する場合は、OutputLocationパラメータを使用して出力場所も指定する必要があります。

StartCallAnalyticsJobリクエストを行うロールには、指定された KMS キーを使用する許可を持っている必要があることに注意してください。

タイプ: 文字列

長さの制限: 最小長は 1 です。最大長は 2,048 です。

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

必須: いいえ

OutputKey

OutputBucketNameと組み合わせて使用して、トランスクリプトの出力場所を指定し、オプションで出力ファイルの一意の名前を指定します。文字起こし出力のデフォルト名は、文字起こしジョブに指定した名前と同じです (TranscriptionJobName)。

使用方法の例をいくつか以下に示しますOutputKey。

  • として「DOC-EXAMPLE-BUCKET」OutputBucketName を指定し、として「my-transcript.json」を指定した場合OutputKey、s3://DOC-EXAMPLE-BUCKET/my-transcript.jsonトランスクリプション出力パスはになります。

  • として ''TranscriptionJobName、my-first-transcriptionを 'DOC-EXAMPLE-BUCKET'OutputBucketName、として 'my-transcript' を指定するとOutputKey、s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json文字起こしの出力パスはになります。

  • として「DOC-EXAMPLE-BUCKET」OutputBucketName を指定し、として「test-files/my-transcript.json」を指定した場合OutputKey、s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.jsonトランスクリプション出力パスはになります。

  • として ''TranscriptionJobName、my-first-transcriptionを 'DOC-EXAMPLE-BUCKET'OutputBucketName、として 'test-files/my-transcript' を指定するとOutputKey、s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json文字起こしの出力パスはになります。

存在しない Amazon S3 バケットサブフォルダの名前を指定すると、自動的に作成されます。

タイプ: 文字列

長さの制限: 最小長は 1 です。最大長は 1,024 です。

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

必須: いいえ

Settings

StartTranscriptionJobリクエストには、チャンネル識別、代替トランスクリプション、スピーカーパーティショニングなど、その他のオプション設定を指定してください。これを使用して、カスタムボキャブラリと語彙フィルターを適用できます。

リクエストにカスタムボキャブラリまたはカスタムボキャブラリフィルタ (あるいはその両方) を含めたいが、自動言語識別は使いたくない場合は、VocabularyName orVocabularyFilterName (あるいはその両方) サブパラメータを使用してくださいSettings。

リクエストで自動言語識別を使用していて、カスタム言語モデル、カスタムボキャブラリー、またはカスタムボキャブラリーフィルターを含めたい場合は、 LanguageIdSettings VocabularyNameVocabularyFilterName代わりにパラメーターをまたはサブパラメーターとともに使用してください。LanguageModelName

型: Settings オブジェクト

必須: いいえ

Subtitles

入力メディア用の字幕ファイルを作成します。WebVTT (*.vtt) および SubRip (*.srt) 形式を指定できます。

型: Subtitles オブジェクト

必須: いいえ

Tags

この新しいジョブの開始時に、キーと値のペア形式で 1 つ以上のカスタムタグを新しい文字起こしジョブに追加します。

Amazon Transcribe でタグを使用する方法については、タグ付けを参照してください。

型: Tag オブジェクトの配列

配列メンバー: 最小数は 1 項目です。最大 200 項目。

必須: いいえ

TranscriptionJobName

文字起こし作業用に自分で選んだユニークな名前。指定した名前は、文字起こし出力ファイルのデフォルト名としても使用されます。文字起こし出力に別の名前を指定する場合は、OutputKeyパラメータを使用してください。

この名前は大文字と小文字が区別され、スペースを含めることはできません。また、内では一意でなければなりませんAWS アカウント。既存のジョブと同じ名前で新しいジョブを作成しようとすると、ConflictExceptionエラーが発生します。

タイプ: 文字列

長さの制限: 最小長は 1 です。最大長は 200 です。

パターン: ^[0-9a-zA-Z._-]+

必須: はい

レスポンスの構文

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

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

TranscriptionJob

ジョブのステータス、該当する場合は失敗の理由など、現在の文字起こしジョブに関する詳細情報を提供します。

型: TranscriptionJob オブジェクト

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

BadRequestException

リクエストは 1 つ以上の検証テストに合格しませんでした。これは、削除しようとしているエンティティが存在しない場合、または非終端状態 (例:IN PROGRESS) の場合に発生する可能性があります。詳細については、例外の詳細については、Message フィールドを参照してください。

HTTP ステータスコード: 400

ConflictException

この名前のリソースは既に存在します。リソース名は内で固有である必要がありますAWS アカウント。

HTTP ステータスコード: 400

InternalFailureException

インターナルエラーが発生しました。エラーメッセージを確認して、問題を修正して、リクエストを再度試みてください。

HTTP ステータスコード: 500

LimitExceededException

送信されたリクエストが多すぎるか、または入力ファイルが長すぎます。リクエストを再度試みるか、または小さいファイルを使用してリクエストを再度試みてください。

HTTP ステータスコード: 400

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。