AWS SDK for C++  1.9.153
AWS SDK for C++
Public Member Functions | List of all members
Aws::TranscribeService::Model::MedicalTranscriptionSetting Class Reference

#include <MedicalTranscriptionSetting.h>

Public Member Functions

 MedicalTranscriptionSetting ()
 
 MedicalTranscriptionSetting (Aws::Utils::Json::JsonView jsonValue)
 
MedicalTranscriptionSettingoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
bool GetShowSpeakerLabels () const
 
bool ShowSpeakerLabelsHasBeenSet () const
 
void SetShowSpeakerLabels (bool value)
 
MedicalTranscriptionSettingWithShowSpeakerLabels (bool value)
 
int GetMaxSpeakerLabels () const
 
bool MaxSpeakerLabelsHasBeenSet () const
 
void SetMaxSpeakerLabels (int value)
 
MedicalTranscriptionSettingWithMaxSpeakerLabels (int value)
 
bool GetChannelIdentification () const
 
bool ChannelIdentificationHasBeenSet () const
 
void SetChannelIdentification (bool value)
 
MedicalTranscriptionSettingWithChannelIdentification (bool value)
 
bool GetShowAlternatives () const
 
bool ShowAlternativesHasBeenSet () const
 
void SetShowAlternatives (bool value)
 
MedicalTranscriptionSettingWithShowAlternatives (bool value)
 
int GetMaxAlternatives () const
 
bool MaxAlternativesHasBeenSet () const
 
void SetMaxAlternatives (int value)
 
MedicalTranscriptionSettingWithMaxAlternatives (int value)
 
const Aws::StringGetVocabularyName () const
 
bool VocabularyNameHasBeenSet () const
 
void SetVocabularyName (const Aws::String &value)
 
void SetVocabularyName (Aws::String &&value)
 
void SetVocabularyName (const char *value)
 
MedicalTranscriptionSettingWithVocabularyName (const Aws::String &value)
 
MedicalTranscriptionSettingWithVocabularyName (Aws::String &&value)
 
MedicalTranscriptionSettingWithVocabularyName (const char *value)
 

Detailed Description

Optional settings for the StartMedicalTranscriptionJob operation.

See Also:

AWS API Reference

Definition at line 32 of file MedicalTranscriptionSetting.h.

Constructor & Destructor Documentation

◆ MedicalTranscriptionSetting() [1/2]

Aws::TranscribeService::Model::MedicalTranscriptionSetting::MedicalTranscriptionSetting ( )

◆ MedicalTranscriptionSetting() [2/2]

Aws::TranscribeService::Model::MedicalTranscriptionSetting::MedicalTranscriptionSetting ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ChannelIdentificationHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionSetting::ChannelIdentificationHasBeenSet ( ) const
inline

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

Definition at line 147 of file MedicalTranscriptionSetting.h.

◆ GetChannelIdentification()

bool Aws::TranscribeService::Model::MedicalTranscriptionSetting::GetChannelIdentification ( ) const
inline

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

Definition at line 134 of file MedicalTranscriptionSetting.h.

◆ GetMaxAlternatives()

int Aws::TranscribeService::Model::MedicalTranscriptionSetting::GetMaxAlternatives ( ) const
inline

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.

Definition at line 214 of file MedicalTranscriptionSetting.h.

◆ GetMaxSpeakerLabels()

int Aws::TranscribeService::Model::MedicalTranscriptionSetting::GetMaxSpeakerLabels ( ) const
inline

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.

Definition at line 96 of file MedicalTranscriptionSetting.h.

◆ GetShowAlternatives()

bool Aws::TranscribeService::Model::MedicalTranscriptionSetting::GetShowAlternatives ( ) const
inline

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.

Definition at line 182 of file MedicalTranscriptionSetting.h.

◆ GetShowSpeakerLabels()

bool Aws::TranscribeService::Model::MedicalTranscriptionSetting::GetShowSpeakerLabels ( ) const
inline

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.

Definition at line 51 of file MedicalTranscriptionSetting.h.

◆ GetVocabularyName()

const Aws::String& Aws::TranscribeService::Model::MedicalTranscriptionSetting::GetVocabularyName ( ) const
inline

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

Definition at line 242 of file MedicalTranscriptionSetting.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::TranscribeService::Model::MedicalTranscriptionSetting::Jsonize ( ) const

◆ MaxAlternativesHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionSetting::MaxAlternativesHasBeenSet ( ) const
inline

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.

Definition at line 221 of file MedicalTranscriptionSetting.h.

◆ MaxSpeakerLabelsHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionSetting::MaxSpeakerLabelsHasBeenSet ( ) const
inline

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.

Definition at line 104 of file MedicalTranscriptionSetting.h.

◆ operator=()

MedicalTranscriptionSetting& Aws::TranscribeService::Model::MedicalTranscriptionSetting::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetChannelIdentification()

void Aws::TranscribeService::Model::MedicalTranscriptionSetting::SetChannelIdentification ( bool  value)
inline

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

Definition at line 160 of file MedicalTranscriptionSetting.h.

◆ SetMaxAlternatives()

void Aws::TranscribeService::Model::MedicalTranscriptionSetting::SetMaxAlternatives ( int  value)
inline

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.

Definition at line 228 of file MedicalTranscriptionSetting.h.

◆ SetMaxSpeakerLabels()

void Aws::TranscribeService::Model::MedicalTranscriptionSetting::SetMaxSpeakerLabels ( int  value)
inline

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.

Definition at line 112 of file MedicalTranscriptionSetting.h.

◆ SetShowAlternatives()

void Aws::TranscribeService::Model::MedicalTranscriptionSetting::SetShowAlternatives ( bool  value)
inline

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.

Definition at line 198 of file MedicalTranscriptionSetting.h.

◆ SetShowSpeakerLabels()

void Aws::TranscribeService::Model::MedicalTranscriptionSetting::SetShowSpeakerLabels ( bool  value)
inline

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.

Definition at line 75 of file MedicalTranscriptionSetting.h.

◆ SetVocabularyName() [1/3]

void Aws::TranscribeService::Model::MedicalTranscriptionSetting::SetVocabularyName ( Aws::String &&  value)
inline

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

Definition at line 260 of file MedicalTranscriptionSetting.h.

◆ SetVocabularyName() [2/3]

void Aws::TranscribeService::Model::MedicalTranscriptionSetting::SetVocabularyName ( const Aws::String value)
inline

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

Definition at line 254 of file MedicalTranscriptionSetting.h.

◆ SetVocabularyName() [3/3]

void Aws::TranscribeService::Model::MedicalTranscriptionSetting::SetVocabularyName ( const char *  value)
inline

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

Definition at line 266 of file MedicalTranscriptionSetting.h.

◆ ShowAlternativesHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionSetting::ShowAlternativesHasBeenSet ( ) const
inline

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.

Definition at line 190 of file MedicalTranscriptionSetting.h.

◆ ShowSpeakerLabelsHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionSetting::ShowSpeakerLabelsHasBeenSet ( ) const
inline

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.

Definition at line 63 of file MedicalTranscriptionSetting.h.

◆ VocabularyNameHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionSetting::VocabularyNameHasBeenSet ( ) const
inline

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

Definition at line 248 of file MedicalTranscriptionSetting.h.

◆ WithChannelIdentification()

MedicalTranscriptionSetting& Aws::TranscribeService::Model::MedicalTranscriptionSetting::WithChannelIdentification ( bool  value)
inline

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

Definition at line 173 of file MedicalTranscriptionSetting.h.

◆ WithMaxAlternatives()

MedicalTranscriptionSetting& Aws::TranscribeService::Model::MedicalTranscriptionSetting::WithMaxAlternatives ( int  value)
inline

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.

Definition at line 235 of file MedicalTranscriptionSetting.h.

◆ WithMaxSpeakerLabels()

MedicalTranscriptionSetting& Aws::TranscribeService::Model::MedicalTranscriptionSetting::WithMaxSpeakerLabels ( int  value)
inline

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.

Definition at line 120 of file MedicalTranscriptionSetting.h.

◆ WithShowAlternatives()

MedicalTranscriptionSetting& Aws::TranscribeService::Model::MedicalTranscriptionSetting::WithShowAlternatives ( bool  value)
inline

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.

Definition at line 206 of file MedicalTranscriptionSetting.h.

◆ WithShowSpeakerLabels()

MedicalTranscriptionSetting& Aws::TranscribeService::Model::MedicalTranscriptionSetting::WithShowSpeakerLabels ( bool  value)
inline

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.

Definition at line 87 of file MedicalTranscriptionSetting.h.

◆ WithVocabularyName() [1/3]

MedicalTranscriptionSetting& Aws::TranscribeService::Model::MedicalTranscriptionSetting::WithVocabularyName ( Aws::String &&  value)
inline

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

Definition at line 278 of file MedicalTranscriptionSetting.h.

◆ WithVocabularyName() [2/3]

MedicalTranscriptionSetting& Aws::TranscribeService::Model::MedicalTranscriptionSetting::WithVocabularyName ( const Aws::String value)
inline

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

Definition at line 272 of file MedicalTranscriptionSetting.h.

◆ WithVocabularyName() [3/3]

MedicalTranscriptionSetting& Aws::TranscribeService::Model::MedicalTranscriptionSetting::WithVocabularyName ( const char *  value)
inline

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

Definition at line 284 of file MedicalTranscriptionSetting.h.


The documentation for this class was generated from the following file: