start_stream_transcription¶
Operation¶
async
¶
start_stream_transcription(input: StartStreamTranscriptionInput, plugins: list[Plugin] | None = None) -> DuplexEventStream[AudioStream, TranscriptResultStream, StartStreamTranscriptionOutput]
Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.
The following parameters are required:
-
language-codeoridentify-languageoridentify-multiple-language -
media-encoding -
sample-rate
For more information on streaming with Amazon Transcribe, see Transcribing streaming audio.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
StartStreamTranscriptionInput
|
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, TranscriptResultStream, StartStreamTranscriptionOutput]
|
A |
Input¶
dataclass
¶
Dataclass for StartStreamTranscriptionInput 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_channel_identification: bool = False
Enables channel identification in multi-channel audio.
Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.
If you include EnableChannelIdentification in your request, you must
also include NumberOfChannels.
For more information, see Transcribing multi-channel audio.
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 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 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.
If you have multi-channel audio that contains different languages on each channel, and you've enabled channel identification, automatic language identification identifies the dominant language on each audio channel.
Note that you must include either LanguageCode or IdentifyLanguage
or IdentifyMultipleLanguages in your request. If you include more than
one of these parameters, your transcription job fails.
Streaming language identification can't be combined with custom language models or redaction.
class-attribute
instance-attribute
¶
identify_multiple_languages: bool = False
Enables automatic multi-language identification in your transcription job request. Use this parameter if your stream contains more than one language. If your stream contains only one language, use IdentifyLanguage instead.
If you include IdentifyMultipleLanguages, you must include a list of
language codes, using LanguageOptions, that you think may be present
in your stream.
If you want to apply a custom vocabulary or a custom vocabulary filter
to your automatic multiple language identification request, include
VocabularyNames or VocabularyFilterNames.
Note that you must include one of LanguageCode, IdentifyLanguage, or
IdentifyMultipleLanguages in your request. If you include more than
one of these parameters, your transcription job fails.
class-attribute
instance-attribute
¶
language_code: LanguageCode | None = None
Specify 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 supported with Amazon Transcribe streaming, 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 more than five is not recommended.
Including language options can improve the accuracy of language identification.
If you include LanguageOptions in your request, you must also include
IdentifyLanguage or IdentifyMultipleLanguages.
For a list of languages supported with Amazon Transcribe 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
¶
number_of_channels: int | None = None
Specify the number of channels in your audio stream. This value must be
2, as only two channels are supported. If your audio doesn't contain
multiple channels, do not include this parameter in your request.
If you include NumberOfChannels in your request, you must also include
EnableChannelIdentification.
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, AGE, DATE_TIME, LICENSE_PLATE, PASSPORT_NUMBER,
PASSWORD, USERNAME, VEHICLE_IDENTIFICATION_NUMBER, 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: LanguageCode | 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 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
¶
session_resume_window: int | None = None
Specify the time window, in minutes, during which your transcription session can be resumed, measured from the stream start time. This optional parameter accepts integer values from 1 to 300 (5 hours).
For example, if your stream starts at 1 PM and you specify a
SessionResumeWindow of 30 minutes, you can reconnect to the session as
many times as you want until 1:30 PM.
class-attribute
instance-attribute
¶
show_speaker_label: bool = False
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).
class-attribute
instance-attribute
¶
transcript_format: TranscriptFormat | None = None
Specify how numbers, dates, and other alphanumeric entities are rendered in your transcription results.
-
WRITTENrenders these entities in their standard written form (for example,$50,10:30 AM, and101). -
SPOKENrenders these entities as words, exactly as they were spoken (for example,fifty dollars,ten thirty a m, andone oh one).
If you don't specify a value, Amazon Transcribe uses WRITTEN by
default.
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.
Warning
This parameter is not intended for use with the IdentifyLanguage
parameter. If you're including IdentifyLanguage in your request and
want to use one or more vocabulary filters with your transcription, use
the VocabularyFilterNames parameter instead.
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 transcription. Note that vocabulary filter names are case sensitive.
If none of the languages of the specified custom vocabulary filters match the language identified in your media, your job fails.
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.
Warning
This parameter is not intended for use with the IdentifyLanguage
parameter. If you're including IdentifyLanguage in your request and
want to use one or more custom vocabularies with your transcription, use
the VocabularyNames parameter instead.
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 transcription. Note that vocabulary names are case sensitive.
If none of the languages of the specified custom vocabularies match the language identified in your media, your job fails.
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¶
Initial Response Structure¶
dataclass
¶
Dataclass for StartStreamTranscriptionOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
content_identification_type: ContentIdentificationType | None = None
Shows whether content identification was enabled for your transcription.
class-attribute
instance-attribute
¶
content_redaction_type: ContentRedactionType | None = None
Shows whether content redaction was enabled for your transcription.
class-attribute
instance-attribute
¶
enable_channel_identification: bool = False
Shows whether channel identification was enabled for your transcription.
class-attribute
instance-attribute
¶
enable_partial_results_stabilization: bool = False
Shows whether partial results stabilization was enabled for your transcription.
class-attribute
instance-attribute
¶
identify_language: bool = False
Shows whether automatic language identification was enabled for your transcription.
class-attribute
instance-attribute
¶
identify_multiple_languages: bool = False
Shows whether automatic multi-language identification was enabled for your transcription.
class-attribute
instance-attribute
¶
language_code: LanguageCode | None = None
Provides the language code that you specified in your request.
class-attribute
instance-attribute
¶
language_model_name: str | None = None
Provides the name of the custom language model that you specified in your request.
class-attribute
instance-attribute
¶
language_options: str | None = None
Provides the language codes that you specified in your request.
class-attribute
instance-attribute
¶
media_encoding: MediaEncoding | None = None
Provides the media encoding you specified in your request.
class-attribute
instance-attribute
¶
media_sample_rate_hertz: int | None = None
Provides the sample rate that you specified in your request.
class-attribute
instance-attribute
¶
number_of_channels: int | None = None
Provides the number of channels that you specified in your 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 request.
class-attribute
instance-attribute
¶
preferred_language: LanguageCode | None = None
Provides the preferred language that you specified in your request.
class-attribute
instance-attribute
¶
request_id: str | None = None
Provides the identifier for your streaming request.
class-attribute
instance-attribute
¶
session_id: str | None = None
Provides the identifier for your transcription session.
class-attribute
instance-attribute
¶
session_resume_window: int | None = None
Provides the session resume window, in minutes, that you specified in your request.
class-attribute
instance-attribute
¶
show_speaker_label: bool = False
Shows whether speaker partitioning was enabled for your transcription.
class-attribute
instance-attribute
¶
transcript_format: TranscriptFormat | None = None
Provides the transcript format that you specified in your request.
class-attribute
instance-attribute
¶
vocabulary_filter_method: VocabularyFilterMethod | None = None
Provides the vocabulary filtering method used in your transcription.
class-attribute
instance-attribute
¶
vocabulary_filter_name: str | None = None
Provides the name of the custom vocabulary filter that you specified in your request.
class-attribute
instance-attribute
¶
vocabulary_filter_names: str | None = None
Provides the names of the custom vocabulary filters that you specified in your request.
class-attribute
instance-attribute
¶
vocabulary_name: str | None = None
Provides the name of the custom vocabulary that you specified in your request.
class-attribute
instance-attribute
¶
vocabulary_names: str | None = None
Provides the names of the custom vocabularies that you specified in your request.