Struct aws_sdk_transcribe::model::CallAnalyticsJobSettings

#[non_exhaustive]
pub struct CallAnalyticsJobSettings { /* private fields */ }

Provides additional optional settings for your request, including content redaction, automatic language identification; allows you to apply custom language models, vocabulary filters, and custom vocabularies.

Implementations

impl CallAnalyticsJobSettings

pub fn vocabulary_name(&self) -> Option<&str>

The name of the custom vocabulary you want to include in your Call Analytics transcription request. Vocabulary names are case sensitive.

pub fn vocabulary_filter_name(&self) -> Option<&str>

The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. Vocabulary filter names are case sensitive.

Note that if you include VocabularyFilterName in your request, you must also include 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.

pub fn language_model_name(&self) -> Option<&str>

The name of the custom language model you want to use when processing your Call Analytics job. 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 language model isn't applied. There are no errors or warnings associated with a language mismatch.

pub fn content_redaction(&self) -> Option<&ContentRedaction>

Allows you to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: PiiEntityTypes, RedactionOutput, and RedactionType.

pub fn language_options(&self) -> Option<&[LanguageCode]>

You can 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.

Including language options can improve the accuracy of language identification.

For a list of languages supported with Call Analytics, refer to the Supported languages table.

pub fn language_id_settings(
    &self
) -> Option<&HashMap<LanguageCode, LanguageIdSettings>>

If using automatic language identification (IdentifyLanguage) in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName).

You can 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. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.

To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification.

If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter.

If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter.

impl CallAnalyticsJobSettings

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CallAnalyticsJobSettings.

Trait Implementations

impl Clone for CallAnalyticsJobSettings

fn clone(&self) -> CallAnalyticsJobSettings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CallAnalyticsJobSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<CallAnalyticsJobSettings> for CallAnalyticsJobSettings

fn eq(&self, other: &CallAnalyticsJobSettings) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CallAnalyticsJobSettings