Struct aws_sdk_chimesdkmediapipelines::types::AmazonTranscribeProcessorConfiguration

#[non_exhaustive]
pub struct AmazonTranscribeProcessorConfiguration {

    pub language_code: Option<CallAnalyticsLanguageCode>,
    pub vocabulary_name: Option<String>,
    pub vocabulary_filter_name: Option<String>,
    pub vocabulary_filter_method: Option<VocabularyFilterMethod>,
    pub show_speaker_label: bool,
    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 language_model_name: Option<String>,
    pub filter_partial_results: bool,
    pub identify_language: bool,
    pub language_options: Option<String>,
    pub preferred_language: Option<CallAnalyticsLanguageCode>,
    pub vocabulary_names: Option<String>,
    pub vocabulary_filter_names: Option<String>,
}

A structure that contains the configuration settings for an Amazon Transcribe 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: Option<CallAnalyticsLanguageCode>

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 that real-time Call Analytics supports, see the Supported languages table in the Amazon Transcribe Developer Guide.

vocabulary_name: Option<String>

The name of the custom vocabulary that you specified in your Call Analytics request.

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

vocabulary_filter_name: Option<String>

The name of the custom vocabulary filter that you specified in your Call Analytics request.

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

vocabulary_filter_method: Option<VocabularyFilterMethod>

The vocabulary filtering method used in your Call Analytics transcription.

show_speaker_label: bool

Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

For more information, see Partitioning speakers (diarization) 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>

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 set both, 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 set both, 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>

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.

If you leave this parameter empty, the default behavior is equivalent to ALL.

language_model_name: Option<String>

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

filter_partial_results: bool

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

identify_language: bool

Turns language identification on or off.

language_options: Option<String>

The language options for the transcription, such as automatic language detection.

preferred_language: Option<CallAnalyticsLanguageCode>

The preferred language for the transcription.

vocabulary_names: Option<String>

The names of the custom vocabulary or vocabularies used during transcription.

vocabulary_filter_names: Option<String>

The names of the custom vocabulary filter or filters using during transcription.

Implementations

impl AmazonTranscribeProcessorConfiguration

pub fn language_code(&self) -> Option<&CallAnalyticsLanguageCode>

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 that real-time Call Analytics supports, see the Supported languages table in the Amazon Transcribe Developer Guide.

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

The name of the custom vocabulary that you specified in your Call Analytics request.

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

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

The name of the custom vocabulary filter that you specified in your Call Analytics request.

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

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

The vocabulary filtering method used in your Call Analytics transcription.

pub fn show_speaker_label(&self) -> bool

Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

For more information, see Partitioning speakers (diarization) 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>

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 set both, 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 set both, 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>

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.

If you leave this parameter empty, the default behavior is equivalent to ALL.

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

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

pub fn filter_partial_results(&self) -> bool

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

pub fn identify_language(&self) -> bool

Turns language identification on or off.

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

The language options for the transcription, such as automatic language detection.

pub fn preferred_language(&self) -> Option<&CallAnalyticsLanguageCode>

The preferred language for the transcription.

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

The names of the custom vocabulary or vocabularies used during transcription.

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

The names of the custom vocabulary filter or filters using during transcription.

impl AmazonTranscribeProcessorConfiguration

pub fn builder() -> AmazonTranscribeProcessorConfigurationBuilder

Creates a new builder-style object to manufacture AmazonTranscribeProcessorConfiguration.

Trait Implementations

impl Clone for AmazonTranscribeProcessorConfiguration

fn clone(&self) -> AmazonTranscribeProcessorConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AmazonTranscribeProcessorConfiguration

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

Formats the value using the given formatter.

impl PartialEq for AmazonTranscribeProcessorConfiguration

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