// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
use std::fmt::Write;
/// See [`StartCallAnalyticsStreamTranscriptionInput`](crate::input::StartCallAnalyticsStreamTranscriptionInput).
pub mod start_call_analytics_stream_transcription_input {
/// A builder for [`StartCallAnalyticsStreamTranscriptionInput`](crate::input::StartCallAnalyticsStreamTranscriptionInput).
#[derive(std::default::Default, std::fmt::Debug)]
pub struct Builder {
pub(crate) language_code: std::option::Option<crate::model::CallAnalyticsLanguageCode>,
pub(crate) media_sample_rate_hertz: std::option::Option<i32>,
pub(crate) media_encoding: std::option::Option<crate::model::MediaEncoding>,
pub(crate) vocabulary_name: std::option::Option<std::string::String>,
pub(crate) session_id: std::option::Option<std::string::String>,
pub(crate) audio_stream: std::option::Option<
aws_smithy_http::event_stream::EventStreamSender<
crate::model::AudioStream,
crate::error::AudioStreamError,
>,
>,
pub(crate) vocabulary_filter_name: std::option::Option<std::string::String>,
pub(crate) vocabulary_filter_method:
std::option::Option<crate::model::VocabularyFilterMethod>,
pub(crate) language_model_name: std::option::Option<std::string::String>,
pub(crate) enable_partial_results_stabilization: std::option::Option<bool>,
pub(crate) partial_results_stability:
std::option::Option<crate::model::PartialResultsStability>,
pub(crate) content_identification_type:
std::option::Option<crate::model::ContentIdentificationType>,
pub(crate) content_redaction_type: std::option::Option<crate::model::ContentRedactionType>,
pub(crate) pii_entity_types: std::option::Option<std::string::String>,
}
impl Builder {
/// <p>Specify the language code that represents the language spoken in your audio.</p>
/// <p>If you're unsure of the language spoken in your audio, consider using <code>IdentifyLanguage</code> to enable automatic language identification.</p>
/// <p>For a list of languages supported with streaming Call Analytics, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
pub fn language_code(mut self, input: crate::model::CallAnalyticsLanguageCode) -> Self {
self.language_code = Some(input);
self
}
/// <p>Specify the language code that represents the language spoken in your audio.</p>
/// <p>If you're unsure of the language spoken in your audio, consider using <code>IdentifyLanguage</code> to enable automatic language identification.</p>
/// <p>For a list of languages supported with streaming Call Analytics, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
pub fn set_language_code(
mut self,
input: std::option::Option<crate::model::CallAnalyticsLanguageCode>,
) -> Self {
self.language_code = input;
self
}
/// <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>
pub fn media_sample_rate_hertz(mut self, input: i32) -> Self {
self.media_sample_rate_hertz = Some(input);
self
}
/// <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>
pub fn set_media_sample_rate_hertz(mut self, input: std::option::Option<i32>) -> Self {
self.media_sample_rate_hertz = input;
self
}
/// <p>Specify the encoding of your input audio. Supported formats are:</p>
/// <ul>
/// <li> <p>FLAC</p> </li>
/// <li> <p>OPUS-encoded audio in an Ogg container</p> </li>
/// <li> <p>PCM (only signed 16-bit little-endian audio formats, which does not include WAV)</p> </li>
/// </ul>
/// <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>
pub fn media_encoding(mut self, input: crate::model::MediaEncoding) -> Self {
self.media_encoding = Some(input);
self
}
/// <p>Specify the encoding of your input audio. Supported formats are:</p>
/// <ul>
/// <li> <p>FLAC</p> </li>
/// <li> <p>OPUS-encoded audio in an Ogg container</p> </li>
/// <li> <p>PCM (only signed 16-bit little-endian audio formats, which does not include WAV)</p> </li>
/// </ul>
/// <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>
pub fn set_media_encoding(
mut self,
input: std::option::Option<crate::model::MediaEncoding>,
) -> Self {
self.media_encoding = input;
self
}
/// <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>
/// <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>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
pub fn vocabulary_name(mut self, input: impl Into<std::string::String>) -> Self {
self.vocabulary_name = Some(input.into());
self
}
/// <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>
/// <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>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
pub fn set_vocabulary_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.vocabulary_name = input;
self
}
/// <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>
/// <p>You can use a session ID to retry a streaming session.</p>
pub fn session_id(mut self, input: impl Into<std::string::String>) -> Self {
self.session_id = Some(input.into());
self
}
/// <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>
/// <p>You can use a session ID to retry a streaming session.</p>
pub fn set_session_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.session_id = input;
self
}
/// <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
pub fn audio_stream(
mut self,
input: aws_smithy_http::event_stream::EventStreamSender<
crate::model::AudioStream,
crate::error::AudioStreamError,
>,
) -> Self {
self.audio_stream = Some(input);
self
}
/// <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
pub fn set_audio_stream(
mut self,
input: std::option::Option<
aws_smithy_http::event_stream::EventStreamSender<
crate::model::AudioStream,
crate::error::AudioStreamError,
>,
>,
) -> Self {
self.audio_stream = input;
self
}
/// <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>
/// <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>
/// <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>
pub fn vocabulary_filter_name(mut self, input: impl Into<std::string::String>) -> Self {
self.vocabulary_filter_name = Some(input.into());
self
}
/// <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>
/// <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>
/// <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>
pub fn set_vocabulary_filter_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.vocabulary_filter_name = input;
self
}
/// <p>Specify how you want your 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::model::VocabularyFilterMethod,
) -> Self {
self.vocabulary_filter_method = Some(input);
self
}
/// <p>Specify how you want your 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::model::VocabularyFilterMethod>,
) -> Self {
self.vocabulary_filter_method = input;
self
}
/// <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>
/// <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>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language models</a>.</p>
pub fn language_model_name(mut self, input: impl Into<std::string::String>) -> Self {
self.language_model_name = Some(input.into());
self
}
/// <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>
/// <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>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language models</a>.</p>
pub fn set_language_model_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.language_model_name = input;
self
}
/// <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>
pub fn enable_partial_results_stabilization(mut self, input: bool) -> Self {
self.enable_partial_results_stabilization = Some(input);
self
}
/// <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>
pub fn set_enable_partial_results_stabilization(
mut self,
input: std::option::Option<bool>,
) -> Self {
self.enable_partial_results_stabilization = input;
self
}
/// <p>Specify the level of stability to use when you enable partial results stabilization (<code>EnablePartialResultsStabilization</code>).</p>
/// <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.</p>
/// <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>
pub fn partial_results_stability(
mut self,
input: crate::model::PartialResultsStability,
) -> Self {
self.partial_results_stability = Some(input);
self
}
/// <p>Specify the level of stability to use when you enable partial results stabilization (<code>EnablePartialResultsStabilization</code>).</p>
/// <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.</p>
/// <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>
pub fn set_partial_results_stability(
mut self,
input: std::option::Option<crate::model::PartialResultsStability>,
) -> Self {
self.partial_results_stability = input;
self
}
/// <p>Labels all personally identifiable information (PII) identified in your transcript.</p>
/// <p>Content identification is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is flagged upon complete transcription of an audio segment.</p>
/// <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>
/// <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>
pub fn content_identification_type(
mut self,
input: crate::model::ContentIdentificationType,
) -> Self {
self.content_identification_type = Some(input);
self
}
/// <p>Labels all personally identifiable information (PII) identified in your transcript.</p>
/// <p>Content identification is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is flagged upon complete transcription of an audio segment.</p>
/// <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>
/// <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>
pub fn set_content_identification_type(
mut self,
input: std::option::Option<crate::model::ContentIdentificationType>,
) -> Self {
self.content_identification_type = input;
self
}
/// <p>Redacts all personally identifiable information (PII) identified in your transcript.</p>
/// <p>Content redaction is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is redacted upon complete transcription of an audio segment.</p>
/// <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>
/// <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>
pub fn content_redaction_type(mut self, input: crate::model::ContentRedactionType) -> Self {
self.content_redaction_type = Some(input);
self
}
/// <p>Redacts all personally identifiable information (PII) identified in your transcript.</p>
/// <p>Content redaction is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is redacted upon complete transcription of an audio segment.</p>
/// <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>
/// <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>
pub fn set_content_redaction_type(
mut self,
input: std::option::Option<crate::model::ContentRedactionType>,
) -> Self {
self.content_redaction_type = input;
self
}
/// <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>
/// <p>To include <code>PiiEntityTypes</code> in your Call Analytics request, you must also include either <code>ContentIdentificationType</code> or <code>ContentRedactionType</code>.</p>
/// <p>Values must be comma-separated and can include: <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING</code>, <code>CREDIT_DEBIT_NUMBER</code>, <code>CREDIT_DEBIT_CVV</code>, <code>CREDIT_DEBIT_EXPIRY</code>, <code>PIN</code>, <code>EMAIL</code>, <code>ADDRESS</code>, <code>NAME</code>, <code>PHONE</code>, <code>SSN</code>, or <code>ALL</code>.</p>
pub fn pii_entity_types(mut self, input: impl Into<std::string::String>) -> Self {
self.pii_entity_types = Some(input.into());
self
}
/// <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>
/// <p>To include <code>PiiEntityTypes</code> in your Call Analytics request, you must also include either <code>ContentIdentificationType</code> or <code>ContentRedactionType</code>.</p>
/// <p>Values must be comma-separated and can include: <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING</code>, <code>CREDIT_DEBIT_NUMBER</code>, <code>CREDIT_DEBIT_CVV</code>, <code>CREDIT_DEBIT_EXPIRY</code>, <code>PIN</code>, <code>EMAIL</code>, <code>ADDRESS</code>, <code>NAME</code>, <code>PHONE</code>, <code>SSN</code>, or <code>ALL</code>.</p>
pub fn set_pii_entity_types(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.pii_entity_types = input;
self
}
/// Consumes the builder and constructs a [`StartCallAnalyticsStreamTranscriptionInput`](crate::input::StartCallAnalyticsStreamTranscriptionInput).
pub fn build(
self,
) -> Result<
crate::input::StartCallAnalyticsStreamTranscriptionInput,
aws_smithy_http::operation::error::BuildError,
> {
Ok(
crate::input::StartCallAnalyticsStreamTranscriptionInput {
language_code: self.language_code
,
media_sample_rate_hertz: self.media_sample_rate_hertz
,
media_encoding: self.media_encoding
,
vocabulary_name: self.vocabulary_name
,
session_id: self.session_id
,
audio_stream: self.audio_stream
.ok_or_else(||
aws_smithy_http::operation::error::BuildError::missing_field("audio_stream", "audio_stream was not specified but it is required when building StartCallAnalyticsStreamTranscriptionInput")
)?
,
vocabulary_filter_name: self.vocabulary_filter_name
,
vocabulary_filter_method: self.vocabulary_filter_method
,
language_model_name: self.language_model_name
,
enable_partial_results_stabilization: self.enable_partial_results_stabilization
.unwrap_or_default()
,
partial_results_stability: self.partial_results_stability
,
content_identification_type: self.content_identification_type
,
content_redaction_type: self.content_redaction_type
,
pii_entity_types: self.pii_entity_types
,
}
)
}
}
}
impl StartCallAnalyticsStreamTranscriptionInput {
/// Consumes the builder and constructs an Operation<[`StartCallAnalyticsStreamTranscription`](crate::operation::StartCallAnalyticsStreamTranscription)>
#[allow(unused_mut)]
#[allow(clippy::let_and_return)]
#[allow(clippy::needless_borrow)]
pub async fn make_operation(
self,
_config: &crate::config::Config,
) -> std::result::Result<
aws_smithy_http::operation::Operation<
crate::operation::StartCallAnalyticsStreamTranscription,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::operation::error::BuildError,
> {
let params_result = crate::endpoint::Params::builder()
.set_region(_config.region.as_ref().map(|r| r.as_ref().to_owned()))
.set_use_dual_stack(_config.use_dual_stack)
.set_use_fips(_config.use_fips)
.set_endpoint(_config.endpoint_url.clone())
.build()
.map_err(|err| {
aws_smithy_http::endpoint::ResolveEndpointError::from_source(
"could not construct endpoint parameters",
err,
)
});
let (endpoint_result, params) = match params_result {
Ok(params) => (
_config.endpoint_resolver.resolve_endpoint(¶ms),
Some(params),
),
Err(e) => (Err(e), None),
};
let mut request = {
fn uri_base(
_input: &crate::input::StartCallAnalyticsStreamTranscriptionInput,
output: &mut String,
) -> Result<(), aws_smithy_http::operation::error::BuildError> {
write!(output, "/call-analytics-stream-transcription")
.expect("formatting should succeed");
Ok(())
}
#[allow(clippy::unnecessary_wraps)]
fn update_http_builder(
input: &crate::input::StartCallAnalyticsStreamTranscriptionInput,
builder: http::request::Builder,
) -> std::result::Result<
http::request::Builder,
aws_smithy_http::operation::error::BuildError,
> {
let mut uri = String::new();
uri_base(input, &mut uri)?;
let builder =
crate::http_serde::add_headers_start_call_analytics_stream_transcription(
input, builder,
)?;
Ok(builder.method("POST").uri(uri))
}
let mut builder = update_http_builder(&self, http::request::Builder::new())?;
builder = aws_smithy_http::header::set_request_header_if_absent(
builder,
http::header::CONTENT_TYPE,
"application/vnd.amazon.eventstream",
);
builder
};
let mut properties = aws_smithy_http::property_bag::SharedPropertyBag::new();
#[allow(clippy::useless_conversion)]
let body = aws_smithy_http::body::SdkBody::from({
let error_marshaller = crate::event_stream_serde::AudioStreamErrorMarshaller::new();
let marshaller = crate::event_stream_serde::AudioStreamMarshaller::new();
let signer = _config.new_event_stream_signer(properties.clone());
let adapter: aws_smithy_http::event_stream::MessageStreamAdapter<_, _> = self
.audio_stream
.into_body_stream(marshaller, error_marshaller, signer);
let body: aws_smithy_http::body::SdkBody = hyper::Body::wrap_stream(adapter).into();
body
});
if let Some(content_length) = body.content_length() {
request = aws_smithy_http::header::set_request_header_if_absent(
request,
http::header::CONTENT_LENGTH,
content_length,
);
}
let request = request.body(body).expect("should be valid request");
let mut request = aws_smithy_http::operation::Request::from_parts(request, properties);
request.properties_mut().insert(endpoint_result);
if let Some(params) = params {
request.properties_mut().insert(params);
}
request.properties_mut().insert(vec![http::Version::HTTP_2]);
let mut user_agent = aws_http::user_agent::AwsUserAgent::new_from_environment(
aws_types::os_shim_internal::Env::real(),
crate::API_METADATA.clone(),
);
if let Some(app_name) = _config.app_name() {
user_agent = user_agent.with_app_name(app_name.clone());
}
request.properties_mut().insert(user_agent);
let mut signing_config = aws_sig_auth::signer::OperationSigningConfig::default_config();
request
.properties_mut()
.insert(aws_sig_auth::signer::SignableBody::Bytes(&[]));
request.properties_mut().insert(signing_config);
request
.properties_mut()
.insert(aws_types::SigningService::from_static(
_config.signing_service(),
));
if let Some(region) = &_config.region {
request
.properties_mut()
.insert(aws_types::region::SigningRegion::from(region.clone()));
}
if let Some(region) = &_config.region {
request.properties_mut().insert(region.clone());
}
aws_http::auth::set_credentials_cache(
&mut request.properties_mut(),
_config.credentials_cache.clone(),
);
let op = aws_smithy_http::operation::Operation::new(
request,
crate::operation::StartCallAnalyticsStreamTranscription::new(),
)
.with_metadata(aws_smithy_http::operation::Metadata::new(
"StartCallAnalyticsStreamTranscription",
"transcribestreaming",
));
let op = op.with_retry_classifier(aws_http::retry::AwsResponseRetryClassifier::new());
Ok(op)
}
/// Creates a new builder-style object to manufacture [`StartCallAnalyticsStreamTranscriptionInput`](crate::input::StartCallAnalyticsStreamTranscriptionInput).
pub fn builder() -> crate::input::start_call_analytics_stream_transcription_input::Builder {
crate::input::start_call_analytics_stream_transcription_input::Builder::default()
}
}
/// See [`StartMedicalStreamTranscriptionInput`](crate::input::StartMedicalStreamTranscriptionInput).
pub mod start_medical_stream_transcription_input {
/// A builder for [`StartMedicalStreamTranscriptionInput`](crate::input::StartMedicalStreamTranscriptionInput).
#[derive(std::default::Default, std::fmt::Debug)]
pub struct Builder {
pub(crate) language_code: std::option::Option<crate::model::LanguageCode>,
pub(crate) media_sample_rate_hertz: std::option::Option<i32>,
pub(crate) media_encoding: std::option::Option<crate::model::MediaEncoding>,
pub(crate) vocabulary_name: std::option::Option<std::string::String>,
pub(crate) specialty: std::option::Option<crate::model::Specialty>,
pub(crate) r#type: std::option::Option<crate::model::Type>,
pub(crate) show_speaker_label: std::option::Option<bool>,
pub(crate) session_id: std::option::Option<std::string::String>,
pub(crate) audio_stream: std::option::Option<
aws_smithy_http::event_stream::EventStreamSender<
crate::model::AudioStream,
crate::error::AudioStreamError,
>,
>,
pub(crate) enable_channel_identification: std::option::Option<bool>,
pub(crate) number_of_channels: std::option::Option<i32>,
pub(crate) content_identification_type:
std::option::Option<crate::model::MedicalContentIdentificationType>,
}
impl Builder {
/// <p>Specify the language code that represents the language spoken in your audio.</p> <important>
/// <p>Amazon Transcribe Medical only supports US English (<code>en-US</code>).</p>
/// </important>
pub fn language_code(mut self, input: crate::model::LanguageCode) -> Self {
self.language_code = Some(input);
self
}
/// <p>Specify the language code that represents the language spoken in your audio.</p> <important>
/// <p>Amazon Transcribe Medical only supports US English (<code>en-US</code>).</p>
/// </important>
pub fn set_language_code(
mut self,
input: std::option::Option<crate::model::LanguageCode>,
) -> Self {
self.language_code = input;
self
}
/// <p>The sample rate of the input audio (in hertz). Amazon Transcribe Medical supports a range from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.</p>
pub fn media_sample_rate_hertz(mut self, input: i32) -> Self {
self.media_sample_rate_hertz = Some(input);
self
}
/// <p>The sample rate of the input audio (in hertz). Amazon Transcribe Medical supports a range from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.</p>
pub fn set_media_sample_rate_hertz(mut self, input: std::option::Option<i32>) -> Self {
self.media_sample_rate_hertz = input;
self
}
/// <p>Specify the encoding used for the input audio. Supported formats are:</p>
/// <ul>
/// <li> <p>FLAC</p> </li>
/// <li> <p>OPUS-encoded audio in an Ogg container</p> </li>
/// <li> <p>PCM (only signed 16-bit little-endian audio formats, which does not include WAV)</p> </li>
/// </ul>
/// <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>
pub fn media_encoding(mut self, input: crate::model::MediaEncoding) -> Self {
self.media_encoding = Some(input);
self
}
/// <p>Specify the encoding used for the input audio. Supported formats are:</p>
/// <ul>
/// <li> <p>FLAC</p> </li>
/// <li> <p>OPUS-encoded audio in an Ogg container</p> </li>
/// <li> <p>PCM (only signed 16-bit little-endian audio formats, which does not include WAV)</p> </li>
/// </ul>
/// <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>
pub fn set_media_encoding(
mut self,
input: std::option::Option<crate::model::MediaEncoding>,
) -> Self {
self.media_encoding = input;
self
}
/// <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>
pub fn vocabulary_name(mut self, input: impl Into<std::string::String>) -> Self {
self.vocabulary_name = Some(input.into());
self
}
/// <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>
pub fn set_vocabulary_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.vocabulary_name = input;
self
}
/// <p>Specify the medical specialty contained in your audio.</p>
pub fn specialty(mut self, input: crate::model::Specialty) -> Self {
self.specialty = Some(input);
self
}
/// <p>Specify the medical specialty contained in your audio.</p>
pub fn set_specialty(
mut self,
input: std::option::Option<crate::model::Specialty>,
) -> Self {
self.specialty = input;
self
}
/// <p>Specify the type of input audio. For example, choose <code>DICTATION</code> for a provider dictating patient notes and <code>CONVERSATION</code> for a dialogue between a patient and a medical professional.</p>
pub fn r#type(mut self, input: crate::model::Type) -> Self {
self.r#type = Some(input);
self
}
/// <p>Specify the type of input audio. For example, choose <code>DICTATION</code> for a provider dictating patient notes and <code>CONVERSATION</code> for a dialogue between a patient and a medical professional.</p>
pub fn set_type(mut self, input: std::option::Option<crate::model::Type>) -> Self {
self.r#type = 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>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_label(mut self, input: bool) -> Self {
self.show_speaker_label = 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>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_label(mut self, input: std::option::Option<bool>) -> Self {
self.show_speaker_label = input;
self
}
/// <p>Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe Medical generates an ID and returns it in the response.</p>
/// <p>You can use a session ID to retry a streaming session.</p>
pub fn session_id(mut self, input: impl Into<std::string::String>) -> Self {
self.session_id = Some(input.into());
self
}
/// <p>Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe Medical generates an ID and returns it in the response.</p>
/// <p>You can use a session ID to retry a streaming session.</p>
pub fn set_session_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.session_id = input;
self
}
/// <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
pub fn audio_stream(
mut self,
input: aws_smithy_http::event_stream::EventStreamSender<
crate::model::AudioStream,
crate::error::AudioStreamError,
>,
) -> Self {
self.audio_stream = Some(input);
self
}
/// <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
pub fn set_audio_stream(
mut self,
input: std::option::Option<
aws_smithy_http::event_stream::EventStreamSender<
crate::model::AudioStream,
crate::error::AudioStreamError,
>,
>,
) -> Self {
self.audio_stream = 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>If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.</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 enable_channel_identification(mut self, input: bool) -> Self {
self.enable_channel_identification = 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>If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.</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_enable_channel_identification(
mut self,
input: std::option::Option<bool>,
) -> Self {
self.enable_channel_identification = input;
self
}
/// <p>Specify the number of channels in your audio stream. Up to two channels are supported.</p>
pub fn number_of_channels(mut self, input: i32) -> Self {
self.number_of_channels = Some(input);
self
}
/// <p>Specify the number of channels in your audio stream. Up to two channels are supported.</p>
pub fn set_number_of_channels(mut self, input: std::option::Option<i32>) -> Self {
self.number_of_channels = input;
self
}
/// <p>Labels all personal health information (PHI) identified in your transcript.</p>
/// <p>Content identification is performed at the segment level; PHI is flagged upon complete transcription of an audio segment.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html">Identifying personal health information (PHI) in a transcription</a>.</p>
pub fn content_identification_type(
mut self,
input: crate::model::MedicalContentIdentificationType,
) -> Self {
self.content_identification_type = Some(input);
self
}
/// <p>Labels all personal health information (PHI) identified in your transcript.</p>
/// <p>Content identification is performed at the segment level; PHI is flagged upon complete transcription of an audio segment.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html">Identifying personal health information (PHI) in a transcription</a>.</p>
pub fn set_content_identification_type(
mut self,
input: std::option::Option<crate::model::MedicalContentIdentificationType>,
) -> Self {
self.content_identification_type = input;
self
}
/// Consumes the builder and constructs a [`StartMedicalStreamTranscriptionInput`](crate::input::StartMedicalStreamTranscriptionInput).
pub fn build(
self,
) -> Result<
crate::input::StartMedicalStreamTranscriptionInput,
aws_smithy_http::operation::error::BuildError,
> {
Ok(
crate::input::StartMedicalStreamTranscriptionInput {
language_code: self.language_code
,
media_sample_rate_hertz: self.media_sample_rate_hertz
,
media_encoding: self.media_encoding
,
vocabulary_name: self.vocabulary_name
,
specialty: self.specialty
,
r#type: self.r#type
,
show_speaker_label: self.show_speaker_label
.unwrap_or_default()
,
session_id: self.session_id
,
audio_stream: self.audio_stream
.ok_or_else(||
aws_smithy_http::operation::error::BuildError::missing_field("audio_stream", "audio_stream was not specified but it is required when building StartMedicalStreamTranscriptionInput")
)?
,
enable_channel_identification: self.enable_channel_identification
.unwrap_or_default()
,
number_of_channels: self.number_of_channels
,
content_identification_type: self.content_identification_type
,
}
)
}
}
}
impl StartMedicalStreamTranscriptionInput {
/// Consumes the builder and constructs an Operation<[`StartMedicalStreamTranscription`](crate::operation::StartMedicalStreamTranscription)>
#[allow(unused_mut)]
#[allow(clippy::let_and_return)]
#[allow(clippy::needless_borrow)]
pub async fn make_operation(
self,
_config: &crate::config::Config,
) -> std::result::Result<
aws_smithy_http::operation::Operation<
crate::operation::StartMedicalStreamTranscription,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::operation::error::BuildError,
> {
let params_result = crate::endpoint::Params::builder()
.set_region(_config.region.as_ref().map(|r| r.as_ref().to_owned()))
.set_use_dual_stack(_config.use_dual_stack)
.set_use_fips(_config.use_fips)
.set_endpoint(_config.endpoint_url.clone())
.build()
.map_err(|err| {
aws_smithy_http::endpoint::ResolveEndpointError::from_source(
"could not construct endpoint parameters",
err,
)
});
let (endpoint_result, params) = match params_result {
Ok(params) => (
_config.endpoint_resolver.resolve_endpoint(¶ms),
Some(params),
),
Err(e) => (Err(e), None),
};
let mut request = {
fn uri_base(
_input: &crate::input::StartMedicalStreamTranscriptionInput,
output: &mut String,
) -> Result<(), aws_smithy_http::operation::error::BuildError> {
write!(output, "/medical-stream-transcription").expect("formatting should succeed");
Ok(())
}
#[allow(clippy::unnecessary_wraps)]
fn update_http_builder(
input: &crate::input::StartMedicalStreamTranscriptionInput,
builder: http::request::Builder,
) -> std::result::Result<
http::request::Builder,
aws_smithy_http::operation::error::BuildError,
> {
let mut uri = String::new();
uri_base(input, &mut uri)?;
let builder = crate::http_serde::add_headers_start_medical_stream_transcription(
input, builder,
)?;
Ok(builder.method("POST").uri(uri))
}
let mut builder = update_http_builder(&self, http::request::Builder::new())?;
builder = aws_smithy_http::header::set_request_header_if_absent(
builder,
http::header::CONTENT_TYPE,
"application/vnd.amazon.eventstream",
);
builder
};
let mut properties = aws_smithy_http::property_bag::SharedPropertyBag::new();
#[allow(clippy::useless_conversion)]
let body = aws_smithy_http::body::SdkBody::from({
let error_marshaller = crate::event_stream_serde::AudioStreamErrorMarshaller::new();
let marshaller = crate::event_stream_serde::AudioStreamMarshaller::new();
let signer = _config.new_event_stream_signer(properties.clone());
let adapter: aws_smithy_http::event_stream::MessageStreamAdapter<_, _> = self
.audio_stream
.into_body_stream(marshaller, error_marshaller, signer);
let body: aws_smithy_http::body::SdkBody = hyper::Body::wrap_stream(adapter).into();
body
});
if let Some(content_length) = body.content_length() {
request = aws_smithy_http::header::set_request_header_if_absent(
request,
http::header::CONTENT_LENGTH,
content_length,
);
}
let request = request.body(body).expect("should be valid request");
let mut request = aws_smithy_http::operation::Request::from_parts(request, properties);
request.properties_mut().insert(endpoint_result);
if let Some(params) = params {
request.properties_mut().insert(params);
}
request.properties_mut().insert(vec![http::Version::HTTP_2]);
let mut user_agent = aws_http::user_agent::AwsUserAgent::new_from_environment(
aws_types::os_shim_internal::Env::real(),
crate::API_METADATA.clone(),
);
if let Some(app_name) = _config.app_name() {
user_agent = user_agent.with_app_name(app_name.clone());
}
request.properties_mut().insert(user_agent);
let mut signing_config = aws_sig_auth::signer::OperationSigningConfig::default_config();
request
.properties_mut()
.insert(aws_sig_auth::signer::SignableBody::Bytes(&[]));
request.properties_mut().insert(signing_config);
request
.properties_mut()
.insert(aws_types::SigningService::from_static(
_config.signing_service(),
));
if let Some(region) = &_config.region {
request
.properties_mut()
.insert(aws_types::region::SigningRegion::from(region.clone()));
}
if let Some(region) = &_config.region {
request.properties_mut().insert(region.clone());
}
aws_http::auth::set_credentials_cache(
&mut request.properties_mut(),
_config.credentials_cache.clone(),
);
let op = aws_smithy_http::operation::Operation::new(
request,
crate::operation::StartMedicalStreamTranscription::new(),
)
.with_metadata(aws_smithy_http::operation::Metadata::new(
"StartMedicalStreamTranscription",
"transcribestreaming",
));
let op = op.with_retry_classifier(aws_http::retry::AwsResponseRetryClassifier::new());
Ok(op)
}
/// Creates a new builder-style object to manufacture [`StartMedicalStreamTranscriptionInput`](crate::input::StartMedicalStreamTranscriptionInput).
pub fn builder() -> crate::input::start_medical_stream_transcription_input::Builder {
crate::input::start_medical_stream_transcription_input::Builder::default()
}
}
/// See [`StartStreamTranscriptionInput`](crate::input::StartStreamTranscriptionInput).
pub mod start_stream_transcription_input {
/// A builder for [`StartStreamTranscriptionInput`](crate::input::StartStreamTranscriptionInput).
#[derive(std::default::Default, std::fmt::Debug)]
pub struct Builder {
pub(crate) language_code: std::option::Option<crate::model::LanguageCode>,
pub(crate) media_sample_rate_hertz: std::option::Option<i32>,
pub(crate) media_encoding: std::option::Option<crate::model::MediaEncoding>,
pub(crate) vocabulary_name: std::option::Option<std::string::String>,
pub(crate) session_id: std::option::Option<std::string::String>,
pub(crate) audio_stream: std::option::Option<
aws_smithy_http::event_stream::EventStreamSender<
crate::model::AudioStream,
crate::error::AudioStreamError,
>,
>,
pub(crate) vocabulary_filter_name: std::option::Option<std::string::String>,
pub(crate) vocabulary_filter_method:
std::option::Option<crate::model::VocabularyFilterMethod>,
pub(crate) show_speaker_label: std::option::Option<bool>,
pub(crate) enable_channel_identification: std::option::Option<bool>,
pub(crate) number_of_channels: std::option::Option<i32>,
pub(crate) enable_partial_results_stabilization: std::option::Option<bool>,
pub(crate) partial_results_stability:
std::option::Option<crate::model::PartialResultsStability>,
pub(crate) content_identification_type:
std::option::Option<crate::model::ContentIdentificationType>,
pub(crate) content_redaction_type: std::option::Option<crate::model::ContentRedactionType>,
pub(crate) pii_entity_types: std::option::Option<std::string::String>,
pub(crate) language_model_name: std::option::Option<std::string::String>,
pub(crate) identify_language: std::option::Option<bool>,
pub(crate) language_options: std::option::Option<std::string::String>,
pub(crate) preferred_language: std::option::Option<crate::model::LanguageCode>,
pub(crate) vocabulary_names: std::option::Option<std::string::String>,
pub(crate) vocabulary_filter_names: std::option::Option<std::string::String>,
}
impl Builder {
/// <p>Specify the language code that represents the language spoken in your audio.</p>
/// <p>If you're unsure of the language spoken in your audio, consider using <code>IdentifyLanguage</code> to enable automatic language identification.</p>
/// <p>For a list of languages supported with Amazon Transcribe streaming, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
pub fn language_code(mut self, input: crate::model::LanguageCode) -> Self {
self.language_code = Some(input);
self
}
/// <p>Specify the language code that represents the language spoken in your audio.</p>
/// <p>If you're unsure of the language spoken in your audio, consider using <code>IdentifyLanguage</code> to enable automatic language identification.</p>
/// <p>For a list of languages supported with Amazon Transcribe streaming, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
pub fn set_language_code(
mut self,
input: std::option::Option<crate::model::LanguageCode>,
) -> Self {
self.language_code = input;
self
}
/// <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>
pub fn media_sample_rate_hertz(mut self, input: i32) -> Self {
self.media_sample_rate_hertz = Some(input);
self
}
/// <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>
pub fn set_media_sample_rate_hertz(mut self, input: std::option::Option<i32>) -> Self {
self.media_sample_rate_hertz = input;
self
}
/// <p>Specify the encoding of your input audio. Supported formats are:</p>
/// <ul>
/// <li> <p>FLAC</p> </li>
/// <li> <p>OPUS-encoded audio in an Ogg container</p> </li>
/// <li> <p>PCM (only signed 16-bit little-endian audio formats, which does not include WAV)</p> </li>
/// </ul>
/// <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>
pub fn media_encoding(mut self, input: crate::model::MediaEncoding) -> Self {
self.media_encoding = Some(input);
self
}
/// <p>Specify the encoding of your input audio. Supported formats are:</p>
/// <ul>
/// <li> <p>FLAC</p> </li>
/// <li> <p>OPUS-encoded audio in an Ogg container</p> </li>
/// <li> <p>PCM (only signed 16-bit little-endian audio formats, which does not include WAV)</p> </li>
/// </ul>
/// <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>
pub fn set_media_encoding(
mut self,
input: std::option::Option<crate::model::MediaEncoding>,
) -> Self {
self.media_encoding = input;
self
}
/// <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>
/// <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> <important>
/// <p>This parameter is <b>not</b> intended for use with the <code>IdentifyLanguage</code> parameter. If you're including <code>IdentifyLanguage</code> in your request and want to use one or more custom vocabularies with your transcription, use the <code>VocabularyNames</code> parameter instead.</p>
/// </important>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
pub fn vocabulary_name(mut self, input: impl Into<std::string::String>) -> Self {
self.vocabulary_name = Some(input.into());
self
}
/// <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>
/// <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> <important>
/// <p>This parameter is <b>not</b> intended for use with the <code>IdentifyLanguage</code> parameter. If you're including <code>IdentifyLanguage</code> in your request and want to use one or more custom vocabularies with your transcription, use the <code>VocabularyNames</code> parameter instead.</p>
/// </important>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
pub fn set_vocabulary_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.vocabulary_name = input;
self
}
/// <p>Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe generates an ID and returns it in the response.</p>
/// <p>You can use a session ID to retry a streaming session.</p>
pub fn session_id(mut self, input: impl Into<std::string::String>) -> Self {
self.session_id = Some(input.into());
self
}
/// <p>Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe generates an ID and returns it in the response.</p>
/// <p>You can use a session ID to retry a streaming session.</p>
pub fn set_session_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.session_id = input;
self
}
/// <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
pub fn audio_stream(
mut self,
input: aws_smithy_http::event_stream::EventStreamSender<
crate::model::AudioStream,
crate::error::AudioStreamError,
>,
) -> Self {
self.audio_stream = Some(input);
self
}
/// <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
pub fn set_audio_stream(
mut self,
input: std::option::Option<
aws_smithy_http::event_stream::EventStreamSender<
crate::model::AudioStream,
crate::error::AudioStreamError,
>,
>,
) -> Self {
self.audio_stream = input;
self
}
/// <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>
/// <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> <important>
/// <p>This parameter is <b>not</b> intended for use with the <code>IdentifyLanguage</code> parameter. If you're including <code>IdentifyLanguage</code> in your request and want to use one or more vocabulary filters with your transcription, use the <code>VocabularyFilterNames</code> parameter instead.</p>
/// </important>
/// <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>
pub fn vocabulary_filter_name(mut self, input: impl Into<std::string::String>) -> Self {
self.vocabulary_filter_name = Some(input.into());
self
}
/// <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>
/// <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> <important>
/// <p>This parameter is <b>not</b> intended for use with the <code>IdentifyLanguage</code> parameter. If you're including <code>IdentifyLanguage</code> in your request and want to use one or more vocabulary filters with your transcription, use the <code>VocabularyFilterNames</code> parameter instead.</p>
/// </important>
/// <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>
pub fn set_vocabulary_filter_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.vocabulary_filter_name = input;
self
}
/// <p>Specify how you want your 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::model::VocabularyFilterMethod,
) -> Self {
self.vocabulary_filter_method = Some(input);
self
}
/// <p>Specify how you want your 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::model::VocabularyFilterMethod>,
) -> Self {
self.vocabulary_filter_method = 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>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_label(mut self, input: bool) -> Self {
self.show_speaker_label = 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>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_label(mut self, input: std::option::Option<bool>) -> Self {
self.show_speaker_label = 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>If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.</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 enable_channel_identification(mut self, input: bool) -> Self {
self.enable_channel_identification = 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>If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.</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_enable_channel_identification(
mut self,
input: std::option::Option<bool>,
) -> Self {
self.enable_channel_identification = input;
self
}
/// <p>Specify the number of channels in your audio stream. Up to two channels are supported.</p>
pub fn number_of_channels(mut self, input: i32) -> Self {
self.number_of_channels = Some(input);
self
}
/// <p>Specify the number of channels in your audio stream. Up to two channels are supported.</p>
pub fn set_number_of_channels(mut self, input: std::option::Option<i32>) -> Self {
self.number_of_channels = input;
self
}
/// <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>
pub fn enable_partial_results_stabilization(mut self, input: bool) -> Self {
self.enable_partial_results_stabilization = Some(input);
self
}
/// <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>
pub fn set_enable_partial_results_stabilization(
mut self,
input: std::option::Option<bool>,
) -> Self {
self.enable_partial_results_stabilization = input;
self
}
/// <p>Specify the level of stability to use when you enable partial results stabilization (<code>EnablePartialResultsStabilization</code>).</p>
/// <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.</p>
/// <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>
pub fn partial_results_stability(
mut self,
input: crate::model::PartialResultsStability,
) -> Self {
self.partial_results_stability = Some(input);
self
}
/// <p>Specify the level of stability to use when you enable partial results stabilization (<code>EnablePartialResultsStabilization</code>).</p>
/// <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.</p>
/// <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>
pub fn set_partial_results_stability(
mut self,
input: std::option::Option<crate::model::PartialResultsStability>,
) -> Self {
self.partial_results_stability = input;
self
}
/// <p>Labels all personally identifiable information (PII) identified in your transcript.</p>
/// <p>Content identification is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is flagged upon complete transcription of an audio segment.</p>
/// <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>
/// <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>
pub fn content_identification_type(
mut self,
input: crate::model::ContentIdentificationType,
) -> Self {
self.content_identification_type = Some(input);
self
}
/// <p>Labels all personally identifiable information (PII) identified in your transcript.</p>
/// <p>Content identification is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is flagged upon complete transcription of an audio segment.</p>
/// <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>
/// <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>
pub fn set_content_identification_type(
mut self,
input: std::option::Option<crate::model::ContentIdentificationType>,
) -> Self {
self.content_identification_type = input;
self
}
/// <p>Redacts all personally identifiable information (PII) identified in your transcript.</p>
/// <p>Content redaction is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is redacted upon complete transcription of an audio segment.</p>
/// <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>
/// <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>
pub fn content_redaction_type(mut self, input: crate::model::ContentRedactionType) -> Self {
self.content_redaction_type = Some(input);
self
}
/// <p>Redacts all personally identifiable information (PII) identified in your transcript.</p>
/// <p>Content redaction is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is redacted upon complete transcription of an audio segment.</p>
/// <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>
/// <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>
pub fn set_content_redaction_type(
mut self,
input: std::option::Option<crate::model::ContentRedactionType>,
) -> Self {
self.content_redaction_type = input;
self
}
/// <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>
/// <p>To include <code>PiiEntityTypes</code> in your request, you must also include either <code>ContentIdentificationType</code> or <code>ContentRedactionType</code>.</p>
/// <p>Values must be comma-separated and can include: <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING</code>, <code>CREDIT_DEBIT_NUMBER</code>, <code>CREDIT_DEBIT_CVV</code>, <code>CREDIT_DEBIT_EXPIRY</code>, <code>PIN</code>, <code>EMAIL</code>, <code>ADDRESS</code>, <code>NAME</code>, <code>PHONE</code>, <code>SSN</code>, or <code>ALL</code>.</p>
pub fn pii_entity_types(mut self, input: impl Into<std::string::String>) -> Self {
self.pii_entity_types = Some(input.into());
self
}
/// <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>
/// <p>To include <code>PiiEntityTypes</code> in your request, you must also include either <code>ContentIdentificationType</code> or <code>ContentRedactionType</code>.</p>
/// <p>Values must be comma-separated and can include: <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING</code>, <code>CREDIT_DEBIT_NUMBER</code>, <code>CREDIT_DEBIT_CVV</code>, <code>CREDIT_DEBIT_EXPIRY</code>, <code>PIN</code>, <code>EMAIL</code>, <code>ADDRESS</code>, <code>NAME</code>, <code>PHONE</code>, <code>SSN</code>, or <code>ALL</code>.</p>
pub fn set_pii_entity_types(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.pii_entity_types = input;
self
}
/// <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>
/// <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>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language models</a>.</p>
pub fn language_model_name(mut self, input: impl Into<std::string::String>) -> Self {
self.language_model_name = Some(input.into());
self
}
/// <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>
/// <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>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language models</a>.</p>
pub fn set_language_model_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.language_model_name = input;
self
}
/// <p>Enables automatic language identification for your transcription.</p>
/// <p>If you include <code>IdentifyLanguage</code>, you can optionally include a list of language codes, using <code>LanguageOptions</code>, that you think may be present in your audio stream. Including language options can improve transcription accuracy.</p>
/// <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>
/// <p>If you have multi-channel audio that contains different languages on each channel, and you've enabled channel identification, automatic language identification identifies the dominant language on each audio channel.</p>
/// <p>Note that you must include either <code>LanguageCode</code> or <code>IdentifyLanguage</code> in your request. If you include both parameters, your request fails.</p>
/// <p>Streaming language identification can't be combined with custom language models or redaction.</p>
pub fn identify_language(mut self, input: bool) -> Self {
self.identify_language = Some(input);
self
}
/// <p>Enables automatic language identification for your transcription.</p>
/// <p>If you include <code>IdentifyLanguage</code>, you can optionally include a list of language codes, using <code>LanguageOptions</code>, that you think may be present in your audio stream. Including language options can improve transcription accuracy.</p>
/// <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>
/// <p>If you have multi-channel audio that contains different languages on each channel, and you've enabled channel identification, automatic language identification identifies the dominant language on each audio channel.</p>
/// <p>Note that you must include either <code>LanguageCode</code> or <code>IdentifyLanguage</code> in your request. If you include both parameters, your request fails.</p>
/// <p>Streaming language identification can't be combined with custom language models or redaction.</p>
pub fn set_identify_language(mut self, input: std::option::Option<bool>) -> Self {
self.identify_language = input;
self
}
/// <p>Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.</p>
/// <p>Including language options can improve the accuracy of language identification.</p>
/// <p>If you include <code>LanguageOptions</code> in your request, you must also include <code>IdentifyLanguage</code>.</p>
/// <p>For a list of languages supported with Amazon Transcribe streaming, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p> <important>
/// <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>
/// </important>
pub fn language_options(mut self, input: impl Into<std::string::String>) -> Self {
self.language_options = Some(input.into());
self
}
/// <p>Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.</p>
/// <p>Including language options can improve the accuracy of language identification.</p>
/// <p>If you include <code>LanguageOptions</code> in your request, you must also include <code>IdentifyLanguage</code>.</p>
/// <p>For a list of languages supported with Amazon Transcribe streaming, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p> <important>
/// <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>
/// </important>
pub fn set_language_options(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.language_options = input;
self
}
/// <p>Specify a preferred language from the subset of languages codes you specified in <code>LanguageOptions</code>.</p>
/// <p>You can only use this parameter if you've included <code>IdentifyLanguage</code> and <code>LanguageOptions</code> in your request.</p>
pub fn preferred_language(mut self, input: crate::model::LanguageCode) -> Self {
self.preferred_language = Some(input);
self
}
/// <p>Specify a preferred language from the subset of languages codes you specified in <code>LanguageOptions</code>.</p>
/// <p>You can only use this parameter if you've included <code>IdentifyLanguage</code> and <code>LanguageOptions</code> in your request.</p>
pub fn set_preferred_language(
mut self,
input: std::option::Option<crate::model::LanguageCode>,
) -> Self {
self.preferred_language = input;
self
}
/// <p>Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.</p>
/// <p>If none of the languages of the specified custom vocabularies match the language identified in your media, your job fails.</p> <important>
/// <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>
/// </important>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
pub fn vocabulary_names(mut self, input: impl Into<std::string::String>) -> Self {
self.vocabulary_names = Some(input.into());
self
}
/// <p>Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.</p>
/// <p>If none of the languages of the specified custom vocabularies match the language identified in your media, your job fails.</p> <important>
/// <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>
/// </important>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
pub fn set_vocabulary_names(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.vocabulary_names = input;
self
}
/// <p>Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.</p>
/// <p>If none of the languages of the specified custom vocabulary filters match the language identified in your media, your job fails.</p> <important>
/// <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>
/// </important>
/// <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>
pub fn vocabulary_filter_names(mut self, input: impl Into<std::string::String>) -> Self {
self.vocabulary_filter_names = Some(input.into());
self
}
/// <p>Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.</p>
/// <p>If none of the languages of the specified custom vocabulary filters match the language identified in your media, your job fails.</p> <important>
/// <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>
/// </important>
/// <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>
pub fn set_vocabulary_filter_names(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.vocabulary_filter_names = input;
self
}
/// Consumes the builder and constructs a [`StartStreamTranscriptionInput`](crate::input::StartStreamTranscriptionInput).
pub fn build(
self,
) -> Result<
crate::input::StartStreamTranscriptionInput,
aws_smithy_http::operation::error::BuildError,
> {
Ok(
crate::input::StartStreamTranscriptionInput {
language_code: self.language_code
,
media_sample_rate_hertz: self.media_sample_rate_hertz
,
media_encoding: self.media_encoding
,
vocabulary_name: self.vocabulary_name
,
session_id: self.session_id
,
audio_stream: self.audio_stream
.ok_or_else(||
aws_smithy_http::operation::error::BuildError::missing_field("audio_stream", "audio_stream was not specified but it is required when building StartStreamTranscriptionInput")
)?
,
vocabulary_filter_name: self.vocabulary_filter_name
,
vocabulary_filter_method: self.vocabulary_filter_method
,
show_speaker_label: self.show_speaker_label
.unwrap_or_default()
,
enable_channel_identification: self.enable_channel_identification
.unwrap_or_default()
,
number_of_channels: self.number_of_channels
,
enable_partial_results_stabilization: self.enable_partial_results_stabilization
.unwrap_or_default()
,
partial_results_stability: self.partial_results_stability
,
content_identification_type: self.content_identification_type
,
content_redaction_type: self.content_redaction_type
,
pii_entity_types: self.pii_entity_types
,
language_model_name: self.language_model_name
,
identify_language: self.identify_language
.unwrap_or_default()
,
language_options: self.language_options
,
preferred_language: self.preferred_language
,
vocabulary_names: self.vocabulary_names
,
vocabulary_filter_names: self.vocabulary_filter_names
,
}
)
}
}
}
impl StartStreamTranscriptionInput {
/// Consumes the builder and constructs an Operation<[`StartStreamTranscription`](crate::operation::StartStreamTranscription)>
#[allow(unused_mut)]
#[allow(clippy::let_and_return)]
#[allow(clippy::needless_borrow)]
pub async fn make_operation(
self,
_config: &crate::config::Config,
) -> std::result::Result<
aws_smithy_http::operation::Operation<
crate::operation::StartStreamTranscription,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::operation::error::BuildError,
> {
let params_result = crate::endpoint::Params::builder()
.set_region(_config.region.as_ref().map(|r| r.as_ref().to_owned()))
.set_use_dual_stack(_config.use_dual_stack)
.set_use_fips(_config.use_fips)
.set_endpoint(_config.endpoint_url.clone())
.build()
.map_err(|err| {
aws_smithy_http::endpoint::ResolveEndpointError::from_source(
"could not construct endpoint parameters",
err,
)
});
let (endpoint_result, params) = match params_result {
Ok(params) => (
_config.endpoint_resolver.resolve_endpoint(¶ms),
Some(params),
),
Err(e) => (Err(e), None),
};
let mut request = {
fn uri_base(
_input: &crate::input::StartStreamTranscriptionInput,
output: &mut String,
) -> Result<(), aws_smithy_http::operation::error::BuildError> {
write!(output, "/stream-transcription").expect("formatting should succeed");
Ok(())
}
#[allow(clippy::unnecessary_wraps)]
fn update_http_builder(
input: &crate::input::StartStreamTranscriptionInput,
builder: http::request::Builder,
) -> std::result::Result<
http::request::Builder,
aws_smithy_http::operation::error::BuildError,
> {
let mut uri = String::new();
uri_base(input, &mut uri)?;
let builder =
crate::http_serde::add_headers_start_stream_transcription(input, builder)?;
Ok(builder.method("POST").uri(uri))
}
let mut builder = update_http_builder(&self, http::request::Builder::new())?;
builder = aws_smithy_http::header::set_request_header_if_absent(
builder,
http::header::CONTENT_TYPE,
"application/vnd.amazon.eventstream",
);
builder
};
let mut properties = aws_smithy_http::property_bag::SharedPropertyBag::new();
#[allow(clippy::useless_conversion)]
let body = aws_smithy_http::body::SdkBody::from({
let error_marshaller = crate::event_stream_serde::AudioStreamErrorMarshaller::new();
let marshaller = crate::event_stream_serde::AudioStreamMarshaller::new();
let signer = _config.new_event_stream_signer(properties.clone());
let adapter: aws_smithy_http::event_stream::MessageStreamAdapter<_, _> = self
.audio_stream
.into_body_stream(marshaller, error_marshaller, signer);
let body: aws_smithy_http::body::SdkBody = hyper::Body::wrap_stream(adapter).into();
body
});
if let Some(content_length) = body.content_length() {
request = aws_smithy_http::header::set_request_header_if_absent(
request,
http::header::CONTENT_LENGTH,
content_length,
);
}
let request = request.body(body).expect("should be valid request");
let mut request = aws_smithy_http::operation::Request::from_parts(request, properties);
request.properties_mut().insert(endpoint_result);
if let Some(params) = params {
request.properties_mut().insert(params);
}
request.properties_mut().insert(vec![http::Version::HTTP_2]);
let mut user_agent = aws_http::user_agent::AwsUserAgent::new_from_environment(
aws_types::os_shim_internal::Env::real(),
crate::API_METADATA.clone(),
);
if let Some(app_name) = _config.app_name() {
user_agent = user_agent.with_app_name(app_name.clone());
}
request.properties_mut().insert(user_agent);
let mut signing_config = aws_sig_auth::signer::OperationSigningConfig::default_config();
request
.properties_mut()
.insert(aws_sig_auth::signer::SignableBody::Bytes(&[]));
request.properties_mut().insert(signing_config);
request
.properties_mut()
.insert(aws_types::SigningService::from_static(
_config.signing_service(),
));
if let Some(region) = &_config.region {
request
.properties_mut()
.insert(aws_types::region::SigningRegion::from(region.clone()));
}
if let Some(region) = &_config.region {
request.properties_mut().insert(region.clone());
}
aws_http::auth::set_credentials_cache(
&mut request.properties_mut(),
_config.credentials_cache.clone(),
);
let op = aws_smithy_http::operation::Operation::new(
request,
crate::operation::StartStreamTranscription::new(),
)
.with_metadata(aws_smithy_http::operation::Metadata::new(
"StartStreamTranscription",
"transcribestreaming",
));
let op = op.with_retry_classifier(aws_http::retry::AwsResponseRetryClassifier::new());
Ok(op)
}
/// Creates a new builder-style object to manufacture [`StartStreamTranscriptionInput`](crate::input::StartStreamTranscriptionInput).
pub fn builder() -> crate::input::start_stream_transcription_input::Builder {
crate::input::start_stream_transcription_input::Builder::default()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(std::fmt::Debug)]
pub struct StartStreamTranscriptionInput {
/// <p>Specify the language code that represents the language spoken in your audio.</p>
/// <p>If you're unsure of the language spoken in your audio, consider using <code>IdentifyLanguage</code> to enable automatic language identification.</p>
/// <p>For a list of languages supported with Amazon Transcribe streaming, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
#[doc(hidden)]
pub language_code: std::option::Option<crate::model::LanguageCode>,
/// <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>
#[doc(hidden)]
pub media_sample_rate_hertz: std::option::Option<i32>,
/// <p>Specify the encoding of your input audio. Supported formats are:</p>
/// <ul>
/// <li> <p>FLAC</p> </li>
/// <li> <p>OPUS-encoded audio in an Ogg container</p> </li>
/// <li> <p>PCM (only signed 16-bit little-endian audio formats, which does not include WAV)</p> </li>
/// </ul>
/// <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>
#[doc(hidden)]
pub media_encoding: std::option::Option<crate::model::MediaEncoding>,
/// <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>
/// <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> <important>
/// <p>This parameter is <b>not</b> intended for use with the <code>IdentifyLanguage</code> parameter. If you're including <code>IdentifyLanguage</code> in your request and want to use one or more custom vocabularies with your transcription, use the <code>VocabularyNames</code> parameter instead.</p>
/// </important>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
#[doc(hidden)]
pub vocabulary_name: std::option::Option<std::string::String>,
/// <p>Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe generates an ID and returns it in the response.</p>
/// <p>You can use a session ID to retry a streaming session.</p>
#[doc(hidden)]
pub session_id: std::option::Option<std::string::String>,
/// <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
pub audio_stream: aws_smithy_http::event_stream::EventStreamSender<
crate::model::AudioStream,
crate::error::AudioStreamError,
>,
/// <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>
/// <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> <important>
/// <p>This parameter is <b>not</b> intended for use with the <code>IdentifyLanguage</code> parameter. If you're including <code>IdentifyLanguage</code> in your request and want to use one or more vocabulary filters with your transcription, use the <code>VocabularyFilterNames</code> parameter instead.</p>
/// </important>
/// <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>
#[doc(hidden)]
pub vocabulary_filter_name: std::option::Option<std::string::String>,
/// <p>Specify how you want your 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>
#[doc(hidden)]
pub vocabulary_filter_method: std::option::Option<crate::model::VocabularyFilterMethod>,
/// <p>Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers (diarization)</a>.</p>
#[doc(hidden)]
pub show_speaker_label: bool,
/// <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>If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.</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>
#[doc(hidden)]
pub enable_channel_identification: bool,
/// <p>Specify the number of channels in your audio stream. Up to two channels are supported.</p>
#[doc(hidden)]
pub number_of_channels: std::option::Option<i32>,
/// <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>
#[doc(hidden)]
pub enable_partial_results_stabilization: bool,
/// <p>Specify the level of stability to use when you enable partial results stabilization (<code>EnablePartialResultsStabilization</code>).</p>
/// <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.</p>
/// <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>
#[doc(hidden)]
pub partial_results_stability: std::option::Option<crate::model::PartialResultsStability>,
/// <p>Labels all personally identifiable information (PII) identified in your transcript.</p>
/// <p>Content identification is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is flagged upon complete transcription of an audio segment.</p>
/// <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>
/// <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>
#[doc(hidden)]
pub content_identification_type: std::option::Option<crate::model::ContentIdentificationType>,
/// <p>Redacts all personally identifiable information (PII) identified in your transcript.</p>
/// <p>Content redaction is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is redacted upon complete transcription of an audio segment.</p>
/// <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>
/// <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>
#[doc(hidden)]
pub content_redaction_type: std::option::Option<crate::model::ContentRedactionType>,
/// <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>
/// <p>To include <code>PiiEntityTypes</code> in your request, you must also include either <code>ContentIdentificationType</code> or <code>ContentRedactionType</code>.</p>
/// <p>Values must be comma-separated and can include: <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING</code>, <code>CREDIT_DEBIT_NUMBER</code>, <code>CREDIT_DEBIT_CVV</code>, <code>CREDIT_DEBIT_EXPIRY</code>, <code>PIN</code>, <code>EMAIL</code>, <code>ADDRESS</code>, <code>NAME</code>, <code>PHONE</code>, <code>SSN</code>, or <code>ALL</code>.</p>
#[doc(hidden)]
pub pii_entity_types: std::option::Option<std::string::String>,
/// <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>
/// <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>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language models</a>.</p>
#[doc(hidden)]
pub language_model_name: std::option::Option<std::string::String>,
/// <p>Enables automatic language identification for your transcription.</p>
/// <p>If you include <code>IdentifyLanguage</code>, you can optionally include a list of language codes, using <code>LanguageOptions</code>, that you think may be present in your audio stream. Including language options can improve transcription accuracy.</p>
/// <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>
/// <p>If you have multi-channel audio that contains different languages on each channel, and you've enabled channel identification, automatic language identification identifies the dominant language on each audio channel.</p>
/// <p>Note that you must include either <code>LanguageCode</code> or <code>IdentifyLanguage</code> in your request. If you include both parameters, your request fails.</p>
/// <p>Streaming language identification can't be combined with custom language models or redaction.</p>
#[doc(hidden)]
pub identify_language: bool,
/// <p>Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.</p>
/// <p>Including language options can improve the accuracy of language identification.</p>
/// <p>If you include <code>LanguageOptions</code> in your request, you must also include <code>IdentifyLanguage</code>.</p>
/// <p>For a list of languages supported with Amazon Transcribe streaming, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p> <important>
/// <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>
/// </important>
#[doc(hidden)]
pub language_options: std::option::Option<std::string::String>,
/// <p>Specify a preferred language from the subset of languages codes you specified in <code>LanguageOptions</code>.</p>
/// <p>You can only use this parameter if you've included <code>IdentifyLanguage</code> and <code>LanguageOptions</code> in your request.</p>
#[doc(hidden)]
pub preferred_language: std::option::Option<crate::model::LanguageCode>,
/// <p>Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.</p>
/// <p>If none of the languages of the specified custom vocabularies match the language identified in your media, your job fails.</p> <important>
/// <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>
/// </important>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
#[doc(hidden)]
pub vocabulary_names: std::option::Option<std::string::String>,
/// <p>Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.</p>
/// <p>If none of the languages of the specified custom vocabulary filters match the language identified in your media, your job fails.</p> <important>
/// <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>
/// </important>
/// <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>
#[doc(hidden)]
pub vocabulary_filter_names: std::option::Option<std::string::String>,
}
impl StartStreamTranscriptionInput {
/// <p>Specify the language code that represents the language spoken in your audio.</p>
/// <p>If you're unsure of the language spoken in your audio, consider using <code>IdentifyLanguage</code> to enable automatic language identification.</p>
/// <p>For a list of languages supported with Amazon Transcribe streaming, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
pub fn language_code(&self) -> std::option::Option<&crate::model::LanguageCode> {
self.language_code.as_ref()
}
/// <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>
pub fn media_sample_rate_hertz(&self) -> std::option::Option<i32> {
self.media_sample_rate_hertz
}
/// <p>Specify the encoding of your input audio. Supported formats are:</p>
/// <ul>
/// <li> <p>FLAC</p> </li>
/// <li> <p>OPUS-encoded audio in an Ogg container</p> </li>
/// <li> <p>PCM (only signed 16-bit little-endian audio formats, which does not include WAV)</p> </li>
/// </ul>
/// <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>
pub fn media_encoding(&self) -> std::option::Option<&crate::model::MediaEncoding> {
self.media_encoding.as_ref()
}
/// <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>
/// <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> <important>
/// <p>This parameter is <b>not</b> intended for use with the <code>IdentifyLanguage</code> parameter. If you're including <code>IdentifyLanguage</code> in your request and want to use one or more custom vocabularies with your transcription, use the <code>VocabularyNames</code> parameter instead.</p>
/// </important>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
pub fn vocabulary_name(&self) -> std::option::Option<&str> {
self.vocabulary_name.as_deref()
}
/// <p>Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe generates an ID and returns it in the response.</p>
/// <p>You can use a session ID to retry a streaming session.</p>
pub fn session_id(&self) -> std::option::Option<&str> {
self.session_id.as_deref()
}
/// <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
pub fn audio_stream(
&self,
) -> &aws_smithy_http::event_stream::EventStreamSender<
crate::model::AudioStream,
crate::error::AudioStreamError,
> {
&self.audio_stream
}
/// <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>
/// <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> <important>
/// <p>This parameter is <b>not</b> intended for use with the <code>IdentifyLanguage</code> parameter. If you're including <code>IdentifyLanguage</code> in your request and want to use one or more vocabulary filters with your transcription, use the <code>VocabularyFilterNames</code> parameter instead.</p>
/// </important>
/// <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>
pub fn vocabulary_filter_name(&self) -> std::option::Option<&str> {
self.vocabulary_filter_name.as_deref()
}
/// <p>Specify how you want your 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::model::VocabularyFilterMethod> {
self.vocabulary_filter_method.as_ref()
}
/// <p>Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.</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_label(&self) -> bool {
self.show_speaker_label
}
/// <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>If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.</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 enable_channel_identification(&self) -> bool {
self.enable_channel_identification
}
/// <p>Specify the number of channels in your audio stream. Up to two channels are supported.</p>
pub fn number_of_channels(&self) -> std::option::Option<i32> {
self.number_of_channels
}
/// <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>
pub fn enable_partial_results_stabilization(&self) -> bool {
self.enable_partial_results_stabilization
}
/// <p>Specify the level of stability to use when you enable partial results stabilization (<code>EnablePartialResultsStabilization</code>).</p>
/// <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.</p>
/// <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>
pub fn partial_results_stability(
&self,
) -> std::option::Option<&crate::model::PartialResultsStability> {
self.partial_results_stability.as_ref()
}
/// <p>Labels all personally identifiable information (PII) identified in your transcript.</p>
/// <p>Content identification is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is flagged upon complete transcription of an audio segment.</p>
/// <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>
/// <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>
pub fn content_identification_type(
&self,
) -> std::option::Option<&crate::model::ContentIdentificationType> {
self.content_identification_type.as_ref()
}
/// <p>Redacts all personally identifiable information (PII) identified in your transcript.</p>
/// <p>Content redaction is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is redacted upon complete transcription of an audio segment.</p>
/// <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>
/// <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>
pub fn content_redaction_type(
&self,
) -> std::option::Option<&crate::model::ContentRedactionType> {
self.content_redaction_type.as_ref()
}
/// <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>
/// <p>To include <code>PiiEntityTypes</code> in your request, you must also include either <code>ContentIdentificationType</code> or <code>ContentRedactionType</code>.</p>
/// <p>Values must be comma-separated and can include: <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING</code>, <code>CREDIT_DEBIT_NUMBER</code>, <code>CREDIT_DEBIT_CVV</code>, <code>CREDIT_DEBIT_EXPIRY</code>, <code>PIN</code>, <code>EMAIL</code>, <code>ADDRESS</code>, <code>NAME</code>, <code>PHONE</code>, <code>SSN</code>, or <code>ALL</code>.</p>
pub fn pii_entity_types(&self) -> std::option::Option<&str> {
self.pii_entity_types.as_deref()
}
/// <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>
/// <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>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language models</a>.</p>
pub fn language_model_name(&self) -> std::option::Option<&str> {
self.language_model_name.as_deref()
}
/// <p>Enables automatic language identification for your transcription.</p>
/// <p>If you include <code>IdentifyLanguage</code>, you can optionally include a list of language codes, using <code>LanguageOptions</code>, that you think may be present in your audio stream. Including language options can improve transcription accuracy.</p>
/// <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>
/// <p>If you have multi-channel audio that contains different languages on each channel, and you've enabled channel identification, automatic language identification identifies the dominant language on each audio channel.</p>
/// <p>Note that you must include either <code>LanguageCode</code> or <code>IdentifyLanguage</code> in your request. If you include both parameters, your request fails.</p>
/// <p>Streaming language identification can't be combined with custom language models or redaction.</p>
pub fn identify_language(&self) -> bool {
self.identify_language
}
/// <p>Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.</p>
/// <p>Including language options can improve the accuracy of language identification.</p>
/// <p>If you include <code>LanguageOptions</code> in your request, you must also include <code>IdentifyLanguage</code>.</p>
/// <p>For a list of languages supported with Amazon Transcribe streaming, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p> <important>
/// <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>
/// </important>
pub fn language_options(&self) -> std::option::Option<&str> {
self.language_options.as_deref()
}
/// <p>Specify a preferred language from the subset of languages codes you specified in <code>LanguageOptions</code>.</p>
/// <p>You can only use this parameter if you've included <code>IdentifyLanguage</code> and <code>LanguageOptions</code> in your request.</p>
pub fn preferred_language(&self) -> std::option::Option<&crate::model::LanguageCode> {
self.preferred_language.as_ref()
}
/// <p>Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.</p>
/// <p>If none of the languages of the specified custom vocabularies match the language identified in your media, your job fails.</p> <important>
/// <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>
/// </important>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
pub fn vocabulary_names(&self) -> std::option::Option<&str> {
self.vocabulary_names.as_deref()
}
/// <p>Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.</p>
/// <p>If none of the languages of the specified custom vocabulary filters match the language identified in your media, your job fails.</p> <important>
/// <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>
/// </important>
/// <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>
pub fn vocabulary_filter_names(&self) -> std::option::Option<&str> {
self.vocabulary_filter_names.as_deref()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(std::fmt::Debug)]
pub struct StartMedicalStreamTranscriptionInput {
/// <p>Specify the language code that represents the language spoken in your audio.</p> <important>
/// <p>Amazon Transcribe Medical only supports US English (<code>en-US</code>).</p>
/// </important>
#[doc(hidden)]
pub language_code: std::option::Option<crate::model::LanguageCode>,
/// <p>The sample rate of the input audio (in hertz). Amazon Transcribe Medical supports a range from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.</p>
#[doc(hidden)]
pub media_sample_rate_hertz: std::option::Option<i32>,
/// <p>Specify the encoding used for the input audio. Supported formats are:</p>
/// <ul>
/// <li> <p>FLAC</p> </li>
/// <li> <p>OPUS-encoded audio in an Ogg container</p> </li>
/// <li> <p>PCM (only signed 16-bit little-endian audio formats, which does not include WAV)</p> </li>
/// </ul>
/// <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>
#[doc(hidden)]
pub media_encoding: std::option::Option<crate::model::MediaEncoding>,
/// <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>
#[doc(hidden)]
pub vocabulary_name: std::option::Option<std::string::String>,
/// <p>Specify the medical specialty contained in your audio.</p>
#[doc(hidden)]
pub specialty: std::option::Option<crate::model::Specialty>,
/// <p>Specify the type of input audio. For example, choose <code>DICTATION</code> for a provider dictating patient notes and <code>CONVERSATION</code> for a dialogue between a patient and a medical professional.</p>
#[doc(hidden)]
pub r#type: std::option::Option<crate::model::Type>,
/// <p>Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers (diarization)</a>.</p>
#[doc(hidden)]
pub show_speaker_label: bool,
/// <p>Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe Medical generates an ID and returns it in the response.</p>
/// <p>You can use a session ID to retry a streaming session.</p>
#[doc(hidden)]
pub session_id: std::option::Option<std::string::String>,
/// <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
pub audio_stream: aws_smithy_http::event_stream::EventStreamSender<
crate::model::AudioStream,
crate::error::AudioStreamError,
>,
/// <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>If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.</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>
#[doc(hidden)]
pub enable_channel_identification: bool,
/// <p>Specify the number of channels in your audio stream. Up to two channels are supported.</p>
#[doc(hidden)]
pub number_of_channels: std::option::Option<i32>,
/// <p>Labels all personal health information (PHI) identified in your transcript.</p>
/// <p>Content identification is performed at the segment level; PHI is flagged upon complete transcription of an audio segment.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html">Identifying personal health information (PHI) in a transcription</a>.</p>
#[doc(hidden)]
pub content_identification_type:
std::option::Option<crate::model::MedicalContentIdentificationType>,
}
impl StartMedicalStreamTranscriptionInput {
/// <p>Specify the language code that represents the language spoken in your audio.</p> <important>
/// <p>Amazon Transcribe Medical only supports US English (<code>en-US</code>).</p>
/// </important>
pub fn language_code(&self) -> std::option::Option<&crate::model::LanguageCode> {
self.language_code.as_ref()
}
/// <p>The sample rate of the input audio (in hertz). Amazon Transcribe Medical supports a range from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.</p>
pub fn media_sample_rate_hertz(&self) -> std::option::Option<i32> {
self.media_sample_rate_hertz
}
/// <p>Specify the encoding used for the input audio. Supported formats are:</p>
/// <ul>
/// <li> <p>FLAC</p> </li>
/// <li> <p>OPUS-encoded audio in an Ogg container</p> </li>
/// <li> <p>PCM (only signed 16-bit little-endian audio formats, which does not include WAV)</p> </li>
/// </ul>
/// <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>
pub fn media_encoding(&self) -> std::option::Option<&crate::model::MediaEncoding> {
self.media_encoding.as_ref()
}
/// <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>
pub fn vocabulary_name(&self) -> std::option::Option<&str> {
self.vocabulary_name.as_deref()
}
/// <p>Specify the medical specialty contained in your audio.</p>
pub fn specialty(&self) -> std::option::Option<&crate::model::Specialty> {
self.specialty.as_ref()
}
/// <p>Specify the type of input audio. For example, choose <code>DICTATION</code> for a provider dictating patient notes and <code>CONVERSATION</code> for a dialogue between a patient and a medical professional.</p>
pub fn r#type(&self) -> std::option::Option<&crate::model::Type> {
self.r#type.as_ref()
}
/// <p>Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.</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_label(&self) -> bool {
self.show_speaker_label
}
/// <p>Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe Medical generates an ID and returns it in the response.</p>
/// <p>You can use a session ID to retry a streaming session.</p>
pub fn session_id(&self) -> std::option::Option<&str> {
self.session_id.as_deref()
}
/// <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
pub fn audio_stream(
&self,
) -> &aws_smithy_http::event_stream::EventStreamSender<
crate::model::AudioStream,
crate::error::AudioStreamError,
> {
&self.audio_stream
}
/// <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>If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.</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 enable_channel_identification(&self) -> bool {
self.enable_channel_identification
}
/// <p>Specify the number of channels in your audio stream. Up to two channels are supported.</p>
pub fn number_of_channels(&self) -> std::option::Option<i32> {
self.number_of_channels
}
/// <p>Labels all personal health information (PHI) identified in your transcript.</p>
/// <p>Content identification is performed at the segment level; PHI is flagged upon complete transcription of an audio segment.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html">Identifying personal health information (PHI) in a transcription</a>.</p>
pub fn content_identification_type(
&self,
) -> std::option::Option<&crate::model::MedicalContentIdentificationType> {
self.content_identification_type.as_ref()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(std::fmt::Debug)]
pub struct StartCallAnalyticsStreamTranscriptionInput {
/// <p>Specify the language code that represents the language spoken in your audio.</p>
/// <p>If you're unsure of the language spoken in your audio, consider using <code>IdentifyLanguage</code> to enable automatic language identification.</p>
/// <p>For a list of languages supported with streaming Call Analytics, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
#[doc(hidden)]
pub language_code: std::option::Option<crate::model::CallAnalyticsLanguageCode>,
/// <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>
#[doc(hidden)]
pub media_sample_rate_hertz: std::option::Option<i32>,
/// <p>Specify the encoding of your input audio. Supported formats are:</p>
/// <ul>
/// <li> <p>FLAC</p> </li>
/// <li> <p>OPUS-encoded audio in an Ogg container</p> </li>
/// <li> <p>PCM (only signed 16-bit little-endian audio formats, which does not include WAV)</p> </li>
/// </ul>
/// <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>
#[doc(hidden)]
pub media_encoding: std::option::Option<crate::model::MediaEncoding>,
/// <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>
/// <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>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
#[doc(hidden)]
pub vocabulary_name: std::option::Option<std::string::String>,
/// <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>
/// <p>You can use a session ID to retry a streaming session.</p>
#[doc(hidden)]
pub session_id: std::option::Option<std::string::String>,
/// <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
pub audio_stream: aws_smithy_http::event_stream::EventStreamSender<
crate::model::AudioStream,
crate::error::AudioStreamError,
>,
/// <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>
/// <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>
/// <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>
#[doc(hidden)]
pub vocabulary_filter_name: std::option::Option<std::string::String>,
/// <p>Specify how you want your 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>
#[doc(hidden)]
pub vocabulary_filter_method: std::option::Option<crate::model::VocabularyFilterMethod>,
/// <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>
/// <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>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language models</a>.</p>
#[doc(hidden)]
pub language_model_name: std::option::Option<std::string::String>,
/// <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>
#[doc(hidden)]
pub enable_partial_results_stabilization: bool,
/// <p>Specify the level of stability to use when you enable partial results stabilization (<code>EnablePartialResultsStabilization</code>).</p>
/// <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.</p>
/// <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>
#[doc(hidden)]
pub partial_results_stability: std::option::Option<crate::model::PartialResultsStability>,
/// <p>Labels all personally identifiable information (PII) identified in your transcript.</p>
/// <p>Content identification is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is flagged upon complete transcription of an audio segment.</p>
/// <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>
/// <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>
#[doc(hidden)]
pub content_identification_type: std::option::Option<crate::model::ContentIdentificationType>,
/// <p>Redacts all personally identifiable information (PII) identified in your transcript.</p>
/// <p>Content redaction is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is redacted upon complete transcription of an audio segment.</p>
/// <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>
/// <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>
#[doc(hidden)]
pub content_redaction_type: std::option::Option<crate::model::ContentRedactionType>,
/// <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>
/// <p>To include <code>PiiEntityTypes</code> in your Call Analytics request, you must also include either <code>ContentIdentificationType</code> or <code>ContentRedactionType</code>.</p>
/// <p>Values must be comma-separated and can include: <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING</code>, <code>CREDIT_DEBIT_NUMBER</code>, <code>CREDIT_DEBIT_CVV</code>, <code>CREDIT_DEBIT_EXPIRY</code>, <code>PIN</code>, <code>EMAIL</code>, <code>ADDRESS</code>, <code>NAME</code>, <code>PHONE</code>, <code>SSN</code>, or <code>ALL</code>.</p>
#[doc(hidden)]
pub pii_entity_types: std::option::Option<std::string::String>,
}
impl StartCallAnalyticsStreamTranscriptionInput {
/// <p>Specify the language code that represents the language spoken in your audio.</p>
/// <p>If you're unsure of the language spoken in your audio, consider using <code>IdentifyLanguage</code> to enable automatic language identification.</p>
/// <p>For a list of languages supported with streaming Call Analytics, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
pub fn language_code(&self) -> std::option::Option<&crate::model::CallAnalyticsLanguageCode> {
self.language_code.as_ref()
}
/// <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>
pub fn media_sample_rate_hertz(&self) -> std::option::Option<i32> {
self.media_sample_rate_hertz
}
/// <p>Specify the encoding of your input audio. Supported formats are:</p>
/// <ul>
/// <li> <p>FLAC</p> </li>
/// <li> <p>OPUS-encoded audio in an Ogg container</p> </li>
/// <li> <p>PCM (only signed 16-bit little-endian audio formats, which does not include WAV)</p> </li>
/// </ul>
/// <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>
pub fn media_encoding(&self) -> std::option::Option<&crate::model::MediaEncoding> {
self.media_encoding.as_ref()
}
/// <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>
/// <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>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
pub fn vocabulary_name(&self) -> std::option::Option<&str> {
self.vocabulary_name.as_deref()
}
/// <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>
/// <p>You can use a session ID to retry a streaming session.</p>
pub fn session_id(&self) -> std::option::Option<&str> {
self.session_id.as_deref()
}
/// <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
pub fn audio_stream(
&self,
) -> &aws_smithy_http::event_stream::EventStreamSender<
crate::model::AudioStream,
crate::error::AudioStreamError,
> {
&self.audio_stream
}
/// <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>
/// <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>
/// <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>
pub fn vocabulary_filter_name(&self) -> std::option::Option<&str> {
self.vocabulary_filter_name.as_deref()
}
/// <p>Specify how you want your 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::model::VocabularyFilterMethod> {
self.vocabulary_filter_method.as_ref()
}
/// <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>
/// <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>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language models</a>.</p>
pub fn language_model_name(&self) -> std::option::Option<&str> {
self.language_model_name.as_deref()
}
/// <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>
pub fn enable_partial_results_stabilization(&self) -> bool {
self.enable_partial_results_stabilization
}
/// <p>Specify the level of stability to use when you enable partial results stabilization (<code>EnablePartialResultsStabilization</code>).</p>
/// <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.</p>
/// <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>
pub fn partial_results_stability(
&self,
) -> std::option::Option<&crate::model::PartialResultsStability> {
self.partial_results_stability.as_ref()
}
/// <p>Labels all personally identifiable information (PII) identified in your transcript.</p>
/// <p>Content identification is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is flagged upon complete transcription of an audio segment.</p>
/// <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>
/// <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>
pub fn content_identification_type(
&self,
) -> std::option::Option<&crate::model::ContentIdentificationType> {
self.content_identification_type.as_ref()
}
/// <p>Redacts all personally identifiable information (PII) identified in your transcript.</p>
/// <p>Content redaction is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is redacted upon complete transcription of an audio segment.</p>
/// <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>
/// <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>
pub fn content_redaction_type(
&self,
) -> std::option::Option<&crate::model::ContentRedactionType> {
self.content_redaction_type.as_ref()
}
/// <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>
/// <p>To include <code>PiiEntityTypes</code> in your Call Analytics request, you must also include either <code>ContentIdentificationType</code> or <code>ContentRedactionType</code>.</p>
/// <p>Values must be comma-separated and can include: <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING</code>, <code>CREDIT_DEBIT_NUMBER</code>, <code>CREDIT_DEBIT_CVV</code>, <code>CREDIT_DEBIT_EXPIRY</code>, <code>PIN</code>, <code>EMAIL</code>, <code>ADDRESS</code>, <code>NAME</code>, <code>PHONE</code>, <code>SSN</code>, or <code>ALL</code>.</p>
pub fn pii_entity_types(&self) -> std::option::Option<&str> {
self.pii_entity_types.as_deref()
}
}