Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Transcribe.Types.MedicalTranscriptionSetting

Description

Synopsis

Documentation

data MedicalTranscriptionSetting Source #

Optional settings for the StartMedicalTranscriptionJob operation.

See: newMedicalTranscriptionSetting smart constructor.

Constructors

MedicalTranscriptionSetting'

Fields

vocabularyName :: Maybe Text
The name of the vocabulary to use when processing a medical transcription job.
maxAlternatives :: Maybe Natural
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.
channelIdentification :: Maybe Bool
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 :: Maybe Bool
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.
maxSpeakerLabels :: Maybe Natural
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.
showSpeakerLabels :: Maybe Bool
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition 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.

Instances

Instances details

Eq MedicalTranscriptionSetting Source #
Instance details Defined in Amazonka.Transcribe.Types.MedicalTranscriptionSetting Methods (==) :: MedicalTranscriptionSetting -> MedicalTranscriptionSetting -> Bool # (/=) :: MedicalTranscriptionSetting -> MedicalTranscriptionSetting -> Bool #
Read MedicalTranscriptionSetting Source #
Instance details Defined in Amazonka.Transcribe.Types.MedicalTranscriptionSetting Methods readsPrec :: Int -> ReadS MedicalTranscriptionSetting # readList :: ReadS [MedicalTranscriptionSetting] # readPrec :: ReadPrec MedicalTranscriptionSetting # readListPrec :: ReadPrec [MedicalTranscriptionSetting] #
Show MedicalTranscriptionSetting Source #
Instance details Defined in Amazonka.Transcribe.Types.MedicalTranscriptionSetting Methods showsPrec :: Int -> MedicalTranscriptionSetting -> ShowS # show :: MedicalTranscriptionSetting -> String # showList :: [MedicalTranscriptionSetting] -> ShowS #
Generic MedicalTranscriptionSetting Source #
Instance details Defined in Amazonka.Transcribe.Types.MedicalTranscriptionSetting Associated Types type Rep MedicalTranscriptionSetting :: Type -> Type # Methods from :: MedicalTranscriptionSetting -> Rep MedicalTranscriptionSetting x # to :: Rep MedicalTranscriptionSetting x -> MedicalTranscriptionSetting #
NFData MedicalTranscriptionSetting Source #
Instance details Defined in Amazonka.Transcribe.Types.MedicalTranscriptionSetting Methods rnf :: MedicalTranscriptionSetting -> () #
Hashable MedicalTranscriptionSetting Source #
Instance details Defined in Amazonka.Transcribe.Types.MedicalTranscriptionSetting Methods hashWithSalt :: Int -> MedicalTranscriptionSetting -> Int # hash :: MedicalTranscriptionSetting -> Int #
ToJSON MedicalTranscriptionSetting Source #
Instance details Defined in Amazonka.Transcribe.Types.MedicalTranscriptionSetting Methods toJSON :: MedicalTranscriptionSetting -> Value # toEncoding :: MedicalTranscriptionSetting -> Encoding # toJSONList :: [MedicalTranscriptionSetting] -> Value # toEncodingList :: [MedicalTranscriptionSetting] -> Encoding #
FromJSON MedicalTranscriptionSetting Source #
Instance details Defined in Amazonka.Transcribe.Types.MedicalTranscriptionSetting Methods parseJSON :: Value -> Parser MedicalTranscriptionSetting # parseJSONList :: Value -> Parser [MedicalTranscriptionSetting] #
type Rep MedicalTranscriptionSetting Source #
Instance details Defined in Amazonka.Transcribe.Types.MedicalTranscriptionSetting type Rep MedicalTranscriptionSetting = D1 ('MetaData "MedicalTranscriptionSetting" "Amazonka.Transcribe.Types.MedicalTranscriptionSetting" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "MedicalTranscriptionSetting'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "vocabularyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxAlternatives") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "channelIdentification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "showAlternatives") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "maxSpeakerLabels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "showSpeakerLabels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))

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:vocabularyName:MedicalTranscriptionSetting', medicalTranscriptionSetting_vocabularyName - The name of the vocabulary to use when processing a medical transcription job.

$sel:maxAlternatives:MedicalTranscriptionSetting', medicalTranscriptionSetting_maxAlternatives - 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.

$sel:channelIdentification:MedicalTranscriptionSetting', medicalTranscriptionSetting_channelIdentification - 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

$sel:showAlternatives:MedicalTranscriptionSetting', medicalTranscriptionSetting_showAlternatives - 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.

$sel:maxSpeakerLabels:MedicalTranscriptionSetting', medicalTranscriptionSetting_maxSpeakerLabels - 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.

$sel:showSpeakerLabels:MedicalTranscriptionSetting', medicalTranscriptionSetting_showSpeakerLabels - Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition 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.

medicalTranscriptionSetting_vocabularyName :: Lens' MedicalTranscriptionSetting (Maybe Text) Source #

The name of the vocabulary to use when processing a medical transcription job.

medicalTranscriptionSetting_maxAlternatives :: Lens' MedicalTranscriptionSetting (Maybe Natural) Source #

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.

medicalTranscriptionSetting_channelIdentification :: Lens' MedicalTranscriptionSetting (Maybe Bool) Source #

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

medicalTranscriptionSetting_showAlternatives :: Lens' MedicalTranscriptionSetting (Maybe Bool) Source #

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.

medicalTranscriptionSetting_maxSpeakerLabels :: Lens' MedicalTranscriptionSetting (Maybe Natural) Source #

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.

medicalTranscriptionSetting_showSpeakerLabels :: Lens' MedicalTranscriptionSetting (Maybe Bool) Source #

Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition 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.