Interface TranscribeAudioRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<TranscribeAudioRequest.Builder,,TranscribeAudioRequest> SdkBuilder<TranscribeAudioRequest.Builder,,TranscribeAudioRequest> SdkPojo,SdkRequest.Builder,TranscribeRequest.Builder
- Enclosing class:
TranscribeAudioRequest
-
Method Summary
Modifier and TypeMethodDescriptionchannelIdentification(Boolean channelIdentification) Enables channel identification in multi-channel audio.default TranscribeAudioRequest.BuildercontentRedaction(Consumer<ContentRedaction.Builder> contentRedaction) Redacts personally identifiable information (PII) from your transcript.contentRedaction(ContentRedaction contentRedaction) Redacts personally identifiable information (PII) from your transcript.The language spoken in your audio, as a base language code (for example,enores).language(SyncLanguage language) The language spoken in your audio, as a base language code (for example,enores).languageDetectionMode(String languageDetectionMode) Enables automatic language identification.languageDetectionMode(LanguageDetectionMode languageDetectionMode) Enables automatic language identification.languageOptions(Collection<SyncLanguage> languageOptions) A list of two or more languages that you think may be present in your audio, as base language codes (for example,enandes).languageOptions(SyncLanguage... languageOptions) A list of two or more languages that you think may be present in your audio, as base language codes (for example,enandes).languageOptionsWithStrings(String... languageOptions) A list of two or more languages that you think may be present in your audio, as base language codes (for example,enandes).languageOptionsWithStrings(Collection<String> languageOptions) A list of two or more languages that you think may be present in your audio, as base language codes (for example,enandes).maxSpeakerLabels(Integer maxSpeakerLabels) Specify the maximum number of speakers you want to partition in your media.default TranscribeAudioRequest.Buildermedia(Consumer<SyncMedia.Builder> media) The audio to transcribe.The audio to transcribe.default TranscribeAudioRequest.BuilderoutputConfiguration(Consumer<SyncOutputConfiguration.Builder> outputConfiguration) Writes the transcript to an Amazon S3 location instead of returning it in the response.outputConfiguration(SyncOutputConfiguration outputConfiguration) Writes the transcript to an Amazon S3 location instead of returning it in the response.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.showSpeakerLabels(Boolean showSpeakerLabels) Enables speaker partitioning (diarization) in your transcript.default TranscribeAudioRequest.BuildervocabularyFilterSettings(Consumer<VocabularyFilterSettings.Builder> vocabularyFilterSettings) Custom vocabulary filters to apply to your transcript, and how to apply them.vocabularyFilterSettings(VocabularyFilterSettings vocabularyFilterSettings) Custom vocabulary filters to apply to your transcript, and how to apply them.vocabularySettings(Collection<VocabularySettingsEntry> vocabularySettings) Custom vocabularies to apply to your transcript, with one entry per language.vocabularySettings(Consumer<VocabularySettingsEntry.Builder>... vocabularySettings) Custom vocabularies to apply to your transcript, with one entry per language.vocabularySettings(VocabularySettingsEntry... vocabularySettings) Custom vocabularies to apply to your transcript, with one entry per language.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFieldsMethods inherited from interface software.amazon.awssdk.services.transcribe.model.TranscribeRequest.Builder
build
-
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.- Parameters:
media- The audio to transcribe. Specify exactly one ofMediaBytesorMediaFileUri.Audio sent in the request (
MediaBytes) can be up to 25 MB. Audio in Amazon S3 (MediaFileUri) can be up to 500 MB.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
media
The audio to transcribe. Specify exactly one of
MediaBytesorMediaFileUri.Audio sent in the request (
This is a convenience method that creates an instance of theMediaBytes) can be up to 25 MB. Audio in Amazon S3 (MediaFileUri) can be up to 500 MB.SyncMedia.Builderavoiding the need to create one manually viaSyncMedia.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tomedia(SyncMedia).- Parameters:
media- a consumer that will call methods onSyncMedia.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
language
The language spoken in your audio, as a base language code (for example,
enores).Include either
LanguageorLanguageDetectionModein your request, but not both.- Parameters:
language- The language spoken in your audio, as a base language code (for example,enores).Include either
LanguageorLanguageDetectionModein your request, but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
language
The language spoken in your audio, as a base language code (for example,
enores).Include either
LanguageorLanguageDetectionModein your request, but not both.- Parameters:
language- The language spoken in your audio, as a base language code (for example,enores).Include either
LanguageorLanguageDetectionModein your request, but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.- Parameters:
languageDetectionMode- Enables automatic language identification. UseIDENTIFY_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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.- Parameters:
languageDetectionMode- Enables automatic language identification. UseIDENTIFY_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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
languageOptionsWithStrings
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
languageOptionsWithStrings
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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).
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
vocabularySettings
TranscribeAudioRequest.Builder vocabularySettings(Collection<VocabularySettingsEntry> 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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vocabularySettings
TranscribeAudioRequest.Builder vocabularySettings(Consumer<VocabularySettingsEntry.Builder>... 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
This is a convenience method that creates an instance of theLanguage, include exactly one entry, and itsLanguagemust match. If you useLanguageDetectionMode, you can include one entry for each language inLanguageOptions.VocabularySettingsEntry.Builderavoiding the need to create one manually viaVocabularySettingsEntry.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tovocabularySettings(List<VocabularySettingsEntry>).- Parameters:
vocabularySettings- a consumer that will call methods onVocabularySettingsEntry.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
vocabularyFilterSettings
TranscribeAudioRequest.Builder vocabularyFilterSettings(VocabularyFilterSettings vocabularyFilterSettings) Custom vocabulary filters to apply to your transcript, and how to apply them.
- Parameters:
vocabularyFilterSettings- Custom vocabulary filters to apply to your transcript, and how to apply them.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vocabularyFilterSettings
default TranscribeAudioRequest.Builder vocabularyFilterSettings(Consumer<VocabularyFilterSettings.Builder> vocabularyFilterSettings) Custom vocabulary filters to apply to your transcript, and how to apply them.
This is a convenience method that creates an instance of theVocabularyFilterSettings.Builderavoiding the need to create one manually viaVocabularyFilterSettings.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tovocabularyFilterSettings(VocabularyFilterSettings).- Parameters:
vocabularyFilterSettings- a consumer that will call methods onVocabularyFilterSettings.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
contentRedaction- Redacts personally identifiable information (PII) from your transcript. Amazon Transcribe returns the redacted transcript inRedactedResults.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:
- Returns a reference to this object so that method calls can be chained together.
-
-
contentRedaction
default TranscribeAudioRequest.Builder contentRedaction(Consumer<ContentRedaction.Builder> 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.
ContentRedaction.Builderavoiding the need to create one manually viaContentRedaction.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocontentRedaction(ContentRedaction).- Parameters:
contentRedaction- a consumer that will call methods onContentRedaction.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
- Parameters:
outputConfiguration- Writes the transcript to an Amazon S3 location instead of returning it in the response. If you includeOutputConfiguration, the response contains only the output location.You must have write permission for the location you specify.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputConfiguration
default TranscribeAudioRequest.Builder outputConfiguration(Consumer<SyncOutputConfiguration.Builder> 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.
This is a convenience method that creates an instance of theSyncOutputConfiguration.Builderavoiding the need to create one manually viaSyncOutputConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tooutputConfiguration(SyncOutputConfiguration).- Parameters:
outputConfiguration- a consumer that will call methods onSyncOutputConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
TranscribeAudioRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
TranscribeAudioRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-