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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-transcribeservice/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#channel_identificationBoolean

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.

For more information, see Transcribing multi-channel audio.

Returns:

  • (Boolean)


3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3438

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

#max_alternativesInteger

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.

Returns:

  • (Integer)


3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3438

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_labelsInteger

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)


3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3438

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

#show_alternativesBoolean

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.

Returns:

  • (Boolean)


3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3438

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_labelsBoolean

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.

For more information, see Partitioning speakers (diarization).

Returns:

  • (Boolean)


3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3438

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

#vocabulary_nameString

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 do not 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)


3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3438

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