start_call_analytics_stream_transcription¶
Operation¶
async
¶
start_call_analytics_stream_transcription(input: StartCallAnalyticsStreamTranscriptionInput, plugins: list[Plugin] | None = None) -> DuplexEventStream[AudioStream, CallAnalyticsTranscriptResultStream, StartCallAnalyticsStreamTranscriptionOutput]
Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application. Use this operation for Call Analytics transcriptions.
The following parameters are required:
-
language-codeoridentify-language -
media-encoding -
sample-rate
For more information on streaming with Amazon Transcribe, see Transcribing streaming audio.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
StartCallAnalyticsStreamTranscriptionInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DuplexEventStream[AudioStream, CallAnalyticsTranscriptResultStream, StartCallAnalyticsStreamTranscriptionOutput]
|
A |
Input¶
dataclass
¶
Dataclass for StartCallAnalyticsStreamTranscriptionInput structure.
Attributes¶
class-attribute
instance-attribute
¶
content_identification_type: ContentIdentificationType | None = None
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. If you don't include PiiEntityTypes in your request, all PII
is identified.
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.
class-attribute
instance-attribute
¶
content_redaction_type: ContentRedactionType | None = None
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. If you don't include PiiEntityTypes in your request, all PII
is redacted.
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.
class-attribute
instance-attribute
¶
enable_partial_results_stabilization: bool = False
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.
class-attribute
instance-attribute
¶
identify_language: bool = False
Enables automatic language identification for your Call Analytics transcription.
If you include IdentifyLanguage, you must include a list of language
codes, using LanguageOptions, that you think may be present in your
audio stream. You must provide a minimum of two language selections.
You can also include a preferred language using PreferredLanguage.
Adding a preferred language can help Amazon Transcribe identify the
language faster than if you omit this parameter.
Note that you must include either LanguageCode or IdentifyLanguage
in your request. If you include both parameters, your transcription job
fails.
class-attribute
instance-attribute
¶
language_code: CallAnalyticsLanguageCode | None = None
Specify the language code that represents the language spoken in your audio.
For a list of languages supported with real-time Call Analytics, refer to the Supported languages table.
class-attribute
instance-attribute
¶
language_model_name: str | None = None
Specify 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.
class-attribute
instance-attribute
¶
language_options: str | None = None
Specify two or more language codes that represent the languages you think may be present in your media.
Including language options can improve the accuracy of language identification.
If you include LanguageOptions in your request, you must also include
IdentifyLanguage.
For a list of languages supported with Call Analytics streaming, refer to the Supported languages table.
Warning
You can only include one language dialect per language per stream. For
example, you cannot include en-US and en-AU in the same request.
class-attribute
instance-attribute
¶
media_encoding: MediaEncoding | None = None
Specify the encoding of your input audio. Supported formats are:
-
FLAC
-
OPUS-encoded audio in an Ogg container
-
PCM (only signed 16-bit little-endian audio formats, which does not include WAV)
For more information, see Media formats.
class-attribute
instance-attribute
¶
media_sample_rate_hertz: int | None = None
The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio, is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.
class-attribute
instance-attribute
¶
partial_results_stability: PartialResultsStability | None = None
Specify 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.
class-attribute
instance-attribute
¶
pii_entity_types: str | None = None
Specify which types of personally identifiable information (PII) you
want to redact in your transcript. You can include as many types as
you'd like, or you can select ALL.
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.
Note that if you include PiiEntityTypes in your request, you must also
include ContentIdentificationType or ContentRedactionType.
If you include ContentRedactionType or ContentIdentificationType in
your request, but do not include PiiEntityTypes, all PII is redacted
or identified.
class-attribute
instance-attribute
¶
preferred_language: CallAnalyticsLanguageCode | None = None
Specify a preferred language from the subset of languages codes you
specified in LanguageOptions.
You can only use this parameter if you've included IdentifyLanguage
and LanguageOptions in your request.
class-attribute
instance-attribute
¶
session_id: str | None = None
Specify a name for your Call Analytics transcription session. If you don't include this parameter in your request, Amazon Transcribe generates an ID and returns it in the response.
class-attribute
instance-attribute
¶
vocabulary_filter_method: VocabularyFilterMethod | None = None
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.
class-attribute
instance-attribute
¶
vocabulary_filter_name: str | None = None
Specify the name of the custom vocabulary filter that you want to use when processing your 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.
class-attribute
instance-attribute
¶
vocabulary_filter_names: str | None = None
Specify the names of the custom vocabulary filters that you want to use when processing your Call Analytics transcription. Note that vocabulary filter names are case sensitive.
These filters serve to customize the transcript output.
Warning
This parameter is only intended for use with the IdentifyLanguage
parameter. If you're not including IdentifyLanguage in your
request and want to use a custom vocabulary filter with your
transcription, use the VocabularyFilterName parameter instead.
For more information, see Using vocabulary filtering with unwanted words.
class-attribute
instance-attribute
¶
vocabulary_name: str | None = None
Specify the name of the custom vocabulary that you want to use when processing your 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.
class-attribute
instance-attribute
¶
vocabulary_names: str | None = None
Specify the names of the custom vocabularies that you want to use when processing your Call Analytics transcription. Note that vocabulary names are case sensitive.
If the custom vocabulary's language doesn't match the identified media language, it won't be applied to the transcription.
Warning
This parameter is only intended for use with the IdentifyLanguage
parameter. If you're not including IdentifyLanguage in your
request and want to use a custom vocabulary with your transcription, use
the VocabularyName parameter instead.
For more information, see Custom vocabularies.
Output¶
This operation returns a DuplexEventStream for bidirectional streaming.
Event Stream Structure¶
Input Event Type¶
Output Event Type¶
CallAnalyticsTranscriptResultStream
Initial Response Structure¶
dataclass
¶
Dataclass for StartCallAnalyticsStreamTranscriptionOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
content_identification_type: ContentIdentificationType | None = None
Shows whether content identification was enabled for your Call Analytics transcription.
class-attribute
instance-attribute
¶
content_redaction_type: ContentRedactionType | None = None
Shows whether content redaction was enabled for your Call Analytics transcription.
class-attribute
instance-attribute
¶
enable_partial_results_stabilization: bool = False
Shows whether partial results stabilization was enabled for your Call Analytics transcription.
class-attribute
instance-attribute
¶
identify_language: bool = False
Shows whether automatic language identification was enabled for your Call Analytics transcription.
class-attribute
instance-attribute
¶
language_code: CallAnalyticsLanguageCode | None = None
Provides the language code that you specified in your Call Analytics request.
class-attribute
instance-attribute
¶
language_model_name: str | None = None
Provides the name of the custom language model that you specified in your Call Analytics request.
class-attribute
instance-attribute
¶
language_options: str | None = None
Provides the language codes that you specified in your Call Analytics request.
class-attribute
instance-attribute
¶
media_encoding: MediaEncoding | None = None
Provides the media encoding you specified in your Call Analytics request.
class-attribute
instance-attribute
¶
media_sample_rate_hertz: int | None = None
Provides the sample rate that you specified in your Call Analytics request.
class-attribute
instance-attribute
¶
partial_results_stability: PartialResultsStability | None = None
Provides the stabilization level used for your transcription.
class-attribute
instance-attribute
¶
pii_entity_types: str | None = None
Lists the PII entity types you specified in your Call Analytics request.
class-attribute
instance-attribute
¶
preferred_language: CallAnalyticsLanguageCode | None = None
Provides the preferred language that you specified in your Call Analytics request.
class-attribute
instance-attribute
¶
request_id: str | None = None
Provides the identifier for your real-time Call Analytics request.
class-attribute
instance-attribute
¶
session_id: str | None = None
Provides the identifier for your Call Analytics transcription session.
class-attribute
instance-attribute
¶
vocabulary_filter_method: VocabularyFilterMethod | None = None
Provides the vocabulary filtering method used in your Call Analytics transcription.
class-attribute
instance-attribute
¶
vocabulary_filter_name: str | None = None
Provides the name of the custom vocabulary filter that you specified in your Call Analytics request.
class-attribute
instance-attribute
¶
vocabulary_filter_names: str | None = None
Provides the names of the custom vocabulary filters that you specified in your Call Analytics request.
class-attribute
instance-attribute
¶
vocabulary_name: str | None = None
Provides the name of the custom vocabulary that you specified in your Call Analytics request.
class-attribute
instance-attribute
¶
vocabulary_names: str | None = None
Provides the names of the custom vocabularies that you specified in your Call Analytics request.