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

Class StartCallAnalyticsStreamTranscriptionRequest

    • Method Detail

      • languageCodeAsString

        public final String languageCodeAsString()

        Specify the language code that represents the language spoken in your audio.

        For a list of languages supported with real-time 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.

        For a list of languages supported with real-time Call Analytics, refer to the Supported languages table.

        See Also:
        CallAnalyticsLanguageCode

      • 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:
        MediaEncoding

      • 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:
        MediaEncoding

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

        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.

      • 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:
        VocabularyFilterMethod

      • 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:
        VocabularyFilterMethod

      • 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:
        PartialResultsStability

      • 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:
        PartialResultsStability

      • 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. If you don't include PiiEntityTypes in your request, all PII is identified.

        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. If you don't include PiiEntityTypes in your request, all PII is identified.

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

      • 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. If you don't include PiiEntityTypes in your request, all PII is identified.

        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. If you don't include PiiEntityTypes in your request, all PII is identified.

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

      • 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. If you don't include PiiEntityTypes in your request, all PII is redacted.

        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. If you don't include PiiEntityTypes in your request, all PII is redacted.

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

      • 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. If you don't include PiiEntityTypes in your request, all PII is redacted.

        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. If you don't include PiiEntityTypes in your request, all PII is redacted.

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

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

        Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL.

        Note that if you include PiiEntityTypes in your request, you must also include ContentIdentificationType or ContentRedactionType.

        If you include ContentRedactionType or ContentIdentificationType in your request, but do not include PiiEntityTypes, all PII is redacted or identified.

        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.

        Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL.

        Note that if you include PiiEntityTypes in your request, you must also include ContentIdentificationType or ContentRedactionType.

        If you include ContentRedactionType or ContentIdentificationType in your request, but do not include PiiEntityTypes, all PII is redacted or identified.

      • 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