Struct aws_sdk_transcribe::model::CallAnalyticsJobSettings

#[non_exhaustive]
pub struct CallAnalyticsJobSettings {
    pub vocabulary_name: Option<String>,
    pub vocabulary_filter_name: Option<String>,
    pub vocabulary_filter_method: Option<VocabularyFilterMethod>,
    pub language_model_name: Option<String>,
    pub content_redaction: Option<ContentRedaction>,
    pub language_options: Option<Vec<LanguageCode>>,
    pub language_id_settings: Option<HashMap<LanguageCode, LanguageIdSettings>>,
}

Provides optional settings for the CallAnalyticsJob operation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

vocabulary_name: Option<String>

The name of a vocabulary to use when processing the call analytics job.

vocabulary_filter_name: Option<String>

The name of the vocabulary filter to use when running a call analytics job. The filter that you specify must have the same language code as the analytics job.

vocabulary_filter_method: Option<VocabularyFilterMethod>

Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.

language_model_name: Option<String>

The structure used to describe a custom language model.

content_redaction: Option<ContentRedaction>

Settings for content redaction within a transcription job.

language_options: Option<Vec<LanguageCode>>

When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.

To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages for additional information.

language_id_settings: Option<HashMap<LanguageCode, LanguageIdSettings>>

The language identification settings associated with your call analytics job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.

Implementations

impl CallAnalyticsJobSettings

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

The name of a vocabulary to use when processing the call analytics job.

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

The name of the vocabulary filter to use when running a call analytics job. The filter that you specify must have the same language code as the analytics job.

pub fn vocabulary_filter_method(&self) -> Option<&VocabularyFilterMethod>

Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.

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

The structure used to describe a custom language model.

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

Settings for content redaction within a transcription job.

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

When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.

To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages for additional information.

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

The language identification settings associated with your call analytics job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.

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: &CallAnalyticsJobSettings) -> bool

This method tests for !=.

impl StructuralPartialEq for CallAnalyticsJobSettings