StartMedicalTranscriptionJob

轉錄醫療聽寫或對話中的音頻，並應用您選擇包含在請求中的任何其他請求參數。

除了許多標準轉錄功能之外，Amazon Transcribe Medical 還為您提供健全的醫學詞彙和可選的內容識別功能，為個人健康資訊 (PHI) 新增標誌。要了解有關這些功能的更多信息，請參閱 Amazon Transcribe 醫療如何工作。

若StartMedicalTranscriptionJob要提出請求，您必須先將媒體檔案上傳到 Amazon S3 儲存貯體；然後您可以使用Media參數指定檔案的 S3 位置。

您必須在StartMedicalTranscriptionJob要求中包含下列參數：

region：您提出請求的位AWS 區域置。如需 Amazon 轉錄AWS 區域支援的清單，請參閱 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）。

類型：String

有效值： PHI

必要：否

KMSEncryptionContext

純文字、非秘密金鑰:值配對 (稱為加密內容配對) 的對映，可為您的資料提供額外的安全層。如需詳細資訊，請參閱中的 AWS KMS加密內容和非對稱金鑰AWS KMS。

類型：字串到字串映射

映射項目：最多 10 個項目。

索引鍵長度限制：長度下限為 1。長度上限為 2000。

金鑰模式：.*\S.*

值長度限制：長度下限為 1。長度上限為 2000。

值模式：.*\S.*

必要：否

LanguageCode

代表輸入媒體檔案中所使用語言的語言代碼。美國英語 (en-US) 是醫療轉錄工作的唯一有效值。您為語言代碼輸入的任何其他值都會導致BadRequestException錯誤。

類型：String

必要：是

Media

描述您要在請求中使用之媒體檔案的 Amazon S3 位置。

如需支援媒體格式的相關資訊，請MediaFormat參閱 Amazon S3 開發人員指南中的參數或媒體格式一節。

類型：Media 物件

必要：是

MediaFormat

指定輸入媒體檔案的格式。

類型：String

有效值： mp3 | mp4 | wav | flac | ogg | amr | webm

必要：否

MediaSampleRateHertz

輸入媒體檔案中音軌的取樣率 (以赫茲為單位)。

如果您沒有指定媒體取樣率，Amazon Transcribe 醫療會為您確定。如果您指定取樣率，它必須與 Amazon Transcribe Medical 偵測到的速率相符；如果您指定的值與偵測到的值不相符，則您的任務會失敗。因此，在大多數情況下，建議省略MediaSampleRateHertz並讓 Amazon Transcribe 醫療確定採樣率。

類型：整數

有效範圍：最小值為 16000。最大值上限為 48。

必要：否

MedicalTranscriptionJobName

一個由您選擇的唯一名稱，用於您的醫療轉錄工作。您指定的名稱也會用作轉錄輸出檔案的預設名稱。如果要為轉錄輸出指定不同的名稱，請使用OutputKey參數。

此名稱區分大小寫，不能包含空格，且在AWS 帳戶. 如果您嘗試建立與現有工作相同名稱的新工作，就會收到ConflictException錯誤訊息。

類型：String

長度限制：長度下限為 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/，請OutputBucketName將設置OutputKey為DOC-EXAMPLE-BUCKET和test-files/。

請注意，Amazon 轉錄檔必須得到許可才能使用指定的位置。您可以使用變更 Amazon S3 許可AWS Management Console。另請參閱 IAM 使用者角色所需的許可。

類型：String

長度上限為 64。

模式：[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]

必要：是

OutputEncryptionKMSKeyId

您想要用來加密醫療轉錄輸出的 KMS 金鑰。

如果使用位於目前的金鑰AWS 帳戶，您可以使用下列四種方式之一來指定 KMS 金鑰：

使用 KMS 金鑰識別碼本身。例如：1234abcd-12ab-34cd-56ef-1234567890ab。
使用 KMS 金鑰 ID 的別名。例如：alias/ExampleAlias。
使用 Amazon Resource Name (ARN) 作為 KMS 金鑰 ID。例如：arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab。
使用 ARN 作為 KMS 金鑰別名。例如：arn:aws:kms:region:account-ID:alias/ExampleAlias。

如果使用與目前金鑰AWS 帳戶不同的金鑰AWS 帳戶，您可以使用下列其中一種方式指定 KMS 金鑰：

使用 ARN 做為 KMS 金鑰識別碼。例如：arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab。
使用 ARN 作為 KMS 金鑰別名。例如：arn:aws:kms:region:account-ID:alias/ExampleAlias。

如果您沒有指定加密金鑰，您的輸出會使用預設 Amazon S3 key (SSE-S3) (Amazon S3 金鑰 () () (Amazon S3 金鑰 ())

如果您指定 KMS 金鑰來加密輸出，則還必須使用OutputLocation參數指定輸出位置。

請注意，發出StartCallAnalyticsJob請求的角色必須得到許可才能使用指定的 KMS 金鑰。

類型：String

長度限制：長度下限為 1。長度上限為 2048。

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

必要：否

OutputKey

搭配使用可指OutputBucketName定成績單的輸出位置，並指定輸出檔案的唯一名稱 (選擇性)。轉錄輸出的預設名稱與您為醫療轉錄工作指定的名稱相同 (MedicalTranscriptionJobName)。

以下是一些如何使用的範例OutputKey：

如果您將「文檔示例桶」指定為OutputBucketName和「我的轉錄 .json」作為OutputKey，則轉錄輸出路徑為s3://DOC-EXAMPLE-BUCKET/my-transcript.json。
如果您指定my-first-transcription '' 作為MedicalTranscriptionJobName, 'DOC/EXAMPLE-BULL' 作為OutputBucketName, 和 '我的轉錄' 作為OutputKey, 您的轉錄輸出路徑是s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
如果將「文檔示例桶」指定為OutputBucketName和「測試文件/我的轉錄 .json」作為OutputKey，則轉錄輸出路徑為s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json。
如果您指定 'my-first-transcription' 作為MedicalTranscriptionJobName, 'DOC/EXAMPLE-BULL' 作為OutputBucketName, 和 '測試文件/我的謄本' 作為OutputKey, 您的轉錄輸出路徑是s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.

如果您指定的 Amazon S3 儲存貯體子資料夾名稱不存在，系統會為您建立一個子資料夾。

類型：String

長度限制：長度下限為 1。長度上限為 1024。

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

必要：否

Settings

在您的StartMedicalTranscriptionJob要求中指定其他選擇性設定，包括頻道識別、替代轉錄和喇叭分割。您可以使用它將自定義詞彙應用於轉錄工作。

類型：MedicalTranscriptionSetting 物件

必要：否

Specialty

指定媒體中所代表的主要醫療專業。對於批次轉錄，PRIMARYCARE是唯一有效的值。如果您需要其他專業，請參閱StartMedicalStreamTranscription。

類型：String

有效值： PRIMARYCARE

必要：是

Tags

在您開始這項新工作時，將一或多個自訂標籤 (每個標籤都以 key: value 組的形式) 新增至新的醫療轉錄工作。

若要進一步了解有關 Amazon Transcribe cryption 標籤的詳細資訊，請參閱標記資源。

類型：Tag 物件陣列

陣列成員：項目數下限為 1。項目數上限為 200。

必要：否

Type

指定您的輸入媒體是僅包含一個人 (DICTATION) 還是包含兩個人之間的對話 (CONVERSATION)。

例如，DICTATION可用於希望轉錄語音備忘錄的醫療專業人員；CONVERSATION可用於在患者辦公室就診期間轉錄醫生與患者的對話。

類型：String

有效值： 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

您的要求未通過一或多個驗證測試。當您嘗試刪除的實體不存在或處於非終端狀態（例如IN PROGRESS）時，可能會發生這種情況。如需詳細資訊，請參閱例外訊息欄位。

HTTP 狀態碼：400

ConflictException

具有此名稱的資源已存在。資源名稱在一內必須是獨一無二的AWS 帳戶。

HTTP 狀態碼：400

InternalFailureException

發生內部錯誤。檢查錯誤訊息，更正問題，然後再試一次您的要求。

HTTP 狀態碼：500

LimitExceededException

您可能傳送太多要求，或輸入檔案太長。請先等候再重試您的要求，或使用較小的檔案再試一次。

HTTP 狀態碼：400

另請參閱

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

StartCallAnalyticsJob

StartTranscriptionJob