Skip to content

AmazonTranscribeProcessorConfiguration

Source code in docs_src/capo_chime_sdk_media_pipelines/types/amazon_transcribe_processor_configuration.py
class AmazonTranscribeProcessorConfiguration(TypedDict, closed=True):
    language_code: NotRequired[
        "capo_chime_sdk_media_pipelines.types.call_analytics_language_code.CallAnalyticsLanguageCode"
    ]
    """<p>The language code that represents the language spoken in your audio.</p> <p>If you're unsure of the language spoken in your audio, consider using <code>IdentifyLanguage</code> to enable automatic language identification.</p> <p>For a list of languages that real-time Call Analytics supports, see the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages table</a> in the <i>Amazon Transcribe Developer Guide</i>.</p>"""
    vocabulary_name: NotRequired[
        "capo_chime_sdk_media_pipelines.types.vocabulary_name.VocabularyName"
    ]
    """<p>The name of the custom vocabulary that you specified in your Call Analytics request.</p> <p>Length Constraints: Minimum length of 1. Maximum length of 200.</p>"""
    vocabulary_filter_name: NotRequired[
        "capo_chime_sdk_media_pipelines.types.vocabulary_filter_name.VocabularyFilterName"
    ]
    """<p>The name of the custom vocabulary filter that you specified in your Call Analytics request.</p> <p>Length Constraints: Minimum length of 1. Maximum length of 200.</p>"""
    vocabulary_filter_method: NotRequired[
        "capo_chime_sdk_media_pipelines.types.vocabulary_filter_method.VocabularyFilterMethod"
    ]
    """<p>The vocabulary filtering method used in your Call Analytics transcription.</p>"""
    show_speaker_label: "capo_chime_sdk_media_pipelines.types.boolean.Boolean"
    """<p>Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers (diarization)</a> in the <i>Amazon Transcribe Developer Guide</i>.</p>"""
    enable_partial_results_stabilization: (
        "capo_chime_sdk_media_pipelines.types.boolean.Boolean"
    )
    """<p>Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization">Partial-result stabilization</a> in the <i>Amazon Transcribe Developer Guide</i>.</p>"""
    partial_results_stability: NotRequired[
        "capo_chime_sdk_media_pipelines.types.partial_results_stability.PartialResultsStability"
    ]
    """<p>The level of stability to use when you enable partial results stabilization (<code>EnablePartialResultsStabilization</code>).</p> <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization">Partial-result stabilization</a> in the <i>Amazon Transcribe Developer Guide</i>.</p>"""
    content_identification_type: NotRequired[
        "capo_chime_sdk_media_pipelines.types.content_type.ContentType"
    ]
    """<p>Labels all personally identifiable information (PII) identified in your transcript.</p> <p>Content identification is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is flagged upon complete transcription of an audio segment.</p> <p>You can’t set <code>ContentIdentificationType</code> and <code>ContentRedactionType</code> in the same request. If you set both, your request returns a <code>BadRequestException</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html">Redacting or identifying personally identifiable information</a> in the <i>Amazon Transcribe Developer Guide</i>.</p>"""
    content_redaction_type: NotRequired[
        "capo_chime_sdk_media_pipelines.types.content_type.ContentType"
    ]
    """<p>Redacts all personally identifiable information (PII) identified in your transcript.</p> <p>Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment.</p> <p>You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a <code>BadRequestException</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html">Redacting or identifying personally identifiable information</a> in the <i>Amazon Transcribe Developer Guide</i>.</p>"""
    pii_entity_types: NotRequired[
        "capo_chime_sdk_media_pipelines.types.pii_entity_types.PiiEntityTypes"
    ]
    """<p>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 <code>ALL</code>.</p> <p>To include <code>PiiEntityTypes</code> in your Call Analytics request, you must also include <code>ContentIdentificationType</code> or <code>ContentRedactionType</code>, but you can't include both.</p> <p>Values must be comma-separated and can include: <code>ADDRESS</code>, <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING</code>, <code>CREDIT_DEBIT_CVV</code>, <code>CREDIT_DEBIT_EXPIRY</code>, <code>CREDIT_DEBIT_NUMBER</code>, <code>EMAIL</code>, <code>NAME</code>, <code>PHONE</code>, <code>PIN</code>, <code>SSN</code>, or <code>ALL</code>.</p> <p>If you leave this parameter empty, the default behavior is equivalent to <code>ALL</code>.</p>"""
    language_model_name: NotRequired[
        "capo_chime_sdk_media_pipelines.types.model_name.ModelName"
    ]
    """<p>The name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.</p> <p>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.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language models</a> in the <i>Amazon Transcribe Developer Guide</i>.</p>"""
    filter_partial_results: "capo_chime_sdk_media_pipelines.types.boolean.Boolean"
    """<p>If true, <code>TranscriptEvents</code> with <code>IsPartial: true</code> are filtered out of the insights target.</p>"""
    identify_language: "capo_chime_sdk_media_pipelines.types.boolean.Boolean"
    """<p>Turns language identification on or off.</p>"""
    identify_multiple_languages: "capo_chime_sdk_media_pipelines.types.boolean.Boolean"
    """<p>Turns language identification on or off for multiple languages.</p> <note> <p>Calls to this API must include a <code>LanguageCode</code>, <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> parameter. If you include more than one of those parameters, your transcription job fails.</p> </note>"""
    language_options: NotRequired[
        "capo_chime_sdk_media_pipelines.types.language_options.LanguageOptions"
    ]
    """<p>The language options for the transcription, such as automatic language detection.</p>"""
    preferred_language: NotRequired[
        "capo_chime_sdk_media_pipelines.types.call_analytics_language_code.CallAnalyticsLanguageCode"
    ]
    """<p>The preferred language for the transcription.</p>"""
    vocabulary_names: NotRequired[
        "capo_chime_sdk_media_pipelines.types.vocabulary_names.VocabularyNames"
    ]
    """<p>The names of the custom vocabulary or vocabularies used during transcription.</p>"""
    vocabulary_filter_names: NotRequired[
        "capo_chime_sdk_media_pipelines.types.vocabulary_filter_names.VocabularyFilterNames"
    ]
    """<p>The names of the custom vocabulary filter or filters using during transcription.</p>"""

content_identification_type instance-attribute

content_identification_type: NotRequired[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 instance-attribute

content_redaction_type: NotRequired[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.

enable_partial_results_stabilization instance-attribute

enable_partial_results_stabilization: Boolean

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.

filter_partial_results instance-attribute

filter_partial_results: Boolean

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

identify_language instance-attribute

identify_language: Boolean

Turns language identification on or off.

identify_multiple_languages instance-attribute

identify_multiple_languages: Boolean

Turns language identification on or off for multiple languages.

Calls to this API must include a LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages parameter. If you include more than one of those parameters, your transcription job fails.

language_code instance-attribute

language_code: NotRequired[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.

language_model_name instance-attribute

language_model_name: NotRequired[ModelName]

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.

language_options instance-attribute

language_options: NotRequired[LanguageOptions]

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

partial_results_stability instance-attribute

partial_results_stability: NotRequired[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.

pii_entity_types instance-attribute

pii_entity_types: NotRequired[PiiEntityTypes]

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.

preferred_language instance-attribute

preferred_language: NotRequired[CallAnalyticsLanguageCode]

The preferred language for the transcription.

show_speaker_label instance-attribute

show_speaker_label: Boolean

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.

vocabulary_filter_method instance-attribute

vocabulary_filter_method: NotRequired[VocabularyFilterMethod]

The vocabulary filtering method used in your Call Analytics transcription.

vocabulary_filter_name instance-attribute

vocabulary_filter_name: NotRequired[VocabularyFilterName]

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_names instance-attribute

vocabulary_filter_names: NotRequired[VocabularyFilterNames]

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

vocabulary_name instance-attribute

vocabulary_name: NotRequired[VocabularyName]

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_names instance-attribute

vocabulary_names: NotRequired[VocabularyNames]

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