Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data MedicalTranscriptionSetting = MedicalTranscriptionSetting' {}
- newMedicalTranscriptionSetting :: MedicalTranscriptionSetting
- medicalTranscriptionSetting_channelIdentification :: Lens' MedicalTranscriptionSetting (Maybe Bool)
- medicalTranscriptionSetting_maxAlternatives :: Lens' MedicalTranscriptionSetting (Maybe Natural)
- medicalTranscriptionSetting_maxSpeakerLabels :: Lens' MedicalTranscriptionSetting (Maybe Natural)
- medicalTranscriptionSetting_showAlternatives :: Lens' MedicalTranscriptionSetting (Maybe Bool)
- medicalTranscriptionSetting_showSpeakerLabels :: Lens' MedicalTranscriptionSetting (Maybe Bool)
- medicalTranscriptionSetting_vocabularyName :: Lens' MedicalTranscriptionSetting (Maybe Text)
Documentation
data MedicalTranscriptionSetting Source #
Allows additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your medical transcription job.
See: newMedicalTranscriptionSetting
smart constructor.
MedicalTranscriptionSetting' | |
|
Instances
newMedicalTranscriptionSetting :: MedicalTranscriptionSetting Source #
Create a value of MedicalTranscriptionSetting
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelIdentification:MedicalTranscriptionSetting'
, medicalTranscriptionSetting_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.
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.
$sel:maxAlternatives:MedicalTranscriptionSetting'
, medicalTranscriptionSetting_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 include
ShowAlternatives
with a value of true
.
For more information, see Alternative transcriptions.
$sel:maxSpeakerLabels:MedicalTranscriptionSetting'
, medicalTranscriptionSetting_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 the
ShowSpeakerLabels
field to true.
$sel:showAlternatives:MedicalTranscriptionSetting'
, medicalTranscriptionSetting_showAlternatives
- 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.
$sel:showSpeakerLabels:MedicalTranscriptionSetting'
, medicalTranscriptionSetting_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 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).
$sel:vocabularyName:MedicalTranscriptionSetting'
, medicalTranscriptionSetting_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
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.
medicalTranscriptionSetting_channelIdentification :: Lens' MedicalTranscriptionSetting (Maybe Bool) Source #
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.
medicalTranscriptionSetting_maxAlternatives :: Lens' MedicalTranscriptionSetting (Maybe Natural) Source #
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.
medicalTranscriptionSetting_maxSpeakerLabels :: Lens' MedicalTranscriptionSetting (Maybe Natural) Source #
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.
medicalTranscriptionSetting_showAlternatives :: Lens' MedicalTranscriptionSetting (Maybe Bool) Source #
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.
medicalTranscriptionSetting_showSpeakerLabels :: Lens' MedicalTranscriptionSetting (Maybe Bool) Source #
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).
medicalTranscriptionSetting_vocabularyName :: Lens' MedicalTranscriptionSetting (Maybe Text) Source #
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.