Struct aws_sdk_chimesdkmediapipelines::types::AmazonTranscribeCallAnalyticsProcessorConfiguration

#[non_exhaustive]
pub struct AmazonTranscribeCallAnalyticsProcessorConfiguration {

    pub language_code: CallAnalyticsLanguageCode,
    pub vocabulary_name: Option<String>,
    pub vocabulary_filter_name: Option<String>,
    pub vocabulary_filter_method: Option<VocabularyFilterMethod>,
    pub language_model_name: Option<String>,
    pub enable_partial_results_stabilization: bool,
    pub partial_results_stability: Option<PartialResultsStability>,
    pub content_identification_type: Option<ContentType>,
    pub content_redaction_type: Option<ContentType>,
    pub pii_entity_types: Option<String>,
    pub filter_partial_results: bool,
    pub post_call_analytics_settings: Option<PostCallAnalyticsSettings>,
    pub call_analytics_stream_categories: Option<Vec<String>>,
}

A structure that contains the configuration settings for an Amazon Transcribe call analytics processor.

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.

language_code: CallAnalyticsLanguageCode

The language code in the configuration.

vocabulary_name: Option<String>

Specifies the name of the custom vocabulary to use when processing a 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 in the Amazon Transcribe Developer Guide.

Length Constraints: Minimum length of 1. Maximum length of 200.

vocabulary_filter_name: Option<String>

Specifies the name of the custom vocabulary filter to use when processing a 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 in the Amazon Transcribe Developer Guide.

Length Constraints: Minimum length of 1. Maximum length of 200.

vocabulary_filter_method: Option<VocabularyFilterMethod>

Specifies how to apply a vocabulary filter to a 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>

Specifies the name of the custom language model to use when processing a transcription. Note that language model names are case sensitive.

The language of the specified language model must match the language code specified in the transcription request. If the languages don't match, the custom language model isn't applied. Language mismatches don't generate errors or warnings.

For more information, see Custom language models in the Amazon Transcribe Developer Guide.

enable_partial_results_stabilization: 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 in the Amazon Transcribe Developer Guide.

partial_results_stability: Option<PartialResultsStability>

Specifies 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 in the Amazon Transcribe Developer Guide.

content_identification_type: Option<ContentType>

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 do, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.

content_redaction_type: Option<ContentType>

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 do, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.

pii_entity_types: Option<String>

Specifies the types of personally identifiable information (PII) to redact from a 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 ContentIdentificationType or ContentRedactionType, but you can't include both.

Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL.

Length Constraints: Minimum length of 1. Maximum length of 300.

filter_partial_results: bool

If true, UtteranceEvents with IsPartial: true are filtered out of the insights target.

post_call_analytics_settings: Option<PostCallAnalyticsSettings>

The settings for a post-call analysis task in an analytics configuration.

call_analytics_stream_categories: Option<Vec<String>>

By default, all CategoryEvents are sent to the insights target. If this parameter is specified, only included categories are sent to the insights target.

Implementations

impl AmazonTranscribeCallAnalyticsProcessorConfiguration

pub fn language_code(&self) -> &CallAnalyticsLanguageCode

The language code in the configuration.

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

Specifies the name of the custom vocabulary to use when processing a 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 in the Amazon Transcribe Developer Guide.

Length Constraints: Minimum length of 1. Maximum length of 200.

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

Specifies the name of the custom vocabulary filter to use when processing a 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 in the Amazon Transcribe Developer Guide.

Length Constraints: Minimum length of 1. Maximum length of 200.

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

Specifies how to apply a vocabulary filter to a 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>

Specifies the name of the custom language model to use when processing a transcription. Note that language model names are case sensitive.

The language of the specified language model must match the language code specified in the transcription request. If the languages don't match, the custom language model isn't applied. Language mismatches don't generate errors or warnings.

For more information, see Custom language models in the Amazon Transcribe Developer Guide.

pub fn enable_partial_results_stabilization(&self) -> 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 in the Amazon Transcribe Developer Guide.

pub fn partial_results_stability(&self) -> Option<&PartialResultsStability>

Specifies 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 in the Amazon Transcribe Developer Guide.

pub fn content_identification_type(&self) -> Option<&ContentType>

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 do, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.

pub fn content_redaction_type(&self) -> Option<&ContentType>

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 do, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.

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

Specifies the types of personally identifiable information (PII) to redact from a 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 ContentIdentificationType or ContentRedactionType, but you can't include both.

Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL.

Length Constraints: Minimum length of 1. Maximum length of 300.

pub fn filter_partial_results(&self) -> bool

If true, UtteranceEvents with IsPartial: true are filtered out of the insights target.

pub fn post_call_analytics_settings(&self) -> Option<&PostCallAnalyticsSettings>

The settings for a post-call analysis task in an analytics configuration.

pub fn call_analytics_stream_categories(&self) -> &[String]

By default, all CategoryEvents are sent to the insights target. If this parameter is specified, only included categories are sent to the insights target.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .call_analytics_stream_categories.is_none().

impl AmazonTranscribeCallAnalyticsProcessorConfiguration

pub fn builder() -> AmazonTranscribeCallAnalyticsProcessorConfigurationBuilder

Creates a new builder-style object to manufacture AmazonTranscribeCallAnalyticsProcessorConfiguration.

Trait Implementations

impl Clone for AmazonTranscribeCallAnalyticsProcessorConfiguration

fn clone(&self) -> AmazonTranscribeCallAnalyticsProcessorConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AmazonTranscribeCallAnalyticsProcessorConfiguration

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

Formats the value using the given formatter.

impl PartialEq for AmazonTranscribeCallAnalyticsProcessorConfiguration

fn eq( &self, other: &AmazonTranscribeCallAnalyticsProcessorConfiguration ) -> 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 AmazonTranscribeCallAnalyticsProcessorConfiguration