Class: Aws::TranscribeService::Types::MedicalScribeSettings

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

Overview

Makes it possible to control how your Medical Scribe job is processed using a ‘MedicalScribeSettings` object. Specify `ChannelIdentification` if `ChannelDefinitions` are set. Enabled `ShowSpeakerLabels` if `ChannelIdentification` and `ChannelDefinitions` are not set. One and only one of `ChannelIdentification` and `ShowSpeakerLabels` must be set. If `ShowSpeakerLabels` is set, `MaxSpeakerLabels` must also be set. Use `Settings` to specify a vocabulary or vocabulary filter or both using `VocabularyName`, `VocabularyFilterName`. `VocabularyFilterMethod` must be specified if `VocabularyFilterName` is set.

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.

For more information, see [Transcribing multi-channel audio].

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

Returns:

  • (Boolean) 


3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 3198

class MedicalScribeSettings < Struct.new(
  :show_speaker_labels,
  :max_speaker_labels,
  :channel_identification,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :clinical_note_generation_settings)
  SENSITIVE = []
  include Aws::Structure
end

#clinical_note_generation_settings ⇒ Types::ClinicalNoteGenerationSettings

Specify settings for the clinical note generation.

Returns:



3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 3198

class MedicalScribeSettings < Struct.new(
  :show_speaker_labels,
  :max_speaker_labels,
  :channel_identification,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :clinical_note_generation_settings)
  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) 


3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 3198

class MedicalScribeSettings < Struct.new(
  :show_speaker_labels,
  :max_speaker_labels,
  :channel_identification,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :clinical_note_generation_settings)
  SENSITIVE = []
  include Aws::Structure
end

#show_speaker_labels ⇒ Boolean

Enables speaker partitioning (diarization) in your Medical Scribe 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)].

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

Returns:

  • (Boolean) 


3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 3198

class MedicalScribeSettings < Struct.new(
  :show_speaker_labels,
  :max_speaker_labels,
  :channel_identification,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :clinical_note_generation_settings)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_method ⇒ String

Specify how you want your custom vocabulary filter applied to your transcript.

To replace words with ‘***`, choose `mask`.

To delete words, choose ‘remove`.

To flag words without changing them, choose ‘tag`.

Returns:

  • (String) 


3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 3198

class MedicalScribeSettings < Struct.new(
  :show_speaker_labels,
  :max_speaker_labels,
  :channel_identification,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :clinical_note_generation_settings)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_name ⇒ String

The name of the custom vocabulary filter you want to include in your Medical Scribe request. Custom vocabulary filter names are case sensitive.

Note that if you include ‘VocabularyFilterName` in your request, you must also include `VocabularyFilterMethod`.

Returns:

  • (String) 


3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 3198

class MedicalScribeSettings < Struct.new(
  :show_speaker_labels,
  :max_speaker_labels,
  :channel_identification,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :clinical_note_generation_settings)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_name ⇒ String

The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive.

Returns:

  • (String) 


3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 3198

class MedicalScribeSettings < Struct.new(
  :show_speaker_labels,
  :max_speaker_labels,
  :channel_identification,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :clinical_note_generation_settings)
  SENSITIVE = []
  include Aws::Structure
end