Struct aws_sdk_transcribestreaming::operation::start_call_analytics_stream_transcription::StartCallAnalyticsStreamTranscriptionInput
source · #[non_exhaustive]pub struct StartCallAnalyticsStreamTranscriptionInput {Show 14 fields
pub language_code: Option<CallAnalyticsLanguageCode>,
pub media_sample_rate_hertz: Option<i32>,
pub media_encoding: Option<MediaEncoding>,
pub vocabulary_name: Option<String>,
pub session_id: Option<String>,
pub audio_stream: EventStreamSender<AudioStream, AudioStreamError>,
pub vocabulary_filter_name: Option<String>,
pub vocabulary_filter_method: Option<VocabularyFilterMethod>,
pub language_model_name: Option<String>,
pub enable_partial_results_stabilization: Option<bool>,
pub partial_results_stability: Option<PartialResultsStability>,
pub content_identification_type: Option<ContentIdentificationType>,
pub content_redaction_type: Option<ContentRedactionType>,
pub pii_entity_types: Option<String>,
}Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.language_code: Option<CallAnalyticsLanguageCode>Specify the language code that represents the language spoken in your audio.
If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification.
For a list of languages supported with streaming Call Analytics, refer to the Supported languages table.
media_sample_rate_hertz: Option<i32>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.
media_encoding: Option<MediaEncoding>Specify the encoding of your input audio. Supported formats are:
-
FLAC
-
OPUS-encoded audio in an Ogg container
-
PCM (only signed 16-bit little-endian audio formats, which does not include WAV)
For more information, see Media formats.
vocabulary_name: Option<String>Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.
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.
For more information, see Custom vocabularies.
session_id: Option<String>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.
You can use a session ID to retry a streaming session.
audio_stream: EventStreamSender<AudioStream, AudioStreamError>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.
For more information, see Transcribing streaming audio.
vocabulary_filter_name: Option<String>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.
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.
For more information, see Using vocabulary filtering with unwanted words.
vocabulary_filter_method: Option<VocabularyFilterMethod>Specify how you want your vocabulary filter applied to your transcript.
To replace words with ***, choose mask.
To delete words, choose remove.
To flag words without changing them, choose tag.
language_model_name: Option<String>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.
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.
For more information, see Custom language models.
enable_partial_results_stabilization: Option<bool>Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see Partial-result stabilization.
partial_results_stability: Option<PartialResultsStability>Specify the level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization).
Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.
For more information, see Partial-result stabilization.
content_identification_type: Option<ContentIdentificationType>Labels all personally identifiable information (PII) identified in your transcript.
Content identification is performed at the segment level; PII specified in PiiEntityTypes is flagged upon complete transcription of an audio segment.
You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException.
For more information, see Redacting or identifying personally identifiable information.
content_redaction_type: Option<ContentRedactionType>Redacts all personally identifiable information (PII) identified in your transcript.
Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment.
You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.
For more information, see Redacting or identifying personally identifiable information.
pii_entity_types: Option<String>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 ALL.
To include PiiEntityTypes in your Call Analytics request, you must also include either ContentIdentificationType or ContentRedactionType.
Values must be comma-separated and can include: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, or ALL.
Implementations§
source§impl StartCallAnalyticsStreamTranscriptionInput
impl StartCallAnalyticsStreamTranscriptionInput
sourcepub fn language_code(&self) -> Option<&CallAnalyticsLanguageCode>
pub fn language_code(&self) -> Option<&CallAnalyticsLanguageCode>
Specify the language code that represents the language spoken in your audio.
If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification.
For a list of languages supported with streaming Call Analytics, refer to the Supported languages table.
sourcepub fn media_sample_rate_hertz(&self) -> Option<i32>
pub fn media_sample_rate_hertz(&self) -> Option<i32>
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.
sourcepub fn media_encoding(&self) -> Option<&MediaEncoding>
pub fn media_encoding(&self) -> Option<&MediaEncoding>
Specify the encoding of your input audio. Supported formats are:
-
FLAC
-
OPUS-encoded audio in an Ogg container
-
PCM (only signed 16-bit little-endian audio formats, which does not include WAV)
For more information, see Media formats.
sourcepub fn vocabulary_name(&self) -> Option<&str>
pub fn vocabulary_name(&self) -> Option<&str>
Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.
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.
For more information, see Custom vocabularies.
sourcepub fn session_id(&self) -> Option<&str>
pub fn session_id(&self) -> Option<&str>
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.
You can use a session ID to retry a streaming session.
sourcepub fn audio_stream(&self) -> &EventStreamSender<AudioStream, AudioStreamError>
pub fn audio_stream(&self) -> &EventStreamSender<AudioStream, AudioStreamError>
An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.
For more information, see Transcribing streaming audio.
sourcepub fn vocabulary_filter_name(&self) -> Option<&str>
pub fn vocabulary_filter_name(&self) -> Option<&str>
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.
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.
For more information, see Using vocabulary filtering with unwanted words.
sourcepub fn vocabulary_filter_method(&self) -> Option<&VocabularyFilterMethod>
pub fn vocabulary_filter_method(&self) -> Option<&VocabularyFilterMethod>
Specify how you want your vocabulary filter applied to your transcript.
To replace words with ***, choose mask.
To delete words, choose remove.
To flag words without changing them, choose tag.
sourcepub fn language_model_name(&self) -> Option<&str>
pub fn language_model_name(&self) -> Option<&str>
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.
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.
For more information, see Custom language models.
sourcepub fn enable_partial_results_stabilization(&self) -> Option<bool>
pub fn enable_partial_results_stabilization(&self) -> Option<bool>
Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see Partial-result stabilization.
sourcepub fn partial_results_stability(&self) -> Option<&PartialResultsStability>
pub fn partial_results_stability(&self) -> Option<&PartialResultsStability>
Specify the level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization).
Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.
For more information, see Partial-result stabilization.
sourcepub fn content_identification_type(&self) -> Option<&ContentIdentificationType>
pub fn content_identification_type(&self) -> Option<&ContentIdentificationType>
Labels all personally identifiable information (PII) identified in your transcript.
Content identification is performed at the segment level; PII specified in PiiEntityTypes is flagged upon complete transcription of an audio segment.
You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException.
For more information, see Redacting or identifying personally identifiable information.
sourcepub fn content_redaction_type(&self) -> Option<&ContentRedactionType>
pub fn content_redaction_type(&self) -> Option<&ContentRedactionType>
Redacts all personally identifiable information (PII) identified in your transcript.
Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment.
You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.
For more information, see Redacting or identifying personally identifiable information.
sourcepub fn pii_entity_types(&self) -> Option<&str>
pub fn pii_entity_types(&self) -> Option<&str>
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 ALL.
To include PiiEntityTypes in your Call Analytics request, you must also include either ContentIdentificationType or ContentRedactionType.
Values must be comma-separated and can include: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, or ALL.
source§impl StartCallAnalyticsStreamTranscriptionInput
impl StartCallAnalyticsStreamTranscriptionInput
sourcepub fn builder() -> StartCallAnalyticsStreamTranscriptionInputBuilder
pub fn builder() -> StartCallAnalyticsStreamTranscriptionInputBuilder
Creates a new builder-style object to manufacture StartCallAnalyticsStreamTranscriptionInput.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for StartCallAnalyticsStreamTranscriptionInput
impl !RefUnwindSafe for StartCallAnalyticsStreamTranscriptionInput
impl Send for StartCallAnalyticsStreamTranscriptionInput
impl Sync for StartCallAnalyticsStreamTranscriptionInput
impl Unpin for StartCallAnalyticsStreamTranscriptionInput
impl !UnwindSafe for StartCallAnalyticsStreamTranscriptionInput
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling [Attribute] value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi [Quirk] value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the [Condition] value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);