本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
StartMedicalTranscriptionJob
启动批处理作业以将医学语音转录为文本。
请求语法
{
"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
-
您可以将 Amazon Transcribe Medical 配置为在转录输出中为内容添加标签。如果你指定
PHI
,Amazon Transcribe Medical 会标记它在转录输出中识别的个人健康信息 (PHI)。类型: 字符串
有效值:
PHI
必填项:否
- KMSEncryptionContext
-
纯文本、非秘密密钥:值对(称为加密上下文对)的映射,为您的数据提供了额外的安全层。
类型: 字符串到字符串映射
地图条目:最多 10 项。
密钥长度约束:最小长度为 1。长度上限为 2000。
密钥模式:
.*\S.*
值长度约束:最小长度为 1。长度上限为 2000。
价值模式:
.*\S.*
必填项:否
- LanguageCode
-
媒体输入文件中使用的语言代码。美国英语 (en-US) 是医疗转录作业的有效值。您为语言代码输入的任何其他值都会生成
BadRequestException
错误消息。类型: 字符串
有效值:
af-ZA | ar-AE | ar-SA | cy-GB | 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 | ga-IE | gd-GB | 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
必填项:是
- Media
-
描述在转录请求中媒体文件。
类型:Media 对象
必填项:是
- MediaFormat
-
输入媒体输入文件的音频格式。
类型: 字符串
有效值:
mp3 | mp4 | wav | flac | ogg | amr | webm
必填项:否
- MediaSampleRateHertz
-
该示例(单位:赫兹)为输入媒体文件的音频。
如果您没有指定媒体采样率,Amazon Transcribe Medical 将确定采样率。如果您指定了采样率,则必须与 Amazon Transcribe Medical 检测到的速率匹配。在大多数情况下,您应该将
MediaSampleRateHertz
字段为空,然后让 Amazon Transcribe Medical 确定采样率。类型: 整数
有效范围:最小值为 16000。最大值为 48000。
必填项:否
- MedicalTranscriptionJobName
-
医疗转录作业的名称。你不能使用字符串”
.
“或者”..
“自己作为作业名称。名称还必须在Amazonaccount. 如果你尝试创建一个与之前的医疗转录作业同名的医学转录作业,你会得到ConflictException
错误消息。类型: 字符串
长度约束:最小长度为 1。最大长度为 200。
模式:
^[0-9a-zA-Z._-]+
必填项:是
- OutputBucketName
-
转录存储在 Amazon S3 位置。
你必须设置
OutputBucketName
对于 Amazon Transcribe Medical 来存储转录结果。您的成绩单将显示在您指定的 S3 位置。当你打电话给GetMedicalTranscriptionJob,操作将返回该位置TranscriptFileUri
字段中返回的子位置类型。S3 存储桶必须具有允许 Amazon Transcribe Medical 将文件放入存储桶的权限。有关更多信息,请参阅 。IAM 用户角色所需的权限.您可以指定Amazon密钥管理服务 (KMS) 密钥,用于使用
OutputEncryptionKMSKeyId
参数。如果未指定 KMS 密钥,Amazon Transcribe Medical 将使用默认 Amazon S3 密钥对 S3 存储桶中放置的脚本进行服务器端加密。类型: 字符串
长度约束:最大长度为 64。
模式:
[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]
必填项:是
- OutputEncryptionKMSKeyId
-
的 Amazon 资源名称 (ARN)Amazon密钥管理服务 (KMS) 密钥用于加密转录作业的输出。用户调用StartMedicalTranscriptionJob操作必须具有使用指定 KMS 密钥的权限。
您可以使用以下任意方法来标识当前账户中的 KMS 密钥:
-
KMS 密钥 ID:“1234abcd-12ab-34cd-56ef-1234567890ab”
-
KMS 密钥别名:“别名/ExampleAlias"
您可以使用以下任意方法来标识当前账户或其他账户中的 KMS 密钥:
-
Amazon 资源名称 (ARN) 当前账户或其他账户中 KMS 密钥的 Amazon 资源名称 (ARN):“ARN: aws: KMS: KMS: Key/1234CD-34CD-56ef-1234567890ab”
-
KMS 密钥别名的 ARN:“arn: aws: kms: 区域:账户 ID: alias/ExampleAlias"
如果未指定加密密钥,则将使用默认 Amazon S3 密钥 (SSE-S3) 对医疗转录作业的输出进行加密。
如果指定 KMS 密钥以加密输出,则您还必须在
OutputBucketName
参数。类型: 字符串
长度约束:最小长度为 1。长度上限为 2048。
模式:
^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
必填项:否
-
- OutputKey
-
您可以在 Amazon S3 存储桶中指定一个位置来存储医疗转录作业的输出。
如果您没有指定输出密钥,Amazon Transcribe Medical 会将转录作业的输出存储在您指定的 Amazon S3 存储桶中。默认情况下,对象键为”your-transcription-job-name.json”。
您可以使用输出键来指定转录输出的 Amazon S3 前缀和文件名。例如,将 Amazon S3 前缀 “folder1/folder2/” 指定为输出密钥将导致输出存储为 “folder1/folder2/”your-transcription-job-name.json”。如果你指定”my-other-job-name.json” 作为输出键,对象密钥更改为”my-other-job-name.json”。您可以使用输出键来更改前缀和文件名,例如 “folder/my-other-job-name.json”。
如果指定输出密钥,您还必须在
OutputBucketName
参数。类型: 字符串
长度约束:最小长度为 1。长度上限为 1024。
模式:
[a-zA-Z0-9-_.!*'()/]{1,1024}$
必填项:否
- Settings
-
医疗转录作业的可选设置。
类型:MedicalTranscriptionSetting 对象
必填项:否
- Specialty
-
任何在输入媒体中讲话的临床医生的医疗专业。
类型: 字符串
有效值:
PRIMARYCARE
必填项:是
- Tags
-
向 Amazon Transcribe 医疗转录作业添加标签。
类型: 数组Tag对象
数组成员:最少 1 项。最多 200 项。
必填项:否
- Type
-
输入音频中的语音类型。
CONVERSATION
指两位或两位以上发言者之间的对话,例如医生和患者之间的对话。DICTATION
指单讲者听写的演讲,例如临床笔记。类型: 字符串
有效值:
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
-
您的请求没有通过一个或多个验证测试。例如,如果您尝试删除的实体不存在,或者它处于非终端状态(例如,它 “正在进行中”)。查看例外
Message
字段以获取更多信息。HTTP 状态代码:400
- ConflictException
-
已经有一个具有该名称的资源。
HTTP 状态代码:400
- InternalFailureException
-
发生内部服务器错误。检查错误消息并再次尝试请求。
HTTP 状态代码:500
- LimitExceededException
-
要么您发送过多的请求或输入文件太长。等待,然后再重新发送您的请求,或使用较小的文件,然后重新发送请求。
HTTP 状态代码:400
另请参阅
有关在特定语言的Amazon软件开发工具包中使用此 API 的更多信息,请参阅以下内容: