software.amazon.awssdk.services.transcribestreaming.model

Class StartStreamTranscriptionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.transcribestreaming.model.TranscribeStreamingRequest

software.amazon.awssdk.services.transcribestreaming.model.StartStreamTranscriptionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartStreamTranscriptionRequest.Builder,StartStreamTranscriptionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartStreamTranscriptionRequest
extends TranscribeStreamingRequest
implements ToCopyableBuilder<StartStreamTranscriptionRequest.Builder,StartStreamTranscriptionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartStreamTranscriptionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartStreamTranscriptionRequest.Builder	builder()
ContentIdentificationType	contentIdentificationType() Set this field to PII to identify personally identifiable information (PII) in the transcription output.
String	contentIdentificationTypeAsString() Set this field to PII to identify personally identifiable information (PII) in the transcription output.
ContentRedactionType	contentRedactionType() Set this field to PII to redact personally identifiable information (PII) in the transcription output.
String	contentRedactionTypeAsString() Set this field to PII to redact personally identifiable information (PII) in the transcription output.
Boolean	enableChannelIdentification() When true, instructs Amazon Transcribe to process each audio channel separately, then merges the transcription output of each channel into a single transcription.
Boolean	enablePartialResultsStabilization() When true, instructs Amazon Transcribe to present transcription results that have the partial results stabilized.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	identifyLanguage() Optional.
LanguageCode	languageCode() The language code of the input audio stream.
String	languageCodeAsString() The language code of the input audio stream.
String	languageModelName() The name of the language model you want to use.
String	languageOptions() An object containing a list of languages that might be present in your audio.
MediaEncoding	mediaEncoding() The encoding used for the input audio.
String	mediaEncodingAsString() The encoding used for the input audio.
Integer	mediaSampleRateHertz() The sample rate of the input audio (in Hertz).
Integer	numberOfChannels() The number of channels that are in your audio stream.
PartialResultsStability	partialResultsStability() You can use this field to set the stability level of the transcription results.
String	partialResultsStabilityAsString() You can use this field to set the stability level of the transcription results.
String	piiEntityTypes() List the PII entity types you want to identify or redact.
LanguageCode	preferredLanguage() Optional.
String	preferredLanguageAsString() Optional.
List<SdkField<?>>	sdkFields()
static Class<? extends StartStreamTranscriptionRequest.Builder>	serializableBuilderClass()
String	sessionId() A identifier for the transcription session.
Boolean	showSpeakerLabel() When true, enables speaker identification in your media stream.
StartStreamTranscriptionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
VocabularyFilterMethod	vocabularyFilterMethod() The manner in which you use your vocabulary filter to filter words in your transcript.
String	vocabularyFilterMethodAsString() The manner in which you use your vocabulary filter to filter words in your transcript.
String	vocabularyFilterName() The name of the vocabulary filter you want to use with your transcription.
String	vocabularyFilterNames() The names of the vocabulary filters you want to use with your transcription.
String	vocabularyName() The name of the custom vocabulary you want to use with your transcription.
String	vocabularyNames() The names of the custom vocabularies you want to use with your transcription.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

languageCode

public final LanguageCode languageCode()

The language code of the input audio stream.

If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language code of the input audio stream.

See Also:

LanguageCode

languageCodeAsString

public final String languageCodeAsString()

The language code of the input audio stream.

If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language code of the input audio stream.

See Also:

LanguageCode

mediaSampleRateHertz

public final Integer mediaSampleRateHertz()

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.

Returns:

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.

mediaEncoding

public final MediaEncoding mediaEncoding()

The encoding used for the input audio.

If the service returns an enum value that is not available in the current SDK version, mediaEncoding will return MediaEncoding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaEncodingAsString().

Returns:

The encoding used for the input audio.

See Also:

MediaEncoding

mediaEncodingAsString

public final String mediaEncodingAsString()

The encoding used for the input audio.

If the service returns an enum value that is not available in the current SDK version, mediaEncoding will return MediaEncoding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaEncodingAsString().

Returns:

The encoding used for the input audio.

See Also:

MediaEncoding

vocabularyName

public final String vocabularyName()

The name of the custom vocabulary you want to use with your transcription.

This operation is not intended for use in conjunction with the IdentifyLanguage operation. If you're using IdentifyLanguage in your request and want to use one or more custom vocabularies with your transcription, use the VocabularyNames operation instead.

Returns:

The name of the custom vocabulary you want to use with your transcription.

This operation is not intended for use in conjunction with the IdentifyLanguage operation. If you're using IdentifyLanguage in your request and want to use one or more custom vocabularies with your transcription, use the VocabularyNames operation instead.

sessionId

public final String sessionId()

A identifier for the transcription session. Use this parameter when you want to retry a session. If you don't provide a session ID, Amazon Transcribe will generate one for you and return it in the response.

Returns:

A identifier for the transcription session. Use this parameter when you want to retry a session. If you don't provide a session ID, Amazon Transcribe will generate one for you and return it in the response.

vocabularyFilterName

public final String vocabularyFilterName()

The name of the vocabulary filter you want to use with your transcription.

This operation is not intended for use in conjunction with the IdentifyLanguage operation. If you're using IdentifyLanguage in your request and want to use one or more vocabulary filters with your transcription, use the VocabularyFilterNames operation instead.

Returns:

The name of the vocabulary filter you want to use with your transcription.

This operation is not intended for use in conjunction with the IdentifyLanguage operation. If you're using IdentifyLanguage in your request and want to use one or more vocabulary filters with your transcription, use the VocabularyFilterNames operation instead.

vocabularyFilterMethod

public final VocabularyFilterMethod vocabularyFilterMethod()

The manner in which you use your vocabulary filter to filter words in your transcript. Remove removes filtered words from your transcription results. Mask masks filtered words with a *** in your transcription results. Tag keeps the filtered words in your transcription results and tags them. The tag appears as VocabularyFilterMatch equal to True.

If the service returns an enum value that is not available in the current SDK version, vocabularyFilterMethod will return VocabularyFilterMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vocabularyFilterMethodAsString().

Returns:

The manner in which you use your vocabulary filter to filter words in your transcript. Remove removes filtered words from your transcription results. Mask masks filtered words with a *** in your transcription results. Tag keeps the filtered words in your transcription results and tags them. The tag appears as VocabularyFilterMatch equal to True.

See Also:

VocabularyFilterMethod

vocabularyFilterMethodAsString

public final String vocabularyFilterMethodAsString()

The manner in which you use your vocabulary filter to filter words in your transcript. Remove removes filtered words from your transcription results. Mask masks filtered words with a *** in your transcription results. Tag keeps the filtered words in your transcription results and tags them. The tag appears as VocabularyFilterMatch equal to True.

If the service returns an enum value that is not available in the current SDK version, vocabularyFilterMethod will return VocabularyFilterMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vocabularyFilterMethodAsString().

Returns:

The manner in which you use your vocabulary filter to filter words in your transcript. Remove removes filtered words from your transcription results. Mask masks filtered words with a *** in your transcription results. Tag keeps the filtered words in your transcription results and tags them. The tag appears as VocabularyFilterMatch equal to True.

See Also:

VocabularyFilterMethod

showSpeakerLabel

public final Boolean showSpeakerLabel()

When true, enables speaker identification in your media stream.

Returns:

When true, enables speaker identification in your media stream.

enableChannelIdentification

public final Boolean enableChannelIdentification()

When true, instructs Amazon Transcribe to process each audio channel separately, then merges the transcription output of each channel into a single transcription.

Amazon Transcribe also produces a transcription of each item. An item includes the start time, end time, and any alternative transcriptions.

Returns:

When true, instructs Amazon Transcribe to process each audio channel separately, then merges the transcription output of each channel into a single transcription.

Amazon Transcribe also produces a transcription of each item. An item includes the start time, end time, and any alternative transcriptions.

numberOfChannels

public final Integer numberOfChannels()

The number of channels that are in your audio stream.

Returns:

The number of channels that are in your audio stream.

enablePartialResultsStabilization

public final Boolean enablePartialResultsStabilization()

When true, instructs Amazon Transcribe to present transcription results that have the partial results stabilized. Normally, any word or phrase from one partial result can change in a subsequent partial result. With partial results stabilization enabled, only the last few words of one partial result can change in another partial result.

Returns:

When true, instructs Amazon Transcribe to present transcription results that have the partial results stabilized. Normally, any word or phrase from one partial result can change in a subsequent partial result. With partial results stabilization enabled, only the last few words of one partial result can change in another partial result.

partialResultsStability

public final PartialResultsStability partialResultsStability()

You can use this field to set the stability level of the transcription results. A higher stability level means that the transcription results are less likely to change. Higher stability levels can come with lower overall transcription accuracy.

If the service returns an enum value that is not available in the current SDK version, partialResultsStability will return PartialResultsStability.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from partialResultsStabilityAsString().

Returns:

You can use this field to set the stability level of the transcription results. A higher stability level means that the transcription results are less likely to change. Higher stability levels can come with lower overall transcription accuracy.

See Also:

PartialResultsStability

partialResultsStabilityAsString

public final String partialResultsStabilityAsString()

You can use this field to set the stability level of the transcription results. A higher stability level means that the transcription results are less likely to change. Higher stability levels can come with lower overall transcription accuracy.

If the service returns an enum value that is not available in the current SDK version, partialResultsStability will return PartialResultsStability.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from partialResultsStabilityAsString().

Returns:

You can use this field to set the stability level of the transcription results. A higher stability level means that the transcription results are less likely to change. Higher stability levels can come with lower overall transcription accuracy.

See Also:

PartialResultsStability

contentIdentificationType

public final ContentIdentificationType contentIdentificationType()

Set this field to PII to identify personally identifiable information (PII) in the transcription output. Content identification is performed only upon complete transcription of the audio segments.

You can’t set both ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException.

If the service returns an enum value that is not available in the current SDK version, contentIdentificationType will return ContentIdentificationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentIdentificationTypeAsString().

Returns:

Set this field to PII to identify personally identifiable information (PII) in the transcription output. Content identification is performed only upon complete transcription of the audio segments.

You can’t set both ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException.

See Also:

ContentIdentificationType

contentIdentificationTypeAsString

public final String contentIdentificationTypeAsString()

Set this field to PII to identify personally identifiable information (PII) in the transcription output. Content identification is performed only upon complete transcription of the audio segments.

You can’t set both ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException.

If the service returns an enum value that is not available in the current SDK version, contentIdentificationType will return ContentIdentificationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentIdentificationTypeAsString().

Returns:

Set this field to PII to identify personally identifiable information (PII) in the transcription output. Content identification is performed only upon complete transcription of the audio segments.

You can’t set both ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException.

See Also:

ContentIdentificationType

contentRedactionType

public final ContentRedactionType contentRedactionType()

Set this field to PII to redact personally identifiable information (PII) in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.

You can’t set both ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.

If the service returns an enum value that is not available in the current SDK version, contentRedactionType will return ContentRedactionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentRedactionTypeAsString().

Returns:

Set this field to PII to redact personally identifiable information (PII) in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.

You can’t set both ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.

See Also:

ContentRedactionType

contentRedactionTypeAsString

public final String contentRedactionTypeAsString()

Set this field to PII to redact personally identifiable information (PII) in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.

You can’t set both ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.

If the service returns an enum value that is not available in the current SDK version, contentRedactionType will return ContentRedactionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentRedactionTypeAsString().

Returns:

Set this field to PII to redact personally identifiable information (PII) in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.

You can’t set both ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.

See Also:

ContentRedactionType

piiEntityTypes

public final String piiEntityTypes()

List the PII entity types you want to identify or redact. In order to specify entity types, you must have either ContentIdentificationType or ContentRedactionType enabled.

PIIEntityTypes must be comma-separated; the available values are: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL.

PiiEntityTypes is an optional parameter with a default value of ALL.

Returns:

List the PII entity types you want to identify or redact. In order to specify entity types, you must have either ContentIdentificationType or ContentRedactionType enabled.

PIIEntityTypes must be comma-separated; the available values are: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL.

PiiEntityTypes is an optional parameter with a default value of ALL.

languageModelName

public final String languageModelName()

The name of the language model you want to use.

Returns:

The name of the language model you want to use.

identifyLanguage

public final Boolean identifyLanguage()

Optional. Set this value to true to enable language identification for your media stream.

Returns:

Optional. Set this value to true to enable language identification for your media stream.

languageOptions

public final String languageOptions()

An object containing a list of languages that might be present in your audio.

You must provide two or more language codes to help Amazon Transcribe identify the correct language of your media stream with the highest possible accuracy. You can only select one variant per language; for example, you can't include both en-US and en-UK in the same request.

You can only use this parameter if you've set IdentifyLanguage to truein your request.

Returns:

An object containing a list of languages that might be present in your audio.

You must provide two or more language codes to help Amazon Transcribe identify the correct language of your media stream with the highest possible accuracy. You can only select one variant per language; for example, you can't include both en-US and en-UK in the same request.

You can only use this parameter if you've set IdentifyLanguage to truein your request.

preferredLanguage

public final LanguageCode preferredLanguage()

Optional. From the subset of languages codes you provided for LanguageOptions, you can select one preferred language for your transcription.

You can only use this parameter if you've set IdentifyLanguage to truein your request.

If the service returns an enum value that is not available in the current SDK version, preferredLanguage will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from preferredLanguageAsString().

Returns:

Optional. From the subset of languages codes you provided for LanguageOptions, you can select one preferred language for your transcription.

You can only use this parameter if you've set IdentifyLanguage to truein your request.

See Also:

LanguageCode

preferredLanguageAsString

public final String preferredLanguageAsString()

Optional. From the subset of languages codes you provided for LanguageOptions, you can select one preferred language for your transcription.

You can only use this parameter if you've set IdentifyLanguage to truein your request.

If the service returns an enum value that is not available in the current SDK version, preferredLanguage will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from preferredLanguageAsString().

Returns:

Optional. From the subset of languages codes you provided for LanguageOptions, you can select one preferred language for your transcription.

You can only use this parameter if you've set IdentifyLanguage to truein your request.

See Also:

LanguageCode

vocabularyNames

public final String vocabularyNames()

The names of the custom vocabularies you want to use with your transcription.

Note that if the custom vocabularies you specify are in languages that don't match the language identified in your media, your job fails.

This operation is only intended for use in conjunction with the IdentifyLanguage operation. If you're not using IdentifyLanguage in your request and want to use a custom vocabulary with your transcription, use the VocabularyName operation instead.

Returns:

The names of the custom vocabularies you want to use with your transcription.

Note that if the custom vocabularies you specify are in languages that don't match the language identified in your media, your job fails.

This operation is only intended for use in conjunction with the IdentifyLanguage operation. If you're not using IdentifyLanguage in your request and want to use a custom vocabulary with your transcription, use the VocabularyName operation instead.

vocabularyFilterNames

public final String vocabularyFilterNames()

The names of the vocabulary filters you want to use with your transcription.

Note that if the vocabulary filters you specify are in languages that don't match the language identified in your media, your job fails.

This operation is only intended for use in conjunction with the IdentifyLanguage operation. If you're not using IdentifyLanguage in your request and want to use a vocabulary filter with your transcription, use the VocabularyFilterName operation instead.

Returns:

The names of the vocabulary filters you want to use with your transcription.

Note that if the vocabulary filters you specify are in languages that don't match the language identified in your media, your job fails.

This operation is only intended for use in conjunction with the IdentifyLanguage operation. If you're not using IdentifyLanguage in your request and want to use a vocabulary filter with your transcription, use the VocabularyFilterName operation instead.

toBuilder

public StartStreamTranscriptionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartStreamTranscriptionRequest.Builder,StartStreamTranscriptionRequest>

Specified by:

toBuilder in class TranscribeStreamingRequest

builder

public static StartStreamTranscriptionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartStreamTranscriptionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo