Package software.amazon.awssdk.services.transcribestreaming.model

Class StartCallAnalyticsStreamTranscriptionRequest

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.StartCallAnalyticsStreamTranscriptionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartCallAnalyticsStreamTranscriptionRequest.Builder,StartCallAnalyticsStreamTranscriptionRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartCallAnalyticsStreamTranscriptionRequest extends TranscribeStreamingRequest implements ToCopyableBuilder<StartCallAnalyticsStreamTranscriptionRequest.Builder,StartCallAnalyticsStreamTranscriptionRequest>

  • Method Details

    • languageCode

      public final CallAnalyticsLanguageCode languageCode()

      Specify 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 streaming Call Analytics, refer to the Supported languages table.

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

      Returns:
      Specify 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 streaming Call Analytics, refer to the Supported languages table.

      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      Specify 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 streaming Call Analytics, refer to the Supported languages table.

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

      Returns:
      Specify 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 streaming Call Analytics, refer to the Supported languages table.

      See Also:

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

      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.

      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:
      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.

      See Also:

    • mediaEncodingAsString

      public final String mediaEncodingAsString()

      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.

      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:
      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.

      See Also:

    • vocabularyName

      public final String vocabularyName()

      Specify 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.

      For more information, see Custom vocabularies.

      Returns:
      Specify 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.

      For more information, see Custom vocabularies.

    • sessionId

      public final String sessionId()

      Specify a name for your Call Analytics 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.

      Returns:
      Specify a name for your Call Analytics 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.

    • vocabularyFilterName

      public final String vocabularyFilterName()

      Specify 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.

      For more information, see Using vocabulary filtering with unwanted words.

      Returns:
      Specify 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.

      For more information, see Using vocabulary filtering with unwanted words.

    • vocabularyFilterMethod

      public final VocabularyFilterMethod vocabularyFilterMethod()

      Specify 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.

      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:
      Specify 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.

      See Also:

    • vocabularyFilterMethodAsString

      public final String vocabularyFilterMethodAsString()

      Specify 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.

      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:
      Specify 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.

      See Also:

    • languageModelName

      public final String languageModelName()

      Specify 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.

      Returns:
      Specify 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.

    • enablePartialResultsStabilization

      public final Boolean enablePartialResultsStabilization()

      Enables 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.

      Returns:
      Enables 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.

    • partialResultsStability

      public final PartialResultsStability partialResultsStability()

      Specify 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.

      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:
      Specify 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.

      See Also:

    • partialResultsStabilityAsString

      public final String partialResultsStabilityAsString()

      Specify 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.

      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:
      Specify 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.

      See Also:

    • contentIdentificationType

      public final ContentIdentificationType contentIdentificationType()

      Labels 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.

      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:
      Labels 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.

      See Also:

    • contentIdentificationTypeAsString

      public final String contentIdentificationTypeAsString()

      Labels 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.

      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:
      Labels 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.

      See Also:

    • contentRedactionType

      public final ContentRedactionType contentRedactionType()

      Redacts 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.

      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:
      Redacts 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.

      See Also:

    • contentRedactionTypeAsString

      public final String contentRedactionTypeAsString()

      Redacts 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.

      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:
      Redacts 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.

      See Also:

    • piiEntityTypes

      public final String piiEntityTypes()

      Specify 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 Call Analytics 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.

      Returns:
      Specify 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 Call Analytics 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.

    • toBuilder

      public StartCallAnalyticsStreamTranscriptionRequest.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<StartCallAnalyticsStreamTranscriptionRequest.Builder,StartCallAnalyticsStreamTranscriptionRequest>
      Specified by:
      toBuilder in class TranscribeStreamingRequest
      Returns:
      a builder for type T

    • builder

      public static StartCallAnalyticsStreamTranscriptionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartCallAnalyticsStreamTranscriptionRequest.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.