StartMedicalTranscriptionJob - 转录
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

StartMedicalTranscriptionJob

注意

并非所有地区都支持Amazon Transcribe e Medical。

转录医疗听写或对话中的音频,并应用您选择包含在请求中的任何其他请求参数。

除了许多标准转录功能外,Amazon Transcribe Medical 还为您提供强大的医学词汇和可选的内容识别,从而为个人健康信息 (PHI) 添加标记。要了解有关这些功能的更多信息,请参阅 Amazon Transcribe l 的工作原理

要发出StartMedicalTranscriptionJob请求,您必须先将媒体文件上传到 Amazon S3 存储桶;然后您可以使用Media参数指定文件的 S3 位置。

您必须在StartMedicalTranscriptionJob请求中包含以下参数:

  • region: 您提出请求Amazon Web Services 区域的地方。有关 Amazon TranscribeAmazon Web Services 区域 支持的列表,请参阅 Amazon Transcribe 终端节点和配额

  • MedicalTranscriptionJobName: 您为转录作业创建的自定义名称,该名称在您的转录作业中是唯一的Amazon Web Services 账户。

  • 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)

类型:字符串

有效值: PHI

必需:否

KMSEncryptionContext

由纯文本、非机密键:值对(称为加密上下文对)组成的映射,可为您的数据提供额外的安全保护。有关更多信息,请参阅中的Amazon KMS加密上下文和非对称密钥Amazon KMS。

类型:字符串到字符串映射

映射条目:最多 10 项项项项项项项项项项项

密钥长度限制:最小长度为 1。最大长度200项。

密钥模式:.*\S.*

值长度限制:最小长度为 1。最大长度200项。

价值模式:.*\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 | vi-VN | sv-SE

必需:是

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 ical 确定采样率。

类型:整数

有效范围:最小值为 16000 项。最大值为 48000 项。

必需:否

MedicalTranscriptionJobName

由您为医学转录工作选择的唯一名称。您指定的名称也用作转录输出文件的默认名称。如果要为转录输出指定不同的名称,请使用OutputKey参数。

此名称区分大小写,不能包含空格,并且在内必须是唯一的Amazon Web Services 账户。如果您尝试创建与现有任务具有相同的名称,则遇到了ConflictException错误。

类型:字符串

长度限制:最小长度为 1。最大长度为 200。

模式:^[0-9a-zA-Z._-]+

必需:是

OutputBucketName

您想要用于存储医疗转录输出的 Amazon S3 存储桶的名称。请勿包含指定存储段S3://的前缀。

如果您希望输出到此存储段的子文件夹,请使用OutputKey参数进行指定;OutputBucketName仅接受存储段的名称。

例如,如果您希望将输出存储在S3://DOC-EXAMPLE-BUCKET,请将设置OutputBucketNameDOC-EXAMPLE-BUCKET。但是,如果您希望将输出存储在S3://DOC-EXAMPLE-BUCKET/test-files/,请将设置OutputBucketNameOutputKeyDOC-EXAMPLE-BUCKET和为test-files/

请注意,Amazon Transcribe 必须拥有使用指定位置的权限。您可以使用更改 Amazon S3 权限Amazon Web Services Management Console。另请参阅 IAM 用户角色所需的权限

类型:字符串

长度限制:最大长度64 项。

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

必需:是

OutputEncryptionKMSKeyId

您想要用于加密医疗转录输出的 KMS 密钥。

如果使用当前Amazon Web Services 账户密钥,则可以通过以下四种方式之一指定 KMS 密钥:

  1. 使用 KMS 密钥 ID 本身。例如,1234abcd-12ab-34cd-56ef-1234567890ab

  2. 使用别名作为 KMS 密钥的别名。例如,alias/ExampleAlias

  3. 使用亚马逊资源名称 (ARN) 作为 KMS 密钥ID。例如,arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab

  4. 使用 ARN 作为 KMS 密钥别名。例如,arn:aws:kms:region:account-ID:alias/ExampleAlias

如果使用的密钥与当前密钥Amazon Web Services 账户不同Amazon Web Services 账户,则可以通过以下两种方式之一指定 KMS 密钥:

  1. 使用 ARN 作为 KMS 密钥 ID。例如,arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab

  2. 使用 ARN 作为 KMS 密钥别名。例如,arn:aws:kms:region:account-ID:alias/ExampleAlias

如果您未指定加密密钥,则使用默认 Amazon S3 key (SSE-S3) 加密输出。

如果您指定 KMS 密钥来加密输出,则还必须使用OutputLocation参数指定输出位置。

请注意,StartCallAnalyticsJob发出请求的角色必须拥有使用指定密钥的权限。

类型:字符串

长度限制:最小长度为 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,将 “my-sractript” 指定为OutputKey,则您的转录输出路径为s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json

  • 如果你将 “DOC-EXAMPLE-BUCKET” 指定为,将 “test-files/my-transcript.json” 指定为OutputKey,则转录输出路径为s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.jsonOutputBucketName

  • 如果您将 “my-first-transcription” 指定为,将 “DOC-EXAMPLE-BUCKET” 指定为,将 “test-files/my-stractript” 指定为OutputKey,则您的转录输出路径为s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.jsonMedicalTranscriptionJobNameOutputBucketName

如果您指定了不存在的 Amazon S3 存储桶子文件夹的名称,则会为您创建一个。

类型:字符串

长度限制:最小长度为 1。长度上限为 1024。

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

必需:否

Settings

在您的StartMedicalTranscriptionJob请求中指定其他可选设置,包括频道识别、备用转录和扬声器分区。你可以用它来将自定义词汇应用到你的转录工作中。

类型:MedicalTranscriptionSetting 对象

必需:否

Specialty

具体说明您的媒体中代表的主要医学专业。对于批量转录,PRIMARYCARE是唯一的有效值。如果您需要其他专业知识,请参阅StartMedicalStreamTranscription

类型:字符串

有效值: PRIMARYCARE

必需:是

Tags

在你开始这项新工作时,向新的医学转录作业添加一个或多个自定义标签,每个标签都采用 key: value 对的形式。

要了解有关在 Amazon Transcribe 中使用标签的更多信息,请参阅标记资源

类型:Tag 对象数组

数组成员:最少 1 项。最多 20项项项项项项项项项项

必需:否

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)时,可能会发生这种情况。有关更多信息,请参阅异常消息字段。

HTTP 状态代码:400

ConflictException

使用此名称的资源已经存在。资源名称在内必须是唯一的Amazon Web Services 账户。

HTTP 状态代码:400

InternalFailureException

遇到了内部错误。检查错误消息、更正问题,然后重试请求。

HTTP 状态代码:500

LimitExceededException

你要么发送了太多的请求,要么你的输入文件太长。请稍候,然后重试您的请求,或者使用较小的文件重试您的请求。

HTTP 状态代码:400

另请参阅

有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: