Class: Aws::TranscribeService::Types::Settings

Inherits:

Struct

• Object
• Struct
• Aws::TranscribeService::Types::Settings

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #channel_identification ⇒ Boolean

  Enables channel identification in multi-channel audio.

• #max_alternatives ⇒ Integer

  Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.

• #max_speaker_labels ⇒ Integer

  Specify the maximum number of speakers you want to partition in your media.

• #show_alternatives ⇒ Boolean

  To include alternative transcriptions within your transcription output, include ‘ShowAlternatives` in your transcription request.

• #show_speaker_labels ⇒ Boolean

  Enables speaker partitioning (diarization) in your transcription output.

• #vocabulary_filter_method ⇒ String

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

• #vocabulary_filter_name ⇒ String

  The name of the custom vocabulary filter you want to use in your transcription job request.

• #vocabulary_name ⇒ String

  The name of the custom vocabulary you want to use in your transcription job request.

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.

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)

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

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

#max_alternatives ⇒ Integer

Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.

If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, 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)

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

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

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

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

#show_alternatives ⇒ Boolean

To include alternative transcriptions within your transcription output, include ‘ShowAlternatives` in your transcription request.

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.

If you include ‘ShowAlternatives`, you must also include `MaxAlternatives`, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.

For more information, see [Alternative transcriptions].

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

Returns:

• (Boolean)

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

class Settings < Struct.new(
  :vocabulary_name,
  :show_speaker_labels,
  :max_speaker_labels,
  :channel_identification,
  :show_alternatives,
  :max_alternatives,
  :vocabulary_filter_name,
  :vocabulary_filter_method)
  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 both ‘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)

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

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

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

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

#vocabulary_filter_name ⇒ String

The name of the custom vocabulary filter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

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

Returns:

• (String)

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

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

#vocabulary_name ⇒ String

The name of the custom vocabulary you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

Returns:

• (String)

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

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