aws_sdk_transcribestreaming/operation/start_call_analytics_stream_transcription/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::start_call_analytics_stream_transcription::_start_call_analytics_stream_transcription_output::StartCallAnalyticsStreamTranscriptionOutputBuilder;
3
4pub use crate::operation::start_call_analytics_stream_transcription::_start_call_analytics_stream_transcription_input::StartCallAnalyticsStreamTranscriptionInputBuilder;
5
6impl crate::operation::start_call_analytics_stream_transcription::builders::StartCallAnalyticsStreamTranscriptionInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(self, client: &crate::Client) -> ::std::result::Result<
9 crate::operation::start_call_analytics_stream_transcription::StartCallAnalyticsStreamTranscriptionOutput,
10 ::aws_smithy_runtime_api::client::result::SdkError<
11 crate::operation::start_call_analytics_stream_transcription::StartCallAnalyticsStreamTranscriptionError,
12 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse
13 >
14 > {
15 let mut fluent_builder = client.start_call_analytics_stream_transcription();
16 fluent_builder.inner = self;
17 fluent_builder.send().await
18 }
19 }
20/// Fluent builder constructing a request to `StartCallAnalyticsStreamTranscription`.
21///
22/// <p>Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application. Use this operation for <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html">Call Analytics</a> transcriptions.</p>
23/// <p>The following parameters are required:</p>
24/// <ul>
25/// <li>
26/// <p><code>language-code</code> or <code>identify-language</code></p></li>
27/// <li>
28/// <p><code>media-encoding</code></p></li>
29/// <li>
30/// <p><code>sample-rate</code></p></li>
31/// </ul>
32/// <p>For more information on streaming with Amazon Transcribe, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
33#[derive(::std::fmt::Debug)]
34pub struct StartCallAnalyticsStreamTranscriptionFluentBuilder {
35 handle: ::std::sync::Arc<crate::client::Handle>,
36 inner: crate::operation::start_call_analytics_stream_transcription::builders::StartCallAnalyticsStreamTranscriptionInputBuilder,
37config_override: ::std::option::Option<crate::config::Builder>,
38 }
39impl
40 crate::client::customize::internal::CustomizableSend<
41 crate::operation::start_call_analytics_stream_transcription::StartCallAnalyticsStreamTranscriptionOutput,
42 crate::operation::start_call_analytics_stream_transcription::StartCallAnalyticsStreamTranscriptionError,
43 > for StartCallAnalyticsStreamTranscriptionFluentBuilder
44 {
45 fn send(
46 self,
47 config_override: crate::config::Builder,
48 ) -> crate::client::customize::internal::BoxFuture<
49 crate::client::customize::internal::SendResult<
50 crate::operation::start_call_analytics_stream_transcription::StartCallAnalyticsStreamTranscriptionOutput,
51 crate::operation::start_call_analytics_stream_transcription::StartCallAnalyticsStreamTranscriptionError,
52 >,
53 > {
54 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
55 }
56 }
57impl StartCallAnalyticsStreamTranscriptionFluentBuilder {
58 /// Creates a new `StartCallAnalyticsStreamTranscriptionFluentBuilder`.
59 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
60 Self {
61 handle,
62 inner: ::std::default::Default::default(),
63 config_override: ::std::option::Option::None,
64 }
65 }
66 /// Access the StartCallAnalyticsStreamTranscription as a reference.
67 pub fn as_input(&self) -> &crate::operation::start_call_analytics_stream_transcription::builders::StartCallAnalyticsStreamTranscriptionInputBuilder {
68 &self.inner
69 }
70 /// Sends the request and returns the response.
71 ///
72 /// If an error occurs, an `SdkError` will be returned with additional details that
73 /// can be matched against.
74 ///
75 /// By default, any retryable failures will be retried twice. Retry behavior
76 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
77 /// set when configuring the client.
78 pub async fn send(self) -> ::std::result::Result<crate::operation::start_call_analytics_stream_transcription::StartCallAnalyticsStreamTranscriptionOutput, ::aws_smithy_runtime_api::client::result::SdkError<crate::operation::start_call_analytics_stream_transcription::StartCallAnalyticsStreamTranscriptionError, ::aws_smithy_runtime_api::client::orchestrator::HttpResponse>> {
79 let input = self.inner.build().map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
80 let runtime_plugins = crate::operation::start_call_analytics_stream_transcription::StartCallAnalyticsStreamTranscription::operation_runtime_plugins(
81 self.handle.runtime_plugins.clone(),
82 &self.handle.conf,
83 self.config_override,
84 );
85 crate::operation::start_call_analytics_stream_transcription::StartCallAnalyticsStreamTranscription::orchestrate(&runtime_plugins, input).await
86 }
87
88 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
89 pub fn customize(
90 self,
91 ) -> crate::client::customize::CustomizableOperation<crate::operation::start_call_analytics_stream_transcription::StartCallAnalyticsStreamTranscriptionOutput, crate::operation::start_call_analytics_stream_transcription::StartCallAnalyticsStreamTranscriptionError, Self> {
92 crate::client::customize::CustomizableOperation::new(self)
93 }
94 pub(crate) fn config_override(
95 mut self,
96 config_override: impl ::std::convert::Into<crate::config::Builder>,
97 ) -> Self {
98 self.set_config_override(::std::option::Option::Some(config_override.into()));
99 self
100 }
101
102 pub(crate) fn set_config_override(
103 &mut self,
104 config_override: ::std::option::Option<crate::config::Builder>,
105 ) -> &mut Self {
106 self.config_override = config_override;
107 self
108 }
109 /// <p>Specify the language code that represents the language spoken in your audio.</p>
110 /// <p>For a list of languages supported with real-time Call Analytics, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
111 pub fn language_code(mut self, input: crate::types::CallAnalyticsLanguageCode) -> Self {
112 self.inner = self.inner.language_code(input);
113 self
114 }
115 /// <p>Specify the language code that represents the language spoken in your audio.</p>
116 /// <p>For a list of languages supported with real-time Call Analytics, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
117 pub fn set_language_code(mut self, input: ::std::option::Option<crate::types::CallAnalyticsLanguageCode>) -> Self {
118 self.inner = self.inner.set_language_code(input);
119 self
120 }
121 /// <p>Specify the language code that represents the language spoken in your audio.</p>
122 /// <p>For a list of languages supported with real-time Call Analytics, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
123 pub fn get_language_code(&self) -> &::std::option::Option<crate::types::CallAnalyticsLanguageCode> {
124 self.inner.get_language_code()
125 }
126 /// <p>The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio, is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.</p>
127 pub fn media_sample_rate_hertz(mut self, input: i32) -> Self {
128 self.inner = self.inner.media_sample_rate_hertz(input);
129 self
130 }
131 /// <p>The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio, is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.</p>
132 pub fn set_media_sample_rate_hertz(mut self, input: ::std::option::Option<i32>) -> Self {
133 self.inner = self.inner.set_media_sample_rate_hertz(input);
134 self
135 }
136 /// <p>The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio, is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.</p>
137 pub fn get_media_sample_rate_hertz(&self) -> &::std::option::Option<i32> {
138 self.inner.get_media_sample_rate_hertz()
139 }
140 /// <p>Specify the encoding of your input audio. Supported formats are:</p>
141 /// <ul>
142 /// <li>
143 /// <p>FLAC</p></li>
144 /// <li>
145 /// <p>OPUS-encoded audio in an Ogg container</p></li>
146 /// <li>
147 /// <p>PCM (only signed 16-bit little-endian audio formats, which does not include WAV)</p></li>
148 /// </ul>
149 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a>.</p>
150 pub fn media_encoding(mut self, input: crate::types::MediaEncoding) -> Self {
151 self.inner = self.inner.media_encoding(input);
152 self
153 }
154 /// <p>Specify the encoding of your input audio. Supported formats are:</p>
155 /// <ul>
156 /// <li>
157 /// <p>FLAC</p></li>
158 /// <li>
159 /// <p>OPUS-encoded audio in an Ogg container</p></li>
160 /// <li>
161 /// <p>PCM (only signed 16-bit little-endian audio formats, which does not include WAV)</p></li>
162 /// </ul>
163 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a>.</p>
164 pub fn set_media_encoding(mut self, input: ::std::option::Option<crate::types::MediaEncoding>) -> Self {
165 self.inner = self.inner.set_media_encoding(input);
166 self
167 }
168 /// <p>Specify the encoding of your input audio. Supported formats are:</p>
169 /// <ul>
170 /// <li>
171 /// <p>FLAC</p></li>
172 /// <li>
173 /// <p>OPUS-encoded audio in an Ogg container</p></li>
174 /// <li>
175 /// <p>PCM (only signed 16-bit little-endian audio formats, which does not include WAV)</p></li>
176 /// </ul>
177 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a>.</p>
178 pub fn get_media_encoding(&self) -> &::std::option::Option<crate::types::MediaEncoding> {
179 self.inner.get_media_encoding()
180 }
181 /// <p>Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.</p>
182 /// <p>If the language of the specified custom vocabulary doesn't match the language identified in your media, the custom vocabulary is not applied to your transcription.</p>
183 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
184 pub fn vocabulary_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
185 self.inner = self.inner.vocabulary_name(input.into());
186 self
187 }
188 /// <p>Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.</p>
189 /// <p>If the language of the specified custom vocabulary doesn't match the language identified in your media, the custom vocabulary is not applied to your transcription.</p>
190 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
191 pub fn set_vocabulary_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
192 self.inner = self.inner.set_vocabulary_name(input);
193 self
194 }
195 /// <p>Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.</p>
196 /// <p>If the language of the specified custom vocabulary doesn't match the language identified in your media, the custom vocabulary is not applied to your transcription.</p>
197 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
198 pub fn get_vocabulary_name(&self) -> &::std::option::Option<::std::string::String> {
199 self.inner.get_vocabulary_name()
200 }
201 /// <p>Specify a name for your Call Analytics transcription session. If you don't include this parameter in your request, Amazon Transcribe generates an ID and returns it in the response.</p>
202 pub fn session_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
203 self.inner = self.inner.session_id(input.into());
204 self
205 }
206 /// <p>Specify a name for your Call Analytics transcription session. If you don't include this parameter in your request, Amazon Transcribe generates an ID and returns it in the response.</p>
207 pub fn set_session_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
208 self.inner = self.inner.set_session_id(input);
209 self
210 }
211 /// <p>Specify a name for your Call Analytics transcription session. If you don't include this parameter in your request, Amazon Transcribe generates an ID and returns it in the response.</p>
212 pub fn get_session_id(&self) -> &::std::option::Option<::std::string::String> {
213 self.inner.get_session_id()
214 }
215 /// <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.</p>
216 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
217 pub fn audio_stream(mut self, input: ::aws_smithy_http::event_stream::EventStreamSender<crate::types::AudioStream, crate::types::error::AudioStreamError>) -> Self {
218 self.inner = self.inner.audio_stream(input);
219 self
220 }
221 /// <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.</p>
222 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
223 pub fn set_audio_stream(mut self, input: ::std::option::Option<::aws_smithy_http::event_stream::EventStreamSender<crate::types::AudioStream, crate::types::error::AudioStreamError>>) -> Self {
224 self.inner = self.inner.set_audio_stream(input);
225 self
226 }
227 /// <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.</p>
228 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
229 pub fn get_audio_stream(&self) -> &::std::option::Option<::aws_smithy_http::event_stream::EventStreamSender<crate::types::AudioStream, crate::types::error::AudioStreamError>> {
230 self.inner.get_audio_stream()
231 }
232 /// <p>Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.</p>
233 /// <p>If the language of the specified custom vocabulary filter doesn't match the language identified in your media, the vocabulary filter is not applied to your transcription.</p>
234 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Using vocabulary filtering with unwanted words</a>.</p>
235 pub fn vocabulary_filter_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
236 self.inner = self.inner.vocabulary_filter_name(input.into());
237 self
238 }
239 /// <p>Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.</p>
240 /// <p>If the language of the specified custom vocabulary filter doesn't match the language identified in your media, the vocabulary filter is not applied to your transcription.</p>
241 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Using vocabulary filtering with unwanted words</a>.</p>
242 pub fn set_vocabulary_filter_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
243 self.inner = self.inner.set_vocabulary_filter_name(input);
244 self
245 }
246 /// <p>Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.</p>
247 /// <p>If the language of the specified custom vocabulary filter doesn't match the language identified in your media, the vocabulary filter is not applied to your transcription.</p>
248 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Using vocabulary filtering with unwanted words</a>.</p>
249 pub fn get_vocabulary_filter_name(&self) -> &::std::option::Option<::std::string::String> {
250 self.inner.get_vocabulary_filter_name()
251 }
252 /// <p>Specify how you want your vocabulary filter applied to your transcript.</p>
253 /// <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
254 /// <p>To delete words, choose <code>remove</code>.</p>
255 /// <p>To flag words without changing them, choose <code>tag</code>.</p>
256 pub fn vocabulary_filter_method(mut self, input: crate::types::VocabularyFilterMethod) -> Self {
257 self.inner = self.inner.vocabulary_filter_method(input);
258 self
259 }
260 /// <p>Specify how you want your vocabulary filter applied to your transcript.</p>
261 /// <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
262 /// <p>To delete words, choose <code>remove</code>.</p>
263 /// <p>To flag words without changing them, choose <code>tag</code>.</p>
264 pub fn set_vocabulary_filter_method(mut self, input: ::std::option::Option<crate::types::VocabularyFilterMethod>) -> Self {
265 self.inner = self.inner.set_vocabulary_filter_method(input);
266 self
267 }
268 /// <p>Specify how you want your vocabulary filter applied to your transcript.</p>
269 /// <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
270 /// <p>To delete words, choose <code>remove</code>.</p>
271 /// <p>To flag words without changing them, choose <code>tag</code>.</p>
272 pub fn get_vocabulary_filter_method(&self) -> &::std::option::Option<crate::types::VocabularyFilterMethod> {
273 self.inner.get_vocabulary_filter_method()
274 }
275 /// <p>Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.</p>
276 /// <p>The language of the specified language model must match the language code you specify in your transcription request. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.</p>
277 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language models</a>.</p>
278 pub fn language_model_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
279 self.inner = self.inner.language_model_name(input.into());
280 self
281 }
282 /// <p>Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.</p>
283 /// <p>The language of the specified language model must match the language code you specify in your transcription request. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.</p>
284 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language models</a>.</p>
285 pub fn set_language_model_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
286 self.inner = self.inner.set_language_model_name(input);
287 self
288 }
289 /// <p>Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.</p>
290 /// <p>The language of the specified language model must match the language code you specify in your transcription request. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.</p>
291 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language models</a>.</p>
292 pub fn get_language_model_name(&self) -> &::std::option::Option<::std::string::String> {
293 self.inner.get_language_model_name()
294 }
295 /// <p>Enables automatic language identification for your Call Analytics transcription.</p>
296 /// <p>If you include <code>IdentifyLanguage</code>, you must include a list of language codes, using <code>LanguageOptions</code>, that you think may be present in your audio stream. You must provide a minimum of two language selections.</p>
297 /// <p>You can also include a preferred language using <code>PreferredLanguage</code>. Adding a preferred language can help Amazon Transcribe identify the language faster than if you omit this parameter.</p>
298 /// <p>Note that you must include either <code>LanguageCode</code> or <code>IdentifyLanguage</code> in your request. If you include both parameters, your transcription job fails.</p>
299 pub fn identify_language(mut self, input: bool) -> Self {
300 self.inner = self.inner.identify_language(input);
301 self
302 }
303 /// <p>Enables automatic language identification for your Call Analytics transcription.</p>
304 /// <p>If you include <code>IdentifyLanguage</code>, you must include a list of language codes, using <code>LanguageOptions</code>, that you think may be present in your audio stream. You must provide a minimum of two language selections.</p>
305 /// <p>You can also include a preferred language using <code>PreferredLanguage</code>. Adding a preferred language can help Amazon Transcribe identify the language faster than if you omit this parameter.</p>
306 /// <p>Note that you must include either <code>LanguageCode</code> or <code>IdentifyLanguage</code> in your request. If you include both parameters, your transcription job fails.</p>
307 pub fn set_identify_language(mut self, input: ::std::option::Option<bool>) -> Self {
308 self.inner = self.inner.set_identify_language(input);
309 self
310 }
311 /// <p>Enables automatic language identification for your Call Analytics transcription.</p>
312 /// <p>If you include <code>IdentifyLanguage</code>, you must include a list of language codes, using <code>LanguageOptions</code>, that you think may be present in your audio stream. You must provide a minimum of two language selections.</p>
313 /// <p>You can also include a preferred language using <code>PreferredLanguage</code>. Adding a preferred language can help Amazon Transcribe identify the language faster than if you omit this parameter.</p>
314 /// <p>Note that you must include either <code>LanguageCode</code> or <code>IdentifyLanguage</code> in your request. If you include both parameters, your transcription job fails.</p>
315 pub fn get_identify_language(&self) -> &::std::option::Option<bool> {
316 self.inner.get_identify_language()
317 }
318 /// <p>Specify two or more language codes that represent the languages you think may be present in your media.</p>
319 /// <p>Including language options can improve the accuracy of language identification.</p>
320 /// <p>If you include <code>LanguageOptions</code> in your request, you must also include <code>IdentifyLanguage</code>.</p>
321 /// <p>For a list of languages supported with Call Analytics streaming, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p><important>
322 /// <p>You can only include one language dialect per language per stream. For example, you cannot include <code>en-US</code> and <code>en-AU</code> in the same request.</p>
323 /// </important>
324 pub fn language_options(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
325 self.inner = self.inner.language_options(input.into());
326 self
327 }
328 /// <p>Specify two or more language codes that represent the languages you think may be present in your media.</p>
329 /// <p>Including language options can improve the accuracy of language identification.</p>
330 /// <p>If you include <code>LanguageOptions</code> in your request, you must also include <code>IdentifyLanguage</code>.</p>
331 /// <p>For a list of languages supported with Call Analytics streaming, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p><important>
332 /// <p>You can only include one language dialect per language per stream. For example, you cannot include <code>en-US</code> and <code>en-AU</code> in the same request.</p>
333 /// </important>
334 pub fn set_language_options(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
335 self.inner = self.inner.set_language_options(input);
336 self
337 }
338 /// <p>Specify two or more language codes that represent the languages you think may be present in your media.</p>
339 /// <p>Including language options can improve the accuracy of language identification.</p>
340 /// <p>If you include <code>LanguageOptions</code> in your request, you must also include <code>IdentifyLanguage</code>.</p>
341 /// <p>For a list of languages supported with Call Analytics streaming, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p><important>
342 /// <p>You can only include one language dialect per language per stream. For example, you cannot include <code>en-US</code> and <code>en-AU</code> in the same request.</p>
343 /// </important>
344 pub fn get_language_options(&self) -> &::std::option::Option<::std::string::String> {
345 self.inner.get_language_options()
346 }
347 /// <p>Specify a preferred language from the subset of languages codes you specified in <code>LanguageOptions</code>.</p>
348 /// <p>You can only use this parameter if you've included <code>IdentifyLanguage</code> and <code>LanguageOptions</code> in your request.</p>
349 pub fn preferred_language(mut self, input: crate::types::CallAnalyticsLanguageCode) -> Self {
350 self.inner = self.inner.preferred_language(input);
351 self
352 }
353 /// <p>Specify a preferred language from the subset of languages codes you specified in <code>LanguageOptions</code>.</p>
354 /// <p>You can only use this parameter if you've included <code>IdentifyLanguage</code> and <code>LanguageOptions</code> in your request.</p>
355 pub fn set_preferred_language(mut self, input: ::std::option::Option<crate::types::CallAnalyticsLanguageCode>) -> Self {
356 self.inner = self.inner.set_preferred_language(input);
357 self
358 }
359 /// <p>Specify a preferred language from the subset of languages codes you specified in <code>LanguageOptions</code>.</p>
360 /// <p>You can only use this parameter if you've included <code>IdentifyLanguage</code> and <code>LanguageOptions</code> in your request.</p>
361 pub fn get_preferred_language(&self) -> &::std::option::Option<crate::types::CallAnalyticsLanguageCode> {
362 self.inner.get_preferred_language()
363 }
364 /// <p>Specify the names of the custom vocabularies that you want to use when processing your Call Analytics transcription. Note that vocabulary names are case sensitive.</p>
365 /// <p>If the custom vocabulary's language doesn't match the identified media language, it won't be applied to the transcription.</p><important>
366 /// <p>This parameter is only intended for use <b>with</b> the <code>IdentifyLanguage</code> parameter. If you're <b>not</b> including <code>IdentifyLanguage</code> in your request and want to use a custom vocabulary with your transcription, use the <code>VocabularyName</code> parameter instead.</p>
367 /// </important>
368 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
369 pub fn vocabulary_names(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
370 self.inner = self.inner.vocabulary_names(input.into());
371 self
372 }
373 /// <p>Specify the names of the custom vocabularies that you want to use when processing your Call Analytics transcription. Note that vocabulary names are case sensitive.</p>
374 /// <p>If the custom vocabulary's language doesn't match the identified media language, it won't be applied to the transcription.</p><important>
375 /// <p>This parameter is only intended for use <b>with</b> the <code>IdentifyLanguage</code> parameter. If you're <b>not</b> including <code>IdentifyLanguage</code> in your request and want to use a custom vocabulary with your transcription, use the <code>VocabularyName</code> parameter instead.</p>
376 /// </important>
377 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
378 pub fn set_vocabulary_names(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
379 self.inner = self.inner.set_vocabulary_names(input);
380 self
381 }
382 /// <p>Specify the names of the custom vocabularies that you want to use when processing your Call Analytics transcription. Note that vocabulary names are case sensitive.</p>
383 /// <p>If the custom vocabulary's language doesn't match the identified media language, it won't be applied to the transcription.</p><important>
384 /// <p>This parameter is only intended for use <b>with</b> the <code>IdentifyLanguage</code> parameter. If you're <b>not</b> including <code>IdentifyLanguage</code> in your request and want to use a custom vocabulary with your transcription, use the <code>VocabularyName</code> parameter instead.</p>
385 /// </important>
386 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
387 pub fn get_vocabulary_names(&self) -> &::std::option::Option<::std::string::String> {
388 self.inner.get_vocabulary_names()
389 }
390 /// <p>Specify the names of the custom vocabulary filters that you want to use when processing your Call Analytics transcription. Note that vocabulary filter names are case sensitive.</p>
391 /// <p>These filters serve to customize the transcript output.</p><important>
392 /// <p>This parameter is only intended for use <b>with</b> the <code>IdentifyLanguage</code> parameter. If you're <b>not</b> including <code>IdentifyLanguage</code> in your request and want to use a custom vocabulary filter with your transcription, use the <code>VocabularyFilterName</code> parameter instead.</p>
393 /// </important>
394 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Using vocabulary filtering with unwanted words</a>.</p>
395 pub fn vocabulary_filter_names(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
396 self.inner = self.inner.vocabulary_filter_names(input.into());
397 self
398 }
399 /// <p>Specify the names of the custom vocabulary filters that you want to use when processing your Call Analytics transcription. Note that vocabulary filter names are case sensitive.</p>
400 /// <p>These filters serve to customize the transcript output.</p><important>
401 /// <p>This parameter is only intended for use <b>with</b> the <code>IdentifyLanguage</code> parameter. If you're <b>not</b> including <code>IdentifyLanguage</code> in your request and want to use a custom vocabulary filter with your transcription, use the <code>VocabularyFilterName</code> parameter instead.</p>
402 /// </important>
403 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Using vocabulary filtering with unwanted words</a>.</p>
404 pub fn set_vocabulary_filter_names(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
405 self.inner = self.inner.set_vocabulary_filter_names(input);
406 self
407 }
408 /// <p>Specify the names of the custom vocabulary filters that you want to use when processing your Call Analytics transcription. Note that vocabulary filter names are case sensitive.</p>
409 /// <p>These filters serve to customize the transcript output.</p><important>
410 /// <p>This parameter is only intended for use <b>with</b> the <code>IdentifyLanguage</code> parameter. If you're <b>not</b> including <code>IdentifyLanguage</code> in your request and want to use a custom vocabulary filter with your transcription, use the <code>VocabularyFilterName</code> parameter instead.</p>
411 /// </important>
412 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Using vocabulary filtering with unwanted words</a>.</p>
413 pub fn get_vocabulary_filter_names(&self) -> &::std::option::Option<::std::string::String> {
414 self.inner.get_vocabulary_filter_names()
415 }
416 /// <p>Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization">Partial-result stabilization</a>.</p>
417 pub fn enable_partial_results_stabilization(mut self, input: bool) -> Self {
418 self.inner = self.inner.enable_partial_results_stabilization(input);
419 self
420 }
421 /// <p>Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization">Partial-result stabilization</a>.</p>
422 pub fn set_enable_partial_results_stabilization(mut self, input: ::std::option::Option<bool>) -> Self {
423 self.inner = self.inner.set_enable_partial_results_stabilization(input);
424 self
425 }
426 /// <p>Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization">Partial-result stabilization</a>.</p>
427 pub fn get_enable_partial_results_stabilization(&self) -> &::std::option::Option<bool> {
428 self.inner.get_enable_partial_results_stabilization()
429 }
430 /// <p>Specify the level of stability to use when you enable partial results stabilization (<code>EnablePartialResultsStabilization</code>).</p>
431 /// <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.</p>
432 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization">Partial-result stabilization</a>.</p>
433 pub fn partial_results_stability(mut self, input: crate::types::PartialResultsStability) -> Self {
434 self.inner = self.inner.partial_results_stability(input);
435 self
436 }
437 /// <p>Specify the level of stability to use when you enable partial results stabilization (<code>EnablePartialResultsStabilization</code>).</p>
438 /// <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.</p>
439 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization">Partial-result stabilization</a>.</p>
440 pub fn set_partial_results_stability(mut self, input: ::std::option::Option<crate::types::PartialResultsStability>) -> Self {
441 self.inner = self.inner.set_partial_results_stability(input);
442 self
443 }
444 /// <p>Specify the level of stability to use when you enable partial results stabilization (<code>EnablePartialResultsStabilization</code>).</p>
445 /// <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.</p>
446 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization">Partial-result stabilization</a>.</p>
447 pub fn get_partial_results_stability(&self) -> &::std::option::Option<crate::types::PartialResultsStability> {
448 self.inner.get_partial_results_stability()
449 }
450 /// <p>Labels all personally identifiable information (PII) identified in your transcript.</p>
451 /// <p>Content identification is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is flagged upon complete transcription of an audio segment. If you don't include <code>PiiEntityTypes</code> in your request, all PII is identified.</p>
452 /// <p>You can’t set <code>ContentIdentificationType</code> and <code>ContentRedactionType</code> in the same request. If you set both, your request returns a <code>BadRequestException</code>.</p>
453 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html">Redacting or identifying personally identifiable information</a>.</p>
454 pub fn content_identification_type(mut self, input: crate::types::ContentIdentificationType) -> Self {
455 self.inner = self.inner.content_identification_type(input);
456 self
457 }
458 /// <p>Labels all personally identifiable information (PII) identified in your transcript.</p>
459 /// <p>Content identification is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is flagged upon complete transcription of an audio segment. If you don't include <code>PiiEntityTypes</code> in your request, all PII is identified.</p>
460 /// <p>You can’t set <code>ContentIdentificationType</code> and <code>ContentRedactionType</code> in the same request. If you set both, your request returns a <code>BadRequestException</code>.</p>
461 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html">Redacting or identifying personally identifiable information</a>.</p>
462 pub fn set_content_identification_type(mut self, input: ::std::option::Option<crate::types::ContentIdentificationType>) -> Self {
463 self.inner = self.inner.set_content_identification_type(input);
464 self
465 }
466 /// <p>Labels all personally identifiable information (PII) identified in your transcript.</p>
467 /// <p>Content identification is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is flagged upon complete transcription of an audio segment. If you don't include <code>PiiEntityTypes</code> in your request, all PII is identified.</p>
468 /// <p>You can’t set <code>ContentIdentificationType</code> and <code>ContentRedactionType</code> in the same request. If you set both, your request returns a <code>BadRequestException</code>.</p>
469 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html">Redacting or identifying personally identifiable information</a>.</p>
470 pub fn get_content_identification_type(&self) -> &::std::option::Option<crate::types::ContentIdentificationType> {
471 self.inner.get_content_identification_type()
472 }
473 /// <p>Redacts all personally identifiable information (PII) identified in your transcript.</p>
474 /// <p>Content redaction is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is redacted upon complete transcription of an audio segment. If you don't include <code>PiiEntityTypes</code> in your request, all PII is redacted.</p>
475 /// <p>You can’t set <code>ContentRedactionType</code> and <code>ContentIdentificationType</code> in the same request. If you set both, your request returns a <code>BadRequestException</code>.</p>
476 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html">Redacting or identifying personally identifiable information</a>.</p>
477 pub fn content_redaction_type(mut self, input: crate::types::ContentRedactionType) -> Self {
478 self.inner = self.inner.content_redaction_type(input);
479 self
480 }
481 /// <p>Redacts all personally identifiable information (PII) identified in your transcript.</p>
482 /// <p>Content redaction is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is redacted upon complete transcription of an audio segment. If you don't include <code>PiiEntityTypes</code> in your request, all PII is redacted.</p>
483 /// <p>You can’t set <code>ContentRedactionType</code> and <code>ContentIdentificationType</code> in the same request. If you set both, your request returns a <code>BadRequestException</code>.</p>
484 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html">Redacting or identifying personally identifiable information</a>.</p>
485 pub fn set_content_redaction_type(mut self, input: ::std::option::Option<crate::types::ContentRedactionType>) -> Self {
486 self.inner = self.inner.set_content_redaction_type(input);
487 self
488 }
489 /// <p>Redacts all personally identifiable information (PII) identified in your transcript.</p>
490 /// <p>Content redaction is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is redacted upon complete transcription of an audio segment. If you don't include <code>PiiEntityTypes</code> in your request, all PII is redacted.</p>
491 /// <p>You can’t set <code>ContentRedactionType</code> and <code>ContentIdentificationType</code> in the same request. If you set both, your request returns a <code>BadRequestException</code>.</p>
492 /// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html">Redacting or identifying personally identifiable information</a>.</p>
493 pub fn get_content_redaction_type(&self) -> &::std::option::Option<crate::types::ContentRedactionType> {
494 self.inner.get_content_redaction_type()
495 }
496 /// <p>Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select <code>ALL</code>.</p>
497 /// <p>Values must be comma-separated and can include: <code>ADDRESS</code>, <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING</code>, <code>CREDIT_DEBIT_CVV</code>, <code>CREDIT_DEBIT_EXPIRY</code>, <code>CREDIT_DEBIT_NUMBER</code>, <code>EMAIL</code>, <code>NAME</code>, <code>PHONE</code>, <code>PIN</code>, <code>SSN</code>, or <code>ALL</code>.</p>
498 /// <p>Note that if you include <code>PiiEntityTypes</code> in your request, you must also include <code>ContentIdentificationType</code> or <code>ContentRedactionType</code>.</p>
499 /// <p>If you include <code>ContentRedactionType</code> or <code>ContentIdentificationType</code> in your request, but do not include <code>PiiEntityTypes</code>, all PII is redacted or identified.</p>
500 pub fn pii_entity_types(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
501 self.inner = self.inner.pii_entity_types(input.into());
502 self
503 }
504 /// <p>Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select <code>ALL</code>.</p>
505 /// <p>Values must be comma-separated and can include: <code>ADDRESS</code>, <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING</code>, <code>CREDIT_DEBIT_CVV</code>, <code>CREDIT_DEBIT_EXPIRY</code>, <code>CREDIT_DEBIT_NUMBER</code>, <code>EMAIL</code>, <code>NAME</code>, <code>PHONE</code>, <code>PIN</code>, <code>SSN</code>, or <code>ALL</code>.</p>
506 /// <p>Note that if you include <code>PiiEntityTypes</code> in your request, you must also include <code>ContentIdentificationType</code> or <code>ContentRedactionType</code>.</p>
507 /// <p>If you include <code>ContentRedactionType</code> or <code>ContentIdentificationType</code> in your request, but do not include <code>PiiEntityTypes</code>, all PII is redacted or identified.</p>
508 pub fn set_pii_entity_types(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
509 self.inner = self.inner.set_pii_entity_types(input);
510 self
511 }
512 /// <p>Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select <code>ALL</code>.</p>
513 /// <p>Values must be comma-separated and can include: <code>ADDRESS</code>, <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING</code>, <code>CREDIT_DEBIT_CVV</code>, <code>CREDIT_DEBIT_EXPIRY</code>, <code>CREDIT_DEBIT_NUMBER</code>, <code>EMAIL</code>, <code>NAME</code>, <code>PHONE</code>, <code>PIN</code>, <code>SSN</code>, or <code>ALL</code>.</p>
514 /// <p>Note that if you include <code>PiiEntityTypes</code> in your request, you must also include <code>ContentIdentificationType</code> or <code>ContentRedactionType</code>.</p>
515 /// <p>If you include <code>ContentRedactionType</code> or <code>ContentIdentificationType</code> in your request, but do not include <code>PiiEntityTypes</code>, all PII is redacted or identified.</p>
516 pub fn get_pii_entity_types(&self) -> &::std::option::Option<::std::string::String> {
517 self.inner.get_pii_entity_types()
518 }
519}
520