TranscribeService / Client / start_medical_transcription_job

start_medical_transcription_job#

TranscribeService.Client.start_medical_transcription_job(**kwargs)#

Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request.

In addition to many standard transcription features, Amazon Transcribe Medical provides you with a robust medical vocabulary and, optionally, content identification, which adds flags to personal health information (PHI). To learn more about these features, refer to How Amazon Transcribe Medical works.

To make a StartMedicalTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the S3 location of the file using the Media parameter.

You must include the following parameters in your StartMedicalTranscriptionJob request:

region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.
MedicalTranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account.
Media ( MediaFileUri): The Amazon S3 location of your media file.
LanguageCode: This must be en-US.
OutputBucketName: The Amazon S3 bucket where you want your transcript stored. If you want your output stored in a sub-folder of this bucket, you must also include OutputKey.
Specialty: This must be PRIMARYCARE.
Type: Choose whether your audio is a conversation or a dictation.

Request Syntax

response = client.start_medical_transcription_job(
    MedicalTranscriptionJobName='string',
    LanguageCode='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',
    MediaSampleRateHertz=123,
    MediaFormat='mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm'|'m4a',
    Media={
        'MediaFileUri': 'string',
        'RedactedMediaFileUri': 'string'
    },
    OutputBucketName='string',
    OutputKey='string',
    OutputEncryptionKMSKeyId='string',
    KMSEncryptionContext={
        'string': 'string'
    },
    Settings={
        'ShowSpeakerLabels': True|False,
        'MaxSpeakerLabels': 123,
        'ChannelIdentification': True|False,
        'ShowAlternatives': True|False,
        'MaxAlternatives': 123,
        'VocabularyName': 'string'
    },
    ContentIdentificationType='PHI',
    Specialty='PRIMARYCARE',
    Type='CONVERSATION'|'DICTATION',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

MedicalTranscriptionJobName (string) –
[REQUIRED]

A unique name, chosen by you, for your medical transcription job. The name that you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use the OutputKey parameter.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.
LanguageCode (string) –
[REQUIRED]

The language code that represents the language spoken in the input media file. US English ( en-US) is the only valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
MediaSampleRateHertz (integer) –
The sample rate, in hertz, of the audio track in your input media file.

If you don’t specify the media sample rate, Amazon Transcribe Medical determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there’s a mismatch between the value that you specify and the value detected, your job fails. Therefore, in most cases, it’s advised to omit MediaSampleRateHertz and let Amazon Transcribe Medical determine the sample rate.
MediaFormat (string) – Specify the format of your input media file.
Media (dict) –
[REQUIRED]

Describes the Amazon S3 location of the media file you want to use in your request.

For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide.
- MediaFileUri (string) –
  
  The Amazon S3 location of the media file you want to transcribe. For example:
  - s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
  - s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
  Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you’re making your transcription request.
- RedactedMediaFileUri (string) –
  
  The Amazon S3 location of the media file you want to redact. For example:
  - s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
  - s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
  Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you’re making your transcription request.
  
  Warning
  RedactedMediaFileUri produces a redacted audio file in addition to a redacted transcript. It is only supported for Call Analytics ( StartCallAnalyticsJob) transcription requests.
OutputBucketName (string) –
[REQUIRED]

The name of the Amazon S3 bucket where you want your medical transcription output stored. Do not include the S3:// prefix of the specified bucket.

If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey parameter; OutputBucketName only accepts the name of a bucket.

For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET and OutputKey to test-files/.

Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
OutputKey (string) –
Use in combination with OutputBucketName to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your medical transcription job ( MedicalTranscriptionJobName).

Here are some examples of how you can use OutputKey:
- If you specify ‘DOC-EXAMPLE-BUCKET’ as the OutputBucketName and ‘my-transcript.json’ as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.
- If you specify ‘my-first-transcription’ as the MedicalTranscriptionJobName, ‘DOC-EXAMPLE-BUCKET’ as the OutputBucketName, and ‘my-transcript’ as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
- If you specify ‘DOC-EXAMPLE-BUCKET’ as the OutputBucketName and ‘test-files/my-transcript.json’ as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
- If you specify ‘my-first-transcription’ as the MedicalTranscriptionJobName, ‘DOC-EXAMPLE-BUCKET’ as the OutputBucketName, and ‘test-files/my-transcript’ as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
If you specify the name of an Amazon S3 bucket sub-folder that doesn’t exist, one is created for you.
OutputEncryptionKMSKeyId (string) –
The KMS key you want to use to encrypt your medical transcription output.

If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
- Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
- Use an alias for the KMS key ID. For example, alias/ExampleAlias.
- Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
- Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
- Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
- Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you don’t specify an encryption key, your output 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 using the OutputLocation parameter.

Note that the role making the request must have permission to use the specified KMS key.
KMSEncryptionContext (dict) –
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.
- (string) –
  - (string) –
Settings (dict) –
Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your transcription job.
- ShowSpeakerLabels (boolean) –
  
  Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.
  
  If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.
  
  You can’t include ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
  
  For more information, see Partitioning speakers (diarization).
- MaxSpeakerLabels (integer) –
  
  Specify the maximum number of speakers you want to partition in your media.
  
  Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.
  
  If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
- ChannelIdentification (boolean) –
  
  Enables channel identification in multi-channel audio.
  
  Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
  
  If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.
  
  You can’t include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
  
  For more information, see Transcribing multi-channel audio.
- ShowAlternatives (boolean) –
  
  To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.
  
  If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.
  
  For more information, see Alternative transcriptions.
- MaxAlternatives (integer) –
  
  Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.
  
  If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included.
  
  If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.
  
  For more information, see Alternative transcriptions.
- VocabularyName (string) –
  
  The name of the custom vocabulary you want to use when processing your medical transcription job. Custom vocabulary names are case sensitive.
  
  The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages don’t match, the custom vocabulary isn’t applied. There are no errors or warnings associated with a language mismatch. US English ( en-US) is the only valid language for Amazon Transcribe Medical.
ContentIdentificationType (string) – Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.
Specialty (string) –
[REQUIRED]

Specify the predominant medical specialty represented in your media. For batch transcriptions, PRIMARYCARE is the only valid value. If you require additional specialties, refer to .
Type (string) –
[REQUIRED]

Specify whether your input media contains only one person ( DICTATION) or contains a conversation between two people ( CONVERSATION).

For example, DICTATION could be used for a medical professional wanting to transcribe voice memos; CONVERSATION could be used for transcribing the doctor-patient dialogue during the patient’s office visit.
Tags (list) –
Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the time you start this new job.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
- (dict) –
  
  Adds metadata, in the form of a key:value pair, to the specified resource.
  
  For example, you could add the tag Department:Sales to a resource to indicate that it pertains to your organization’s sales department. You can also use tags for tag-based access control.
  
  To learn more about tagging, see Tagging resources.
  - Key (string) – [REQUIRED]
    
    The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the key is ‘Department’.
  - Value (string) – [REQUIRED]
    
    The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the value is ‘Sales’.
    
    Note that you can set the value of a tag to an empty string, but you can’t set the value of a tag to null. Omitting the tag value is the same as using an empty string.

Return type:

dict

Returns:

Response Syntax

{
    'MedicalTranscriptionJob': {
        'MedicalTranscriptionJobName': 'string',
        'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
        'LanguageCode': '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',
        'MediaSampleRateHertz': 123,
        'MediaFormat': 'mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm'|'m4a',
        'Media': {
            'MediaFileUri': 'string',
            'RedactedMediaFileUri': '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,
            'VocabularyName': 'string'
        },
        'ContentIdentificationType': 'PHI',
        'Specialty': 'PRIMARYCARE',
        'Type': 'CONVERSATION'|'DICTATION',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) –
- MedicalTranscriptionJob (dict) –
  
  Provides detailed information about the current medical transcription job, including job status and, if applicable, failure reason.
  - MedicalTranscriptionJobName (string) –
    
    The name of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
  - TranscriptionJobStatus (string) –
    
    Provides the status of the specified medical transcription job.
    
    If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.
  - LanguageCode (string) –
    
    The language code used to create your medical transcription job. US English ( en-US) is the only supported language for medical transcriptions.
  - MediaSampleRateHertz (integer) –
    
    The sample rate, in hertz, of the audio track in your input media file.
  - MediaFormat (string) –
    
    The format of the input media file.
  - Media (dict) –
    
    Describes the Amazon S3 location of the media file you want to use in your request.
    
    For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide.
    - MediaFileUri (string) –
      
      The Amazon S3 location of the media file you want to transcribe. For example:
      - s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
      - s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
      Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you’re making your transcription request.
    - RedactedMediaFileUri (string) –
      
      The Amazon S3 location of the media file you want to redact. For example:
      - s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
      - s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
      Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you’re making your transcription request.
      
      Warning
      RedactedMediaFileUri produces a redacted audio file in addition to a redacted transcript. It is only supported for Call Analytics ( StartCallAnalyticsJob) transcription requests.
  - Transcript (dict) –
    
    Provides you with the Amazon S3 URI you can use to access your transcript.
    - TranscriptFileUri (string) –
      
      The Amazon S3 location of your transcript. You can use this URI to access or download your transcript.
      
      Note that this is the Amazon S3 location you specified in your request using the OutputBucketName parameter.
  - StartTime (datetime) –
    
    The date and time the specified medical transcription job began processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
  - CreationTime (datetime) –
    
    The date and time the specified medical transcription job request was made.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
  - CompletionTime (datetime) –
    
    The date and time the specified medical transcription job finished processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.
  - FailureReason (string) –
    
    If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.
    
    The FailureReason field contains one of the following values:
    - Unsupported media format. The media format specified in MediaFormat isn’t valid. Refer to MediaFormat for a list of supported formats.
    - The media format provided does not match the detected media format. The media format specified in MediaFormat doesn’t match the format of the input file. Check the media format of your media file and correct the specified value.
    - Invalid sample rate for audio file. The sample rate specified in MediaSampleRateHertz isn’t valid. The sample rate must be between 16,000 and 48,000 hertz.
    - The sample rate provided does not match the detected sample rate. The sample rate specified in MediaSampleRateHertz doesn’t match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.
    - Invalid file size: file size too large. The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.
    - Invalid number of channels: number of channels too large. Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.
  - Settings (dict) –
    
    Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.
    - ShowSpeakerLabels (boolean) –
      
      Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.
      
      If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.
      
      You can’t include ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
      
      For more information, see Partitioning speakers (diarization).
    - MaxSpeakerLabels (integer) –
      
      Specify the maximum number of speakers you want to partition in your media.
      
      Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.
      
      If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
    - ChannelIdentification (boolean) –
      
      Enables channel identification in multi-channel audio.
      
      Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
      
      If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.
      
      You can’t include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
      
      For more information, see Transcribing multi-channel audio.
    - ShowAlternatives (boolean) –
      
      To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.
      
      If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.
      
      For more information, see Alternative transcriptions.
    - MaxAlternatives (integer) –
      
      Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.
      
      If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included.
      
      If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.
      
      For more information, see Alternative transcriptions.
    - VocabularyName (string) –
      
      The name of the custom vocabulary you want to use when processing your medical transcription job. Custom vocabulary names are case sensitive.
      
      The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages don’t match, the custom vocabulary isn’t applied. There are no errors or warnings associated with a language mismatch. US English ( en-US) is the only valid language for Amazon Transcribe Medical.
  - ContentIdentificationType (string) –
    
    Indicates whether content identification was enabled for your transcription request.
  - Specialty (string) –
    
    Describes the medical specialty represented in your media.
  - Type (string) –
    
    Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.
  - Tags (list) –
    
    The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
    - (dict) –
      
      Adds metadata, in the form of a key:value pair, to the specified resource.
      
      For example, you could add the tag Department:Sales to a resource to indicate that it pertains to your organization’s sales department. You can also use tags for tag-based access control.
      
      To learn more about tagging, see Tagging resources.
      - Key (string) –
        
        The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the key is ‘Department’.
      - Value (string) –
        
        The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the value is ‘Sales’.
        
        Note that you can set the value of a tag to an empty string, but you can’t set the value of a tag to null. Omitting the tag value is the same as using an empty string.

Exceptions

TranscribeService.Client.exceptions.BadRequestException
TranscribeService.Client.exceptions.LimitExceededException
TranscribeService.Client.exceptions.InternalFailureException
TranscribeService.Client.exceptions.ConflictException