Class: Aws::TranscribeService::Types::MedicalTranscriptionSetting

Inherits:

Struct

• Object
• Struct
• Aws::TranscribeService::Types::MedicalTranscriptionSetting

Defined in:

gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb

Overview

Note:

When making an API call, you may pass MedicalTranscriptionSetting data as a hash:

{
  show_speaker_labels: false,
  max_speaker_labels: 1,
  channel_identification: false,
  show_alternatives: false,
  max_alternatives: 1,
  vocabulary_name: "VocabularyName",
}

Optional settings for the StartMedicalTranscriptionJob operation.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #channel_identification ⇒ Boolean

  Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

• #max_alternatives ⇒ Integer

  The maximum number of alternatives that you tell the service to return.

• #max_speaker_labels ⇒ Integer

  The maximum number of speakers to identify in the input audio.

• #show_alternatives ⇒ Boolean

  Determines whether alternative transcripts are generated along with the transcript that has the highest confidence.

• #show_speaker_labels ⇒ Boolean

  Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.

• #vocabulary_name ⇒ String

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

Instance Attribute Details

#channel_identification ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 1730

class MedicalTranscriptionSetting < Struct.new(
  :show_speaker_labels,
  :max_speaker_labels,
  :channel_identification,
  :show_alternatives,
  :max_alternatives,
  :vocabulary_name)
  SENSITIVE = []
  include Aws::Structure
end

#max_alternatives ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 1730

class MedicalTranscriptionSetting < Struct.new(
  :show_speaker_labels,
  :max_speaker_labels,
  :channel_identification,
  :show_alternatives,
  :max_alternatives,
  :vocabulary_name)
  SENSITIVE = []
  include Aws::Structure
end

#max_speaker_labels ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 1730

class MedicalTranscriptionSetting < Struct.new(
  :show_speaker_labels,
  :max_speaker_labels,
  :channel_identification,
  :show_alternatives,
  :max_alternatives,
  :vocabulary_name)
  SENSITIVE = []
  include Aws::Structure
end

#show_alternatives ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 1730

class MedicalTranscriptionSetting < Struct.new(
  :show_speaker_labels,
  :max_speaker_labels,
  :channel_identification,
  :show_alternatives,
  :max_alternatives,
  :vocabulary_name)
  SENSITIVE = []
  include Aws::Structure
end

#show_speaker_labels ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 1730

class MedicalTranscriptionSetting < Struct.new(
  :show_speaker_labels,
  :max_speaker_labels,
  :channel_identification,
  :show_alternatives,
  :max_alternatives,
  :vocabulary_name)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 1730

class MedicalTranscriptionSetting < Struct.new(
  :show_speaker_labels,
  :max_speaker_labels,
  :channel_identification,
  :show_alternatives,
  :max_alternatives,
  :vocabulary_name)
  SENSITIVE = []
  include Aws::Structure
end