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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-transcribeservice/types.rb

Overview

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 Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#channel_identification ⇒ Boolean

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].

[1]: docs.aws.amazon.com/transcribe/latest/dg/channel-id.html

Returns:

  • (Boolean) 


2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2972

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

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].

[1]: docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html

Returns:

  • (Integer) 


2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2972

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

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.

Returns:

  • (Integer) 


2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2972

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

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].

[1]: docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html

Returns:

  • (Boolean) 


2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2972

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

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)].

[1]: docs.aws.amazon.com/transcribe/latest/dg/diarization.html

Returns:

  • (Boolean) 


2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2972

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 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.

Returns:

  • (String) 


2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2972

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