MedicalTranscriptionSetting
Allows additional optional settings in your StartMedicalTranscriptionJob request, including channel identification, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your medical transcription job.
Contents
- ChannelIdentification
-
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.
For more information, see Transcribing multi-channel audio.
Type: Boolean
Required: No
- MaxAlternatives
-
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 includeShowAlternatives
with a value oftrue
.For more information, see Alternative transcriptions.
Type: Integer
Valid Range: Minimum value of 2. Maximum value of 10.
Required: No
- MaxSpeakerLabels
-
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 theShowSpeakerLabels
field to true.Type: Integer
Valid Range: Minimum value of 2. Maximum value of 30.
Required: No
- ShowAlternatives
-
To include alternative transcriptions within your transcription output, include
ShowAlternatives
in your transcription request.If you include
ShowAlternatives
, you must also includeMaxAlternatives
, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.For more information, see Alternative transcriptions.
Type: Boolean
Required: No
- ShowSpeakerLabels
-
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 includeMaxSpeakerLabels
.For more information, see Partitioning speakers (diarization).
Type: Boolean
Required: No
- VocabularyName
-
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 do not 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.Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z._-]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: