We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.
Protected
An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.
For more information, see Transcribing streaming audio.
Optional
ContentLabels 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.
Optional
ContentRedacts 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.
Optional
EnableEnables 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.
For more information, see Transcribing multi-channel audio.
Optional
EnableEnables 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.
Optional
IdentifyEnables automatic language identification for your transcription.
If you include IdentifyLanguage
, you can optionally include a list of
language codes, using LanguageOptions
, that you think may be present in
your audio stream. Including language options can improve transcription accuracy.
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
in your request. If you include both parameters, your request
fails.
Streaming language identification can't be combined with custom language models or redaction.
Optional
LanguageSpecify 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.
Optional
LanguageSpecify 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.
Optional
LanguageSpecify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.
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 Amazon Transcribe streaming, refer to the Supported languages table.
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.
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.
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.
Optional
NumberSpecify the number of channels in your audio stream. Up to two channels are supported.
Optional
PartialSpecify 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.
Optional
PiiSpecify 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
.
To include PiiEntityTypes
in your request, you must also include either
ContentIdentificationType
or ContentRedactionType
.
Values must be comma-separated and can include:
BANK_ACCOUNT_NUMBER
, BANK_ROUTING
,
CREDIT_DEBIT_NUMBER
, CREDIT_DEBIT_CVV
,
CREDIT_DEBIT_EXPIRY
, PIN
, EMAIL
,
ADDRESS
, NAME
, PHONE
,
SSN
, or ALL
.
Optional
PreferredSpecify 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.
Optional
SessionSpecify 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.
You can use a session ID to retry a streaming session.
Optional
ShowEnables 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).
Optional
VocabularySpecify 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
.
Optional
VocabularySpecify 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.
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.
Optional
VocabularySpecify 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.
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.
Optional
VocabularySpecify 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.
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.
Optional
VocabularySpecify 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.
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.
The input for StartStreamTranscriptionCommand.