2020/04/06 - Amazon Transcribe Service - 4 new api methods
Changes This release adds support for batch transcription jobs within Amazon Transcribe Medical.
Deletes a transcription job generated by Amazon Transcribe Medical and any related information.
See also: AWS API Documentation
Request Syntax
client.delete_medical_transcription_job(
MedicalTranscriptionJobName='string'
)
string
[REQUIRED]
The name you provide to the DeleteMedicalTranscriptionJob object to delete a transcription job.
None
Start a batch job to transcribe medical speech to text.
See also: AWS API Documentation
Request Syntax
client.start_medical_transcription_job(
MedicalTranscriptionJobName='string',
LanguageCode='en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR'|'es-ES'|'en-IN'|'hi-IN'|'ar-SA'|'ru-RU'|'zh-CN'|'nl-NL'|'id-ID'|'ta-IN'|'fa-IR'|'en-IE'|'en-AB'|'en-WL'|'pt-PT'|'te-IN'|'tr-TR'|'de-CH'|'he-IL'|'ms-MY'|'ja-JP'|'ar-AE',
MediaSampleRateHertz=123,
MediaFormat='mp3'|'mp4'|'wav'|'flac',
Media={
'MediaFileUri': 'string'
},
OutputBucketName='string',
OutputEncryptionKMSKeyId='string',
Settings={
'ShowSpeakerLabels': True|False,
'MaxSpeakerLabels': 123,
'ChannelIdentification': True|False,
'ShowAlternatives': True|False,
'MaxAlternatives': 123
},
Specialty='PRIMARYCARE',
Type='CONVERSATION'|'DICTATION'
)
string
[REQUIRED]
The name of the medical transcription job. You can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account.
string
[REQUIRED]
The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
integer
The sample rate, in Hertz, of the audio track in the input media file.
If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the sample rate.
string
The audio format of the input media file.
dict
[REQUIRED]
Describes the input media file in a transcription request.
MediaFileUri (string) --
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
s3://<bucket-name>/<keyprefix>/<objectkey>
For example:
s3://examplebucket/example.mp4
s3://examplebucket/mediadocs/example.mp4
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide .
string
[REQUIRED]
The Amazon S3 location where the transcription is stored.
You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
string
The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.
You use either of the following to identify a KMS key in the current account:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
KMS Key Alias: "alias/ExampleAlias"
You can use either of the following to identify a KMS key in the current account or another account:
Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
If you don't specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.
dict
Optional settings for the medical transcription job.
ShowSpeakerLabels (boolean) --
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recongition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels in the MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .
MaxSpeakerLabels (integer) --
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
ChannelIdentification (boolean) --
Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of item. The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException
ShowAlternatives (boolean) --
Determines whether alternative transcripts are generated along with the transcript that has the highest confidence. If you set ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
MaxAlternatives (integer) --
The maximum number of alternatives that you tell the service to return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
string
[REQUIRED]
The medical specialty of any clinician speaking in the input media.
string
[REQUIRED]
The speech of clinician in the input audio. CONVERSATION refers to conversations clinicians have with patients. DICTATION refers to medical professionals dictating their notes about a patient encounter.
dict
Response Syntax
{
'MedicalTranscriptionJob': {
'MedicalTranscriptionJobName': 'string',
'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'LanguageCode': 'en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR'|'es-ES'|'en-IN'|'hi-IN'|'ar-SA'|'ru-RU'|'zh-CN'|'nl-NL'|'id-ID'|'ta-IN'|'fa-IR'|'en-IE'|'en-AB'|'en-WL'|'pt-PT'|'te-IN'|'tr-TR'|'de-CH'|'he-IL'|'ms-MY'|'ja-JP'|'ar-AE',
'MediaSampleRateHertz': 123,
'MediaFormat': 'mp3'|'mp4'|'wav'|'flac',
'Media': {
'MediaFileUri': 'string'
},
'Transcript': {
'TranscriptFileUri': 'string'
},
'StartTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'Settings': {
'ShowSpeakerLabels': True|False,
'MaxSpeakerLabels': 123,
'ChannelIdentification': True|False,
'ShowAlternatives': True|False,
'MaxAlternatives': 123
},
'Specialty': 'PRIMARYCARE',
'Type': 'CONVERSATION'|'DICTATION'
}
}
Response Structure
(dict) --
MedicalTranscriptionJob (dict) --
A batch job submitted to transcribe medical speech to text.
MedicalTranscriptionJobName (string) --
The name for a given medical transcription job.
TranscriptionJobStatus (string) --
The completion status of a medical transcription job.
LanguageCode (string) --
The language code for the language spoken in the source audio file. US English (en-US) is the only supported language for medical transcriptions. Any other value you enter for language code results in a BadRequestException error.
MediaSampleRateHertz (integer) --
The sample rate, in Hertz, of the source audio containing medical information.
If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleHertz blank and let Amazon Transcribe Medical determine the sample rate.
MediaFormat (string) --
The format of the input media file.
Media (dict) --
Describes the input media file in a transcription request.
MediaFileUri (string) --
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
s3://<bucket-name>/<keyprefix>/<objectkey>
For example:
s3://examplebucket/example.mp4
s3://examplebucket/mediadocs/example.mp4
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide .
Transcript (dict) --
An object that contains the MedicalTranscript . The MedicalTranscript contains the TranscriptFileUri .
TranscriptFileUri (string) --
The S3 object location of the medical transcript.
Use this URI to access the medical transcript. This URI points to the S3 bucket you created to store the medical transcript.
StartTime (datetime) --
A timestamp that shows when the job started processing.
CreationTime (datetime) --
A timestamp that shows when the job was created.
CompletionTime (datetime) --
A timestamp that shows when the job was completed.
FailureReason (string) --
If the TranscriptionJobStatus field is FAILED , this field contains information about why the job failed.
The FailureReason field contains one of the following values:
Unsupported media format - The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.
The media format provided does not match the detected media format - The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure the two values match.
Invalid sample rate for audio file - The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8000 and 48000 Hertz.
The sample rate provided does not match the detected sample rate - The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large - The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidlines and Quotas in the Amazon Transcribe Medical Guide
Invalid number of channels: number of channels too large - Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference
Settings (dict) --
Object that contains object.
ShowSpeakerLabels (boolean) --
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recongition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels in the MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .
MaxSpeakerLabels (integer) --
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
ChannelIdentification (boolean) --
Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of item. The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException
ShowAlternatives (boolean) --
Determines whether alternative transcripts are generated along with the transcript that has the highest confidence. If you set ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
MaxAlternatives (integer) --
The maximum number of alternatives that you tell the service to return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
Specialty (string) --
The medical specialty of any clinicians providing a dictation or having a conversation. PRIMARYCARE is the only available setting for this object. This specialty enables you to generate transcriptions for the following medical fields:
Family Medicine
Type (string) --
The type of speech in the transcription job. CONVERSATION is generally used for patient-physician dialogues. DICTATION is the setting for physicians speaking their notes after seeing a patient. For more information, see how-it-works-med
Lists medical transcription jobs with a specified status or substring that matches their names.
See also: AWS API Documentation
Request Syntax
client.list_medical_transcription_jobs(
Status='QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
JobNameContains='string',
NextToken='string',
MaxResults=123
)
string
When specified, returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don't specify a status, Amazon Transcribe Medical returns all transcription jobs ordered by creation date.
string
When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
string
If you a receive a truncated result in the previous request of ListMedicalTranscriptionJobs , include NextToken to fetch the next set of jobs.
integer
The maximum number of medical transcription jobs to return in the response. IF there are fewer results in the list, this response contains only the actual results.
dict
Response Syntax
{
'Status': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'NextToken': 'string',
'MedicalTranscriptionJobSummaries': [
{
'MedicalTranscriptionJobName': 'string',
'CreationTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'LanguageCode': 'en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR'|'es-ES'|'en-IN'|'hi-IN'|'ar-SA'|'ru-RU'|'zh-CN'|'nl-NL'|'id-ID'|'ta-IN'|'fa-IR'|'en-IE'|'en-AB'|'en-WL'|'pt-PT'|'te-IN'|'tr-TR'|'de-CH'|'he-IL'|'ms-MY'|'ja-JP'|'ar-AE',
'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'FailureReason': 'string',
'OutputLocationType': 'CUSTOMER_BUCKET'|'SERVICE_BUCKET',
'Specialty': 'PRIMARYCARE',
'Type': 'CONVERSATION'|'DICTATION'
},
]
}
Response Structure
(dict) --
Status (string) --
The requested status of the medical transcription jobs returned.
NextToken (string) --
The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If the number of jobs exceeds what can fit on a page, Amazon Transcribe Medical returns the NextPage token. Include the token in the next request to the ListMedicalTranscriptionJobs operation to return in the next page of jobs.
MedicalTranscriptionJobSummaries (list) --
A list of objects containing summary information for a transcription job.
(dict) --
Provides summary information about a transcription job.
MedicalTranscriptionJobName (string) --
The name of a medical transcription job.
CreationTime (datetime) --
A timestamp that shows when the medical transcription job was created.
StartTime (datetime) --
A timestamp that shows when the job began processing.
CompletionTime (datetime) --
A timestamp that shows when the job was completed.
LanguageCode (string) --
The language of the transcript in the source audio file.
TranscriptionJobStatus (string) --
The status of the medical transcription job.
FailureReason (string) --
If the TranscriptionJobStatus field is FAILED , a description of the error.
OutputLocationType (string) --
Indicates the location of the transcription job's output.
The CUSTOMER_BUCKET is the S3 location provided in the OutputBucketName field when the
Specialty (string) --
The medical specialty of the transcription job. Primary care is the only valid value.
Type (string) --
The speech of the clinician in the input audio.
Returns information about a transcription job from Amazon Transcribe Medical. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED , the job is finished. You find the results of the completed job in the TranscriptFileUri field.
See also: AWS API Documentation
Request Syntax
client.get_medical_transcription_job(
MedicalTranscriptionJobName='string'
)
string
[REQUIRED]
The name of the medical transcription job.
dict
Response Syntax
{
'MedicalTranscriptionJob': {
'MedicalTranscriptionJobName': 'string',
'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'LanguageCode': 'en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR'|'es-ES'|'en-IN'|'hi-IN'|'ar-SA'|'ru-RU'|'zh-CN'|'nl-NL'|'id-ID'|'ta-IN'|'fa-IR'|'en-IE'|'en-AB'|'en-WL'|'pt-PT'|'te-IN'|'tr-TR'|'de-CH'|'he-IL'|'ms-MY'|'ja-JP'|'ar-AE',
'MediaSampleRateHertz': 123,
'MediaFormat': 'mp3'|'mp4'|'wav'|'flac',
'Media': {
'MediaFileUri': 'string'
},
'Transcript': {
'TranscriptFileUri': 'string'
},
'StartTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'Settings': {
'ShowSpeakerLabels': True|False,
'MaxSpeakerLabels': 123,
'ChannelIdentification': True|False,
'ShowAlternatives': True|False,
'MaxAlternatives': 123
},
'Specialty': 'PRIMARYCARE',
'Type': 'CONVERSATION'|'DICTATION'
}
}
Response Structure
(dict) --
MedicalTranscriptionJob (dict) --
An object that contains the results of the medical transcription job.
MedicalTranscriptionJobName (string) --
The name for a given medical transcription job.
TranscriptionJobStatus (string) --
The completion status of a medical transcription job.
LanguageCode (string) --
The language code for the language spoken in the source audio file. US English (en-US) is the only supported language for medical transcriptions. Any other value you enter for language code results in a BadRequestException error.
MediaSampleRateHertz (integer) --
The sample rate, in Hertz, of the source audio containing medical information.
If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleHertz blank and let Amazon Transcribe Medical determine the sample rate.
MediaFormat (string) --
The format of the input media file.
Media (dict) --
Describes the input media file in a transcription request.
MediaFileUri (string) --
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
s3://<bucket-name>/<keyprefix>/<objectkey>
For example:
s3://examplebucket/example.mp4
s3://examplebucket/mediadocs/example.mp4
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide .
Transcript (dict) --
An object that contains the MedicalTranscript . The MedicalTranscript contains the TranscriptFileUri .
TranscriptFileUri (string) --
The S3 object location of the medical transcript.
Use this URI to access the medical transcript. This URI points to the S3 bucket you created to store the medical transcript.
StartTime (datetime) --
A timestamp that shows when the job started processing.
CreationTime (datetime) --
A timestamp that shows when the job was created.
CompletionTime (datetime) --
A timestamp that shows when the job was completed.
FailureReason (string) --
If the TranscriptionJobStatus field is FAILED , this field contains information about why the job failed.
The FailureReason field contains one of the following values:
Unsupported media format - The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.
The media format provided does not match the detected media format - The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure the two values match.
Invalid sample rate for audio file - The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8000 and 48000 Hertz.
The sample rate provided does not match the detected sample rate - The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large - The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidlines and Quotas in the Amazon Transcribe Medical Guide
Invalid number of channels: number of channels too large - Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference
Settings (dict) --
Object that contains object.
ShowSpeakerLabels (boolean) --
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recongition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels in the MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .
MaxSpeakerLabels (integer) --
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
ChannelIdentification (boolean) --
Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of item. The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException
ShowAlternatives (boolean) --
Determines whether alternative transcripts are generated along with the transcript that has the highest confidence. If you set ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
MaxAlternatives (integer) --
The maximum number of alternatives that you tell the service to return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
Specialty (string) --
The medical specialty of any clinicians providing a dictation or having a conversation. PRIMARYCARE is the only available setting for this object. This specialty enables you to generate transcriptions for the following medical fields:
Family Medicine
Type (string) --
The type of speech in the transcription job. CONVERSATION is generally used for patient-physician dialogues. DICTATION is the setting for physicians speaking their notes after seeing a patient. For more information, see how-it-works-med