Class TranscribeAudioRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<TranscribeAudioRequest.Builder,TranscribeAudioRequest>

@Generated("software.amazon.awssdk:codegen") public final class TranscribeAudioRequest extends TranscribeRequest implements ToCopyableBuilder<TranscribeAudioRequest.Builder,TranscribeAudioRequest>
  • Method Details

    • media

      public final SyncMedia media()

      The audio to transcribe. Specify exactly one of MediaBytes or MediaFileUri.

      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 MediaBytes or MediaFileUri.

      Audio sent in the request (MediaBytes) can be up to 25 MB. Audio in Amazon S3 ( MediaFileUri) can be up to 500 MB.

    • language

      public final SyncLanguage language()

      The language spoken in your audio, as a base language code (for example, en or es).

      Include either Language or LanguageDetectionMode in your request, but not both.

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

      Returns:
      The language spoken in your audio, as a base language code (for example, en or es).

      Include either Language or LanguageDetectionMode in your request, but not both.

      See Also:
    • languageAsString

      public final String languageAsString()

      The language spoken in your audio, as a base language code (for example, en or es).

      Include either Language or LanguageDetectionMode in your request, but not both.

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

      Returns:
      The language spoken in your audio, as a base language code (for example, en or es).

      Include either Language or LanguageDetectionMode in your request, but not both.

      See Also:
    • languageDetectionMode

      public final LanguageDetectionMode languageDetectionMode()

      Enables automatic language identification. Use IDENTIFY_LANGUAGE if your audio contains a single language that you don't know in advance.

      You can optionally include LanguageOptions to 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 Language or LanguageDetectionMode in your request, but not both.

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

      Returns:
      Enables automatic language identification. Use IDENTIFY_LANGUAGE if your audio contains a single language that you don't know in advance.

      You can optionally include LanguageOptions to 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 Language or LanguageDetectionMode in your request, but not both.

      See Also:
    • languageDetectionModeAsString

      public final String languageDetectionModeAsString()

      Enables automatic language identification. Use IDENTIFY_LANGUAGE if your audio contains a single language that you don't know in advance.

      You can optionally include LanguageOptions to 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 Language or LanguageDetectionMode in your request, but not both.

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

      Returns:
      Enables automatic language identification. Use IDENTIFY_LANGUAGE if your audio contains a single language that you don't know in advance.

      You can optionally include LanguageOptions to 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 Language or LanguageDetectionMode in your request, but not both.

      See Also:
    • languageOptions

      public final List<SyncLanguage> languageOptions()

      A list of two or more languages that you think may be present in your audio, as base language codes (for example, en and es). Each language can appear only once. A list with only one language returns a BadRequestException.

      You can use LanguageOptions only with LanguageDetectionMode.

      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, en and es). Each language can appear only once. A list with only one language returns a BadRequestException.

      You can use LanguageOptions only with LanguageDetectionMode.

    • 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 the isEmpty() 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

      public final List<String> languageOptionsAsStrings()

      A list of two or more languages that you think may be present in your audio, as base language codes (for example, en and es). Each language can appear only once. A list with only one language returns a BadRequestException.

      You can use LanguageOptions only with LanguageDetectionMode.

      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, en and es). Each language can appear only once. A list with only one language returns a BadRequestException.

      You can use LanguageOptions only with LanguageDetectionMode.

    • channelIdentification

      public final Boolean 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

      public final Boolean showSpeakerLabels()

      Enables speaker partitioning (diarization) in your transcript. Speaker partitioning labels the speech from individual speakers in your media file.

      If you set ShowSpeakerLabels to true, you must also include MaxSpeakerLabels.

      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 ShowSpeakerLabels to true, you must also include MaxSpeakerLabels.

      For more information, see Partitioning speakers (diarization).

    • maxSpeakerLabels

      public final Integer 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 MaxSpeakerLabels only if ShowSpeakerLabels is true.

      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 MaxSpeakerLabels only if ShowSpeakerLabels is true.

    • 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 the isEmpty() 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

      public final List<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 its Language must match. If you use LanguageDetectionMode, you can include one entry for each language in LanguageOptions.

      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 its Language must match. If you use LanguageDetectionMode, you can include one entry for each language in LanguageOptions.

    • vocabularyFilterSettings

      public final VocabularyFilterSettings 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

      public final ContentRedaction contentRedaction()

      Redacts personally identifiable information (PII) from your transcript. Amazon Transcribe returns the redacted transcript in RedactedResults.

      If you set RedactionOutput to redacted_and_unredacted, Amazon Transcribe also returns the unredacted transcript in Results.

      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 include LanguageOptions, and every language in it must be one of the languages above. A request that has no LanguageOptions, or that lists a language that isn't supported, returns a BadRequestException.

      • 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 RedactionOutput to redacted_and_unredacted, Amazon Transcribe also returns the unredacted transcript in Results.

      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 include LanguageOptions, and every language in it must be one of the languages above. A request that has no LanguageOptions, or that lists a language that isn't supported, returns a BadRequestException.

      • 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

      public final SyncOutputConfiguration 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

      public TranscribeAudioRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<TranscribeAudioRequest.Builder,TranscribeAudioRequest>
      Specified by:
      toBuilder in class TranscribeRequest
      Returns:
      a builder for type T
    • builder

      public static TranscribeAudioRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends TranscribeAudioRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.