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

Class StartStreamTranscriptionRequest

    • Method Detail

      • languageCode

        public final LanguageCode 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 Amazon Transcribe streaming, 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 LanguageCode.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 Amazon Transcribe streaming, refer to the Supported languages table.

        See Also:
        LanguageCode

      • 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 Amazon Transcribe streaming, 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 LanguageCode.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 Amazon Transcribe streaming, refer to the Supported languages table.

        See Also:
        LanguageCode

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

        This parameter is not intended for use with the IdentifyLanguage parameter. If you're including IdentifyLanguage in your request and want to use one or more custom vocabularies with your transcription, use the VocabularyNames parameter instead.

        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.

        This parameter is not intended for use with the IdentifyLanguage parameter. If you're including IdentifyLanguage in your request and want to use one or more custom vocabularies with your transcription, use the VocabularyNames parameter instead.

        For more information, see Custom vocabularies.

      • sessionId

        public final String sessionId()

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

        This parameter is not intended for use with the IdentifyLanguage parameter. If you're including IdentifyLanguage in your request and want to use one or more vocabulary filters with your transcription, use the VocabularyFilterNames parameter instead.

        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.

        This parameter is not intended for use with the IdentifyLanguage parameter. If you're including IdentifyLanguage in your request and want to use one or more vocabulary filters with your transcription, use the VocabularyFilterNames parameter instead.

        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

      • showSpeakerLabel

        public final Boolean showSpeakerLabel()

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

        For more information, see Partitioning speakers (diarization).

        Returns:
        Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

        For more information, see Partitioning speakers (diarization).

      • enableChannelIdentification

        public final Boolean enableChannelIdentification()

        Enables channel identification in multi-channel audio.

        Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

        If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.

        If you include EnableChannelIdentification in your request, you must also include NumberOfChannels.

        For more information, see Transcribing multi-channel audio.

        Returns:
        Enables channel identification in multi-channel audio.

        Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

        If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.

        If you include EnableChannelIdentification in your request, you must also include NumberOfChannels.

        For more information, see Transcribing multi-channel audio.

      • numberOfChannels

        public final Integer numberOfChannels()

        Specify the number of channels in your audio stream. This value must be 2, as only two channels are supported. If your audio doesn't contain multiple channels, do not include this parameter in your request.

        If you include NumberOfChannels in your request, you must also include EnableChannelIdentification.

        Returns:
        Specify the number of channels in your audio stream. This value must be 2, as only two channels are supported. If your audio doesn't contain multiple channels, do not include this parameter in your request.

        If you include NumberOfChannels in your request, you must also include EnableChannelIdentification.

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

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

      • identifyLanguage

        public final Boolean identifyLanguage()

        Enables automatic language identification for your transcription.

        If you include IdentifyLanguage, you must include a list of language codes, using LanguageOptions, that you think may be present in your audio stream.

        You can also include a preferred language using PreferredLanguage. Adding a preferred language can help Amazon Transcribe identify the language faster than if you omit this parameter.

        If you have multi-channel audio that contains different languages on each channel, and you've enabled channel identification, automatic language identification identifies the dominant language on each audio channel.

        Note that you must include either LanguageCode or IdentifyLanguage or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

        Streaming language identification can't be combined with custom language models or redaction.

        Returns:
        Enables automatic language identification for your transcription.

        If you include IdentifyLanguage, you must include a list of language codes, using LanguageOptions, that you think may be present in your audio stream.

        You can also include a preferred language using PreferredLanguage. Adding a preferred language can help Amazon Transcribe identify the language faster than if you omit this parameter.

        If you have multi-channel audio that contains different languages on each channel, and you've enabled channel identification, automatic language identification identifies the dominant language on each audio channel.

        Note that you must include either LanguageCode or IdentifyLanguage or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

        Streaming language identification can't be combined with custom language models or redaction.

      • languageOptions

        public final String languageOptions()

        Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended.

        Including language options can improve the accuracy of language identification.

        If you include LanguageOptions in your request, you must also include IdentifyLanguage or IdentifyMultipleLanguages.

        For a list of languages supported with Amazon Transcribe streaming, refer to the Supported languages table.

        You can only include one language dialect per language per stream. For example, you cannot include en-US and en-AU in the same request.

        Returns:
        Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended.

        Including language options can improve the accuracy of language identification.

        If you include LanguageOptions in your request, you must also include IdentifyLanguage or IdentifyMultipleLanguages.

        For a list of languages supported with Amazon Transcribe streaming, refer to the Supported languages table.

        You can only include one language dialect per language per stream. For example, you cannot include en-US and en-AU in the same request.

      • preferredLanguage

        public final LanguageCode preferredLanguage()

        Specify a preferred language from the subset of languages codes you specified in LanguageOptions.

        You can only use this parameter if you've included IdentifyLanguage and LanguageOptions in your request.

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

        Returns:
        Specify a preferred language from the subset of languages codes you specified in LanguageOptions.

        You can only use this parameter if you've included IdentifyLanguage and LanguageOptions in your request.

        See Also:
        LanguageCode

      • preferredLanguageAsString

        public final String preferredLanguageAsString()

        Specify a preferred language from the subset of languages codes you specified in LanguageOptions.

        You can only use this parameter if you've included IdentifyLanguage and LanguageOptions in your request.

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

        Returns:
        Specify a preferred language from the subset of languages codes you specified in LanguageOptions.

        You can only use this parameter if you've included IdentifyLanguage and LanguageOptions in your request.

        See Also:
        LanguageCode

      • identifyMultipleLanguages

        public final Boolean identifyMultipleLanguages()

        Enables automatic multi-language identification in your transcription job request. Use this parameter if your stream contains more than one language. If your stream contains only one language, use IdentifyLanguage instead.

        If you include IdentifyMultipleLanguages, you must include a list of language codes, using LanguageOptions, that you think may be present in your stream.

        If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic multiple language identification request, include VocabularyNames or VocabularyFilterNames.

        Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

        Returns:
        Enables automatic multi-language identification in your transcription job request. Use this parameter if your stream contains more than one language. If your stream contains only one language, use IdentifyLanguage instead.

        If you include IdentifyMultipleLanguages, you must include a list of language codes, using LanguageOptions, that you think may be present in your stream.

        If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic multiple language identification request, include VocabularyNames or VocabularyFilterNames.

        Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

      • vocabularyNames

        public final String vocabularyNames()

        Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

        If none of the languages of the specified custom vocabularies match the language identified in your media, your job fails.

        This parameter is only intended for use with the IdentifyLanguage parameter. If you're not including IdentifyLanguage in your request and want to use a custom vocabulary with your transcription, use the VocabularyName parameter instead.

        For more information, see Custom vocabularies.

        Returns:
        Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

        If none of the languages of the specified custom vocabularies match the language identified in your media, your job fails.

        This parameter is only intended for use with the IdentifyLanguage parameter. If you're not including IdentifyLanguage in your request and want to use a custom vocabulary with your transcription, use the VocabularyName parameter instead.

        For more information, see Custom vocabularies.

      • vocabularyFilterNames

        public final String vocabularyFilterNames()

        Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.

        If none of the languages of the specified custom vocabulary filters match the language identified in your media, your job fails.

        This parameter is only intended for use with the IdentifyLanguage parameter. If you're not including IdentifyLanguage in your request and want to use a custom vocabulary filter with your transcription, use the VocabularyFilterName parameter instead.

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

        Returns:
        Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.

        If none of the languages of the specified custom vocabulary filters match the language identified in your media, your job fails.

        This parameter is only intended for use with the IdentifyLanguage parameter. If you're not including IdentifyLanguage in your request and want to use a custom vocabulary filter with your transcription, use the VocabularyFilterName parameter instead.

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

      • 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