Class TranscribeAudioRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<TranscribeAudioRequest.Builder,TranscribeAudioRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final BooleanEnables channel identification in multi-channel audio.final ContentRedactionRedacts personally identifiable information (PII) from your transcript.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the LanguageOptions property.final booleanFor responses, this returns true if the service returned a value for the VocabularySettings property.final SyncLanguagelanguage()The language spoken in your audio, as a base language code (for example,enores).final StringThe language spoken in your audio, as a base language code (for example,enores).final LanguageDetectionModeEnables automatic language identification.final StringEnables automatic language identification.final List<SyncLanguage> A list of two or more languages that you think may be present in your audio, as base language codes (for example,enandes).A list of two or more languages that you think may be present in your audio, as base language codes (for example,enandes).final IntegerSpecify the maximum number of speakers you want to partition in your media.final SyncMediamedia()The audio to transcribe.final SyncOutputConfigurationWrites the transcript to an Amazon S3 location instead of returning it in the response.static Class<? extends TranscribeAudioRequest.Builder> final BooleanEnables speaker partitioning (diarization) in your transcript.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final VocabularyFilterSettingsCustom vocabulary filters to apply to your transcript, and how to apply them.final List<VocabularySettingsEntry> Custom vocabularies to apply to your transcript, with one entry per language.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
media
The audio to transcribe. Specify exactly one of
MediaBytesorMediaFileUri.Audio sent in the request (
MediaBytes) can be up to 25 MB. Audio in Amazon S3 (MediaFileUri) can be up to 500 MB.- Returns:
- The audio to transcribe. Specify exactly one of
MediaBytesorMediaFileUri.Audio sent in the request (
MediaBytes) can be up to 25 MB. Audio in Amazon S3 (MediaFileUri) can be up to 500 MB.
-
language
The language spoken in your audio, as a base language code (for example,
enores).Include either
LanguageorLanguageDetectionModein your request, but not both.If the service returns an enum value that is not available in the current SDK version,
languagewill returnSyncLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlanguageAsString().- Returns:
- The language spoken in your audio, as a base language code (for example,
enores).Include either
LanguageorLanguageDetectionModein your request, but not both. - See Also:
-
languageAsString
The language spoken in your audio, as a base language code (for example,
enores).Include either
LanguageorLanguageDetectionModein your request, but not both.If the service returns an enum value that is not available in the current SDK version,
languagewill returnSyncLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlanguageAsString().- Returns:
- The language spoken in your audio, as a base language code (for example,
enores).Include either
LanguageorLanguageDetectionModein your request, but not both. - See Also:
-
languageDetectionMode
Enables automatic language identification. Use
IDENTIFY_LANGUAGEif your audio contains a single language that you don't know in advance.You can optionally include
LanguageOptionsto limit identification to languages you think may be present, which can improve accuracy.Amazon Transcribe returns the identified language, as a locale (for example,
en-US), in the response metadata.Include either
LanguageorLanguageDetectionModein your request, but not both.If the service returns an enum value that is not available in the current SDK version,
languageDetectionModewill returnLanguageDetectionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlanguageDetectionModeAsString().- Returns:
- Enables automatic language identification. Use
IDENTIFY_LANGUAGEif your audio contains a single language that you don't know in advance.You can optionally include
LanguageOptionsto limit identification to languages you think may be present, which can improve accuracy.Amazon Transcribe returns the identified language, as a locale (for example,
en-US), in the response metadata.Include either
LanguageorLanguageDetectionModein your request, but not both. - See Also:
-
languageDetectionModeAsString
Enables automatic language identification. Use
IDENTIFY_LANGUAGEif your audio contains a single language that you don't know in advance.You can optionally include
LanguageOptionsto limit identification to languages you think may be present, which can improve accuracy.Amazon Transcribe returns the identified language, as a locale (for example,
en-US), in the response metadata.Include either
LanguageorLanguageDetectionModein your request, but not both.If the service returns an enum value that is not available in the current SDK version,
languageDetectionModewill returnLanguageDetectionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlanguageDetectionModeAsString().- Returns:
- Enables automatic language identification. Use
IDENTIFY_LANGUAGEif your audio contains a single language that you don't know in advance.You can optionally include
LanguageOptionsto limit identification to languages you think may be present, which can improve accuracy.Amazon Transcribe returns the identified language, as a locale (for example,
en-US), in the response metadata.Include either
LanguageorLanguageDetectionModein your request, but not both. - See Also:
-
languageOptions
A list of two or more languages that you think may be present in your audio, as base language codes (for example,
enandes). Each language can appear only once. A list with only one language returns aBadRequestException.You can use
LanguageOptionsonly withLanguageDetectionMode.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasLanguageOptions()method.- Returns:
- A list of two or more languages that you think may be present in your audio, as base language codes (for
example,
enandes). Each language can appear only once. A list with only one language returns aBadRequestException.You can use
LanguageOptionsonly withLanguageDetectionMode.
-
hasLanguageOptions
public final boolean hasLanguageOptions()For responses, this returns true if the service returned a value for the LanguageOptions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
languageOptionsAsStrings
A list of two or more languages that you think may be present in your audio, as base language codes (for example,
enandes). Each language can appear only once. A list with only one language returns aBadRequestException.You can use
LanguageOptionsonly withLanguageDetectionMode.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasLanguageOptions()method.- Returns:
- A list of two or more languages that you think may be present in your audio, as base language codes (for
example,
enandes). Each language can appear only once. A list with only one language returns aBadRequestException.You can use
LanguageOptionsonly withLanguageDetectionMode.
-
channelIdentification
Enables channel identification in multi-channel audio. Each channel is transcribed independently, and each item in the transcript is labeled with its channel.
Channel identification supports up to two channels.
- Returns:
- Enables channel identification in multi-channel audio. Each channel is transcribed independently, and
each item in the transcript is labeled with its channel.
Channel identification supports up to two channels.
-
showSpeakerLabels
Enables speaker partitioning (diarization) in your transcript. Speaker partitioning labels the speech from individual speakers in your media file.
If you set
ShowSpeakerLabelstotrue, you must also includeMaxSpeakerLabels.For more information, see Partitioning speakers (diarization).
- Returns:
- Enables speaker partitioning (diarization) in your transcript. Speaker partitioning labels the speech
from individual speakers in your media file.
If you set
ShowSpeakerLabelstotrue, you must also includeMaxSpeakerLabels.For more information, see Partitioning speakers (diarization).
-
maxSpeakerLabels
Specify the maximum number of speakers you want to partition in your media.
Note that if your media contains more speakers than the specified number, Amazon Transcribe treats multiple speakers as a single speaker.
You can set
MaxSpeakerLabelsonly ifShowSpeakerLabelsistrue.- Returns:
- Specify the maximum number of speakers you want to partition in your media.
Note that if your media contains more speakers than the specified number, Amazon Transcribe treats multiple speakers as a single speaker.
You can set
MaxSpeakerLabelsonly ifShowSpeakerLabelsistrue.
-
hasVocabularySettings
public final boolean hasVocabularySettings()For responses, this returns true if the service returned a value for the VocabularySettings property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
vocabularySettings
Custom vocabularies to apply to your transcript, with one entry per language. In each entry, you can reference a custom vocabulary you created or provide phrases inline. All entries must use the same type, either all by name or all inline.
If you specify
Language, include exactly one entry, and itsLanguagemust match. If you useLanguageDetectionMode, you can include one entry for each language inLanguageOptions.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasVocabularySettings()method.- Returns:
- Custom vocabularies to apply to your transcript, with one entry per language. In each entry, you can
reference a custom vocabulary you created or provide phrases inline. All entries must use the same type,
either all by name or all inline.
If you specify
Language, include exactly one entry, and itsLanguagemust match. If you useLanguageDetectionMode, you can include one entry for each language inLanguageOptions.
-
vocabularyFilterSettings
Custom vocabulary filters to apply to your transcript, and how to apply them.
- Returns:
- Custom vocabulary filters to apply to your transcript, and how to apply them.
-
contentRedaction
Redacts personally identifiable information (PII) from your transcript. Amazon Transcribe returns the redacted transcript in
RedactedResults.If you set
RedactionOutputtoredacted_and_unredacted, Amazon Transcribe also returns the unredacted transcript inResults.In Sync, content redaction has these limits:
-
Languages: English (
en), Spanish (es), French (fr), Italian (it), German (de), and Portuguese (pt). -
Language identification: If you use
LanguageDetectionMode, you must also includeLanguageOptions, and every language in it must be one of the languages above. A request that has noLanguageOptions, or that lists a language that isn't supported, returns aBadRequestException. -
Regions: Content redaction isn't available in the South America (São Paulo) Region (
sa-east-1). It's available in the other Amazon Web Services Regions where Sync is available.
- Returns:
- Redacts personally identifiable information (PII) from your transcript. Amazon Transcribe returns the
redacted transcript in
RedactedResults.If you set
RedactionOutputtoredacted_and_unredacted, Amazon Transcribe also returns the unredacted transcript inResults.In Sync, content redaction has these limits:
-
Languages: English (
en), Spanish (es), French (fr), Italian (it), German (de), and Portuguese (pt). -
Language identification: If you use
LanguageDetectionMode, you must also includeLanguageOptions, and every language in it must be one of the languages above. A request that has noLanguageOptions, or that lists a language that isn't supported, returns aBadRequestException. -
Regions: Content redaction isn't available in the South America (São Paulo) Region (
sa-east-1). It's available in the other Amazon Web Services Regions where Sync is available.
-
-
-
outputConfiguration
Writes the transcript to an Amazon S3 location instead of returning it in the response. If you include
OutputConfiguration, the response contains only the output location.You must have write permission for the location you specify.
- Returns:
- Writes the transcript to an Amazon S3 location instead of returning it in the response. If you include
OutputConfiguration, the response contains only the output location.You must have write permission for the location you specify.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<TranscribeAudioRequest.Builder,TranscribeAudioRequest> - Specified by:
toBuilderin classTranscribeRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- Parameters:
fieldName- The name of the member to be retrieved.clazz- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-