本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
StartMedicalTranscriptionJob
并非所有地区都支持Amazon Transcribe 医疗服务。
转录来自医疗听写或对话的音频,并应用您选择包括在请求中的任何其他请求参数。
除了许多标准的转录功能外,Amazon Transcribe Medical 还为您提供强大的医学词汇表和可选的内容识别,从而为个人健康信息 (PHI) 添加标志。要了解有关这些功能的更多信息,请参阅Amat Medical Medical Medical.
要做一个StartMedicalTranscriptionJob请求,您必须先将媒体文件上传到 Amazon S3 存储桶中;然后可以使用Media参数。
您必需StartMedicalTranscriptionJob必需:
-
region: 该Amazon Web Services 区域你在哪里提出请求。有关列表Amazon Web Services 区域受Amazon Transcribe 支持,请参阅Amazon Transcribe 终端节点和配额. -
MedicalTranscriptionJobName:您为转录作业创建的自定义名称,该名称在您的Amazon Web Services 账户. -
Media(MediaFileUri:必需 Simple(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).
类型: 字符串
有效值:
PHI必需: 否
- KMSEncryptionContext
-
纯文本、非机密 key: value 对(称为加密上下文对)的映射,可为您的数据提供额外的安全层。有关更多信息,请参阅 。Amazon KMS加密上下文和非对称对称密钥Amazon KMS.
类型: 字符串到字符串映射
地图条目:最多 10 项。
键长度约束:最小长度为 1。长度上限为 2000。
密钥模式:
.*\S.*值长度约束:最小长度为 1。长度上限为 2000。
价值模式:
.*\S.*必需: 否
- LanguageCode
-
语言代码,表示语言中使用的语言代码的输入媒体文件。美式英语 (
en-US) 是医疗转录作业的唯一有效值。您为语言代码输入的任何其他值都会导致BadRequestException错误消息。类型: 字符串
有效值:
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必需: 是
- Media
-
描述您要在请求中使用的媒体文件的 Amazon S3 位置。
类型:Media 对象
必需: 是
- MediaFormat
-
指定媒体输入文件的格式。
类型: 字符串
有效值:
mp3 | mp4 | wav | flac | ogg | amr | webm必需: 否
- MediaSampleRateHertz
-
该示例(单位:赫兹)为输入媒体文件的音频。
如果您未指定媒体采样率,Amazon Transcribe 医疗将为您确定。如果您指定采样率,则它必须与 Amazon Transcribe Medical 检测到的速率相匹配;如果您指定的值与检测到的值不匹配,则您的作业将失败。因此,在大多数情况下,建议不要需
MediaSampleRateHertz并让Amazon Transcribe 医疗公司确定采样率。类型: 整数
有效范围:最小值为 160。最大值为 48 0。
必需: 否
- MedicalTranscriptionJobName
-
您为医疗转录工作选择的唯一名称。您指定的名称也用作转录输出文件的默认名称。如果您要为转录输出指定其他名称,则使用
OutputKey参数。此名称区分大小写,不能包含空格,并且在Amazon Web Services 账户. 如果您尝试创建与现有作业具有相同名称的新作业,则将获得
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/,设置需OutputBucketName到DOC-EXAMPLE-BUCKET和OutputKey到test-files/.请注意,Amazon Transcribe 必须拥有使用指定位置的权限。您可以使用更改 Amazon S3 权限Amazon Web Services Management Console
. 另请参阅IAM 用户角色所需的权限. 如果你不指定
OutputBucketName,您的成绩单将被放置在服务托管的 Amazon S3 存储桶中,并向您提供一个用于访问您的脚本的 URI。类型: 字符串
长度约束:最大长度为 64。
模式:
[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]必需: 是
- OutputEncryptionKMSKeyId
-
要用于加密医疗转录输出的 KMS 密钥。
如果使用位于当前的 Amazon Web Services 账户,您可以采用以下四种方法之一指定您的 KMS 密钥:
-
使用 KMS 密钥 ID 本身。例如,
1234abcd-12ab-34cd-56ef-1234567890ab。 -
使用键入 KMS 密钥ID。例如,
alias/ExampleAlias。 -
将亚马逊资源名称 (ARN) 用作 KMS 密钥 ID。例如,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab。 -
使用 KARN S 密钥别名。例如,
arn:aws:kms:region:account-ID:alias/ExampleAlias。
如果使用位于不同的 Amazon Web Services 账户比当前Amazon Web Services 账户,您可以采用以下两种方法之一指定您的 KMS 密钥:
-
使用 ARN 作为 KMS 密钥 ID。例如,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab。 -
使用 KARN S 密钥别名。例如,
arn:aws:kms:region:account-ID:alias/ExampleAlias。
如果未指定加密密钥,则将使用默认 Amazon S3 密钥 (SSE-S3) 对输出进行加密。
如果您指定 KMS 密钥对输出进行加密,则您还必须使用
OutputLocation参数。请注意,用户制作了StartCallAnalyticsJob请求必须拥有使用指定 KMS 密钥的权限。
类型: 字符串
长度约束:最小长度为 1。长度上限为 2048。
模式:
^[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. -
如果你指定 'my-first-transcription'作为
MedicalTranscriptionJobName,“DOC-EXAMPLE-BUCKET” 作为OutputBucketName,并将 “我的成绩单” 作为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. -
如果你指定 'my-first-transcription'作为
MedicalTranscriptionJobName,“DOC-EXAMPLE-BUCKET” 作为OutputBucketName,并将 “测试文件/我的成绩单” 作为OutputKey,你的转录输出路径是s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
如果您指定不存在的 Amazon S3 存储桶子文件夹的名称,则会为您创建一个子文件夹。
类型: 字符串
长度约束:最小长度为 1。长度上限为 1024。
模式:
[a-zA-Z0-9-_.!*'()/]{1,1024}$必需: 否
-
- Settings
-
在中指定其他可选设置StartMedicalTranscriptionJob请求,包括频道标识、替代转录和扬声器标签。你可以用它来将自定义词汇应用到你的转录作业中。
类型:MedicalTranscriptionSetting 对象
必需: 否
- Specialty
-
指定媒体中代表的主要医学专业。对于批量转录,
PRIMARYCARE是必需。如果您需要其他专业,请参阅StartMedicalStreamTranscription.类型: 字符串
有效值:
PRIMARYCARE必需: 是
- Tags
-
在您开始此新作业时,将一个或多个自定义标签添加到新的医疗转录作业中,每个标签均采用 key: value 对的形式。
要了解有关将标签与 Amazon Transcribe 结合使用的更多信息,请参阅为资源添加标签.
类型: 数组设置Tag对象
数组成员:最小值为 1 项。最多 200 项。
必需: 否
- Type
-
指定您的输入媒体是否只包含一个人 (
DICTATION) 或包含两个人之间的对话 (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
-
您的请求未通过一个或多个验证测试。当您尝试删除的实体不存在或处于非终端状态(例如
IN PROGRESS)。有关更多信息,请参阅 Storage Medical Medical。HTP 状态代码:400
- ConflictException
-
已存在具有此名称的资源。资源名称必须唯一Amazon Web Services 账户.
HTP 状态代码:400
- InternalFailureException
-
发生内部服务器错误。检查错误消息并更正问题,然后重试发送您的请求。
HTP 状态代码:500
- LimitExceededException
-
您已经发送过多的请求或您的输入文件中包含过长。等待,然后再重试发送您的请求,或使用较小的文件,然后重试发送您的请求。
HTP 状态代码:400
另请参阅
有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: