Class: Aws::TranscribeService::Types::Settings
- Inherits:
-
Struct
- Object
- Struct
- Aws::TranscribeService::Types::Settings
- Defined in:
- gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb
Overview
When making an API call, you may pass Settings data as a hash:
{
vocabulary_name: "VocabularyName",
show_speaker_labels: false,
max_speaker_labels: 1,
channel_identification: false,
show_alternatives: false,
max_alternatives: 1,
vocabulary_filter_name: "VocabularyFilterName",
vocabulary_filter_method: "remove", # accepts remove, mask
}
Provides optional settings for the StartTranscriptionJob
operation.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#channel_identification ⇒ Boolean
Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
-
#max_alternatives ⇒ Integer
The number of alternative transcriptions that the service should return.
-
#max_speaker_labels ⇒ Integer
The maximum number of speakers to identify in the input audio.
-
#show_alternatives ⇒ Boolean
Determines whether the transcription contains alternative transcriptions.
-
#show_speaker_labels ⇒ Boolean
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
-
#vocabulary_filter_method ⇒ String
Set to
mask
to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. -
#vocabulary_filter_name ⇒ String
The name of the vocabulary filter to use when transcribing the audio.
-
#vocabulary_name ⇒ String
The name of a vocabulary to use when processing the transcription job.
Instance Attribute Details
#channel_identification ⇒ Boolean
Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe 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 the item including the confidence that Amazon Transcribe has in the transcription.
You can't set both ShowSpeakerLabels
and ChannelIdentification
in the same request. If you set both, your request returns a
BadRequestException
.
1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 1861 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
The number of alternative transcriptions that the service should
return. If you specify the MaxAlternatives
field, you must set the
ShowAlternatives
field to true.
1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 1861 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
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.
1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 1861 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
Determines whether the transcription contains alternative
transcriptions. If you set the ShowAlternatives
field to true, you
must also set the maximum number of alternatives to return in the
MaxAlternatives
field.
1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 1861 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
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 MaxSpeakerLabels
field.
You can't set both ShowSpeakerLabels
and ChannelIdentification
in the same request. If you set both, your request returns a
BadRequestException
.
1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 1861 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
Set to mask
to remove filtered text from the transcript and
replace it with three asterisks ("***") as placeholder text.
Set to remove
to remove filtered text from the transcript without
using placeholder text.
1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 1861 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 vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.
1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 1861 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 a vocabulary to use when processing the transcription job.
1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 1861 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 |