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

StartMedicalTranscriptionJob

医療ディクテーションや会話の音声を書き起こし、リクエストに含めることを選択した追加のリクエストパラメータを適用します。

Amazon Transcribe Medical では、多くの標準的な文字起こし機能に加えて、充実した医学用語や、オプションで個人の健康情報 (PHI) にフラグを追加するコンテンツ識別機能も用意されています。これらの機能の詳細については、「Amazon Transcribe Medical の仕組み」を参照してください。

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

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

region:AWS リージョンリクエストを送信している場所。Amazon TranscribeAWS リージョンでサポートされているリストについては、「Amazon Transcribe のエンドポイントとクォータ」を参照してください。
MedicalTranscriptionJobName: 文字起こしジョブ用に作成する、社内独自のカスタム名AWS アカウント。
Media(MediaFileUri): メディアファイルの Amazon S3 の場所。
LanguageCode:en-US これはそうに違いありません。
OutputBucketName: トランスクリプトを保存する Amazon S3 バケット。出力をこのバケットのサブフォルダーに保存する場合は、含める必要もありますOutputKey。
Specialty:PRIMARYCARE これはそうに違いありません。
Type: 音声を会話かディクテーションかを選択します。

リクエストの構文


{
   "ContentIdentificationType": "string",
   "KMSEncryptionContext": { 
      "string" : "string" 
   },
   "LanguageCode": "string",
   "Media": { 
      "MediaFileUri": "string",
      "RedactedMediaFileUri": "string"
   },
   "MediaFormat": "string",
   "MediaSampleRateHertz": number,
   "MedicalTranscriptionJobName": "string",
   "OutputBucketName": "string",
   "OutputEncryptionKMSKeyId": "string",
   "OutputKey": "string",
   "Settings": { 
      "ChannelIdentification": boolean,
      "MaxAlternatives": number,
      "MaxSpeakerLabels": number,
      "ShowAlternatives": boolean,
      "ShowSpeakerLabels": boolean,
      "VocabularyName": "string"
   },
   "Specialty": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Type": "string"
}

リクエストパラメータ

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

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

ContentIdentificationType

トランスクリプトで特定されたすべての個人の健康情報 (PHI) にラベル付けします。詳細については例外の処理を参照してください。

タイプ: 文字列

有効な値: PHI

必須: いいえ

KMSEncryptionContext

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

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

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

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

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

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

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

必須: いいえ

LanguageCode

入力メディアファイルで話されている言語を表す言語を表す言語を表す言語コード。米国英語 (en-US) は、医療文字起こしジョブの唯一の値です。言語コードに他の値を入力すると、BadRequestException エラーになります。

タイプ: 文字列

必須: はい

Media

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

サポートされているメディアフォーマットの詳細については、Amazon S3 MediaFormat開発者ガイドのパラメータまたは「メディアフォーマット」セクションを参照してください。

型: Media オブジェクト

必須: はい

MediaFormat

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

タイプ: 文字列

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

必須: いいえ

MediaSampleRateHertz

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

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

型: 整数

値の範囲:最小値は 16000 です。48,000 の最大値。

必須: いいえ

MedicalTranscriptionJobName

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

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

タイプ: 文字列

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

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

必須: はい

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 Management Console。IAM ユーザーロールに必要な権限も参照してください。

タイプ: 文字列

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

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

必須: はい

OutputEncryptionKMSKeyId

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

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

KMS キー ID 自体を使用してください。例えば、1234abcd-12ab-34cd-56ef-1234567890ab。
KMS キー ID にはエイリアスを使用してください。例えば、alias/ExampleAlias。
KMS キー ID には Amazon リソースネーム (ARN) を使用してください。例えば、arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab。
KMS キーエイリアスには ARN を使用してください。例えば、arn:aws:kms:region:account-ID:alias/ExampleAlias。

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

KMS キー ID には ARN を使用してください。例えば、arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab。
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と組み合わせて使用して、トランスクリプトの出力場所を指定し、オプションで出力ファイルの一意の名前を指定します。トランスクリプション出力のデフォルト名は、医療トランスクリプションジョブ (MedicalTranscriptionJobName) に指定した名前と同じです。

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

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

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

型: MedicalTranscriptionSetting オブジェクト

必須: いいえ

Specialty

メディアで取り上げられている主な医療専門分野を明記してください。バッチ転記の場合、PRIMARYCAREが唯一の有効な値です。その他の専門分野が必要な場合は、を参照してくださいStartMedicalStreamTranscription。

タイプ: 文字列

有効な値: PRIMARYCARE

必須: はい

Tags

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

Amazon Transcribe でタグを使用する方法の詳細については例外のタグを参照してください。

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

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

必須: いいえ

Type

入力メディアに 1 人だけを含めるか (DICTATION)、2 人の会話を含むか (CONVERSATION) を指定します。

たとえば、DICTATION医療従事者がボイスメモを書き起こしたい場合や、患者の診察中の医師と患者の会話を書き写すために使用できます。CONVERSATION

タイプ: 文字列

有効な値: CONVERSATION | DICTATION

必須: はい

レスポンスの構文


{
   "MedicalTranscriptionJob": { 
      "CompletionTime": number,
      "ContentIdentificationType": "string",
      "CreationTime": number,
      "FailureReason": "string",
      "LanguageCode": "string",
      "Media": { 
         "MediaFileUri": "string",
         "RedactedMediaFileUri": "string"
      },
      "MediaFormat": "string",
      "MediaSampleRateHertz": number,
      "MedicalTranscriptionJobName": "string",
      "Settings": { 
         "ChannelIdentification": boolean,
         "MaxAlternatives": number,
         "MaxSpeakerLabels": number,
         "ShowAlternatives": boolean,
         "ShowSpeakerLabels": boolean,
         "VocabularyName": "string"
      },
      "Specialty": "string",
      "StartTime": number,
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "Transcript": { 
         "TranscriptFileUri": "string"
      },
      "TranscriptionJobStatus": "string",
      "Type": "string"
   }
}

レスポンス要素

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

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

MedicalTranscriptionJob

現在の医療記録の仕事について、仕事の状況や、該当する場合は失敗の理由など、詳細な情報を提供します。

型: MedicalTranscriptionJob オブジェクト

エラー

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

BadRequestException

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

HTTP ステータスコード: 400

ConflictException

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

HTTP ステータスコード: 400

InternalFailureException

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

HTTP ステータスコード: 500

LimitExceededException

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

HTTP ステータスコード: 400

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

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

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

StartCallAnalyticsJob

StartTranscriptionJob