1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// <p>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.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Settings {
/// <p>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.</p>
pub vocabulary_name: ::std::option::Option<::std::string::String>,
/// <p>Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.</p>
/// <p>If you enable <code>ShowSpeakerLabels</code> in your request, you must also include <code>MaxSpeakerLabels</code>.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers (diarization)</a>.</p>
pub show_speaker_labels: ::std::option::Option<bool>,
/// <p>Specify the maximum number of speakers you want to partition in your media.</p>
/// <p>Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.</p>
/// <p>If you specify the <code>MaxSpeakerLabels</code> field, you must set the <code>ShowSpeakerLabels</code> field to true.</p>
pub max_speaker_labels: ::std::option::Option<i32>,
/// <p>Enables channel identification in multi-channel audio.</p>
/// <p>Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel audio</a>.</p>
pub channel_identification: ::std::option::Option<bool>,
/// <p>To include alternative transcriptions within your transcription output, include <code>ShowAlternatives</code> in your transcription request.</p>
/// <p>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.</p>
/// <p>If you include <code>ShowAlternatives</code>, you must also include <code>MaxAlternatives</code>, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative transcriptions</a>.</p>
pub show_alternatives: ::std::option::Option<bool>,
/// <p>Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.</p>
/// <p>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.</p>
/// <p>If you include <code>MaxAlternatives</code> in your request, you must also include <code>ShowAlternatives</code> with a value of <code>true</code>.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative transcriptions</a>.</p>
pub max_alternatives: ::std::option::Option<i32>,
/// <p>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.</p>
/// <p>Note that if you include <code>VocabularyFilterName</code> in your request, you must also include <code>VocabularyFilterMethod</code>.</p>
pub vocabulary_filter_name: ::std::option::Option<::std::string::String>,
/// <p>Specify how you want your custom vocabulary filter applied to your transcript.</p>
/// <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
/// <p>To delete words, choose <code>remove</code>.</p>
/// <p>To flag words without changing them, choose <code>tag</code>.</p>
pub vocabulary_filter_method: ::std::option::Option<crate::types::VocabularyFilterMethod>,
}
impl Settings {
/// <p>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.</p>
pub fn vocabulary_name(&self) -> ::std::option::Option<&str> {
self.vocabulary_name.as_deref()
}
/// <p>Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.</p>
/// <p>If you enable <code>ShowSpeakerLabels</code> in your request, you must also include <code>MaxSpeakerLabels</code>.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers (diarization)</a>.</p>
pub fn show_speaker_labels(&self) -> ::std::option::Option<bool> {
self.show_speaker_labels
}
/// <p>Specify the maximum number of speakers you want to partition in your media.</p>
/// <p>Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.</p>
/// <p>If you specify the <code>MaxSpeakerLabels</code> field, you must set the <code>ShowSpeakerLabels</code> field to true.</p>
pub fn max_speaker_labels(&self) -> ::std::option::Option<i32> {
self.max_speaker_labels
}
/// <p>Enables channel identification in multi-channel audio.</p>
/// <p>Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel audio</a>.</p>
pub fn channel_identification(&self) -> ::std::option::Option<bool> {
self.channel_identification
}
/// <p>To include alternative transcriptions within your transcription output, include <code>ShowAlternatives</code> in your transcription request.</p>
/// <p>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.</p>
/// <p>If you include <code>ShowAlternatives</code>, you must also include <code>MaxAlternatives</code>, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative transcriptions</a>.</p>
pub fn show_alternatives(&self) -> ::std::option::Option<bool> {
self.show_alternatives
}
/// <p>Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.</p>
/// <p>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.</p>
/// <p>If you include <code>MaxAlternatives</code> in your request, you must also include <code>ShowAlternatives</code> with a value of <code>true</code>.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative transcriptions</a>.</p>
pub fn max_alternatives(&self) -> ::std::option::Option<i32> {
self.max_alternatives
}
/// <p>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.</p>
/// <p>Note that if you include <code>VocabularyFilterName</code> in your request, you must also include <code>VocabularyFilterMethod</code>.</p>
pub fn vocabulary_filter_name(&self) -> ::std::option::Option<&str> {
self.vocabulary_filter_name.as_deref()
}
/// <p>Specify how you want your custom vocabulary filter applied to your transcript.</p>
/// <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
/// <p>To delete words, choose <code>remove</code>.</p>
/// <p>To flag words without changing them, choose <code>tag</code>.</p>
pub fn vocabulary_filter_method(&self) -> ::std::option::Option<&crate::types::VocabularyFilterMethod> {
self.vocabulary_filter_method.as_ref()
}
}
impl Settings {
/// Creates a new builder-style object to manufacture [`Settings`](crate::types::Settings).
pub fn builder() -> crate::types::builders::SettingsBuilder {
crate::types::builders::SettingsBuilder::default()
}
}
/// A builder for [`Settings`](crate::types::Settings).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct SettingsBuilder {
pub(crate) vocabulary_name: ::std::option::Option<::std::string::String>,
pub(crate) show_speaker_labels: ::std::option::Option<bool>,
pub(crate) max_speaker_labels: ::std::option::Option<i32>,
pub(crate) channel_identification: ::std::option::Option<bool>,
pub(crate) show_alternatives: ::std::option::Option<bool>,
pub(crate) max_alternatives: ::std::option::Option<i32>,
pub(crate) vocabulary_filter_name: ::std::option::Option<::std::string::String>,
pub(crate) vocabulary_filter_method: ::std::option::Option<crate::types::VocabularyFilterMethod>,
}
impl SettingsBuilder {
/// <p>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.</p>
pub fn vocabulary_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.vocabulary_name = ::std::option::Option::Some(input.into());
self
}
/// <p>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.</p>
pub fn set_vocabulary_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.vocabulary_name = input;
self
}
/// <p>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.</p>
pub fn get_vocabulary_name(&self) -> &::std::option::Option<::std::string::String> {
&self.vocabulary_name
}
/// <p>Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.</p>
/// <p>If you enable <code>ShowSpeakerLabels</code> in your request, you must also include <code>MaxSpeakerLabels</code>.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers (diarization)</a>.</p>
pub fn show_speaker_labels(mut self, input: bool) -> Self {
self.show_speaker_labels = ::std::option::Option::Some(input);
self
}
/// <p>Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.</p>
/// <p>If you enable <code>ShowSpeakerLabels</code> in your request, you must also include <code>MaxSpeakerLabels</code>.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers (diarization)</a>.</p>
pub fn set_show_speaker_labels(mut self, input: ::std::option::Option<bool>) -> Self {
self.show_speaker_labels = input;
self
}
/// <p>Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.</p>
/// <p>If you enable <code>ShowSpeakerLabels</code> in your request, you must also include <code>MaxSpeakerLabels</code>.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers (diarization)</a>.</p>
pub fn get_show_speaker_labels(&self) -> &::std::option::Option<bool> {
&self.show_speaker_labels
}
/// <p>Specify the maximum number of speakers you want to partition in your media.</p>
/// <p>Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.</p>
/// <p>If you specify the <code>MaxSpeakerLabels</code> field, you must set the <code>ShowSpeakerLabels</code> field to true.</p>
pub fn max_speaker_labels(mut self, input: i32) -> Self {
self.max_speaker_labels = ::std::option::Option::Some(input);
self
}
/// <p>Specify the maximum number of speakers you want to partition in your media.</p>
/// <p>Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.</p>
/// <p>If you specify the <code>MaxSpeakerLabels</code> field, you must set the <code>ShowSpeakerLabels</code> field to true.</p>
pub fn set_max_speaker_labels(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_speaker_labels = input;
self
}
/// <p>Specify the maximum number of speakers you want to partition in your media.</p>
/// <p>Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.</p>
/// <p>If you specify the <code>MaxSpeakerLabels</code> field, you must set the <code>ShowSpeakerLabels</code> field to true.</p>
pub fn get_max_speaker_labels(&self) -> &::std::option::Option<i32> {
&self.max_speaker_labels
}
/// <p>Enables channel identification in multi-channel audio.</p>
/// <p>Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel audio</a>.</p>
pub fn channel_identification(mut self, input: bool) -> Self {
self.channel_identification = ::std::option::Option::Some(input);
self
}
/// <p>Enables channel identification in multi-channel audio.</p>
/// <p>Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel audio</a>.</p>
pub fn set_channel_identification(mut self, input: ::std::option::Option<bool>) -> Self {
self.channel_identification = input;
self
}
/// <p>Enables channel identification in multi-channel audio.</p>
/// <p>Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel audio</a>.</p>
pub fn get_channel_identification(&self) -> &::std::option::Option<bool> {
&self.channel_identification
}
/// <p>To include alternative transcriptions within your transcription output, include <code>ShowAlternatives</code> in your transcription request.</p>
/// <p>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.</p>
/// <p>If you include <code>ShowAlternatives</code>, you must also include <code>MaxAlternatives</code>, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative transcriptions</a>.</p>
pub fn show_alternatives(mut self, input: bool) -> Self {
self.show_alternatives = ::std::option::Option::Some(input);
self
}
/// <p>To include alternative transcriptions within your transcription output, include <code>ShowAlternatives</code> in your transcription request.</p>
/// <p>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.</p>
/// <p>If you include <code>ShowAlternatives</code>, you must also include <code>MaxAlternatives</code>, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative transcriptions</a>.</p>
pub fn set_show_alternatives(mut self, input: ::std::option::Option<bool>) -> Self {
self.show_alternatives = input;
self
}
/// <p>To include alternative transcriptions within your transcription output, include <code>ShowAlternatives</code> in your transcription request.</p>
/// <p>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.</p>
/// <p>If you include <code>ShowAlternatives</code>, you must also include <code>MaxAlternatives</code>, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative transcriptions</a>.</p>
pub fn get_show_alternatives(&self) -> &::std::option::Option<bool> {
&self.show_alternatives
}
/// <p>Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.</p>
/// <p>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.</p>
/// <p>If you include <code>MaxAlternatives</code> in your request, you must also include <code>ShowAlternatives</code> with a value of <code>true</code>.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative transcriptions</a>.</p>
pub fn max_alternatives(mut self, input: i32) -> Self {
self.max_alternatives = ::std::option::Option::Some(input);
self
}
/// <p>Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.</p>
/// <p>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.</p>
/// <p>If you include <code>MaxAlternatives</code> in your request, you must also include <code>ShowAlternatives</code> with a value of <code>true</code>.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative transcriptions</a>.</p>
pub fn set_max_alternatives(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_alternatives = input;
self
}
/// <p>Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.</p>
/// <p>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.</p>
/// <p>If you include <code>MaxAlternatives</code> in your request, you must also include <code>ShowAlternatives</code> with a value of <code>true</code>.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative transcriptions</a>.</p>
pub fn get_max_alternatives(&self) -> &::std::option::Option<i32> {
&self.max_alternatives
}
/// <p>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.</p>
/// <p>Note that if you include <code>VocabularyFilterName</code> in your request, you must also include <code>VocabularyFilterMethod</code>.</p>
pub fn vocabulary_filter_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.vocabulary_filter_name = ::std::option::Option::Some(input.into());
self
}
/// <p>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.</p>
/// <p>Note that if you include <code>VocabularyFilterName</code> in your request, you must also include <code>VocabularyFilterMethod</code>.</p>
pub fn set_vocabulary_filter_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.vocabulary_filter_name = input;
self
}
/// <p>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.</p>
/// <p>Note that if you include <code>VocabularyFilterName</code> in your request, you must also include <code>VocabularyFilterMethod</code>.</p>
pub fn get_vocabulary_filter_name(&self) -> &::std::option::Option<::std::string::String> {
&self.vocabulary_filter_name
}
/// <p>Specify how you want your custom vocabulary filter applied to your transcript.</p>
/// <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
/// <p>To delete words, choose <code>remove</code>.</p>
/// <p>To flag words without changing them, choose <code>tag</code>.</p>
pub fn vocabulary_filter_method(mut self, input: crate::types::VocabularyFilterMethod) -> Self {
self.vocabulary_filter_method = ::std::option::Option::Some(input);
self
}
/// <p>Specify how you want your custom vocabulary filter applied to your transcript.</p>
/// <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
/// <p>To delete words, choose <code>remove</code>.</p>
/// <p>To flag words without changing them, choose <code>tag</code>.</p>
pub fn set_vocabulary_filter_method(mut self, input: ::std::option::Option<crate::types::VocabularyFilterMethod>) -> Self {
self.vocabulary_filter_method = input;
self
}
/// <p>Specify how you want your custom vocabulary filter applied to your transcript.</p>
/// <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
/// <p>To delete words, choose <code>remove</code>.</p>
/// <p>To flag words without changing them, choose <code>tag</code>.</p>
pub fn get_vocabulary_filter_method(&self) -> &::std::option::Option<crate::types::VocabularyFilterMethod> {
&self.vocabulary_filter_method
}
/// Consumes the builder and constructs a [`Settings`](crate::types::Settings).
pub fn build(self) -> crate::types::Settings {
crate::types::Settings {
vocabulary_name: self.vocabulary_name,
show_speaker_labels: self.show_speaker_labels,
max_speaker_labels: self.max_speaker_labels,
channel_identification: self.channel_identification,
show_alternatives: self.show_alternatives,
max_alternatives: self.max_alternatives,
vocabulary_filter_name: self.vocabulary_filter_name,
vocabulary_filter_method: self.vocabulary_filter_method,
}
}
}