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

Interface StartCallAnalyticsStreamTranscriptionRequest.Builder

    • Method Detail

      • mediaSampleRateHertz

        StartCallAnalyticsStreamTranscriptionRequest.Builder mediaSampleRateHertz​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • mediaEncoding

        StartCallAnalyticsStreamTranscriptionRequest.Builder mediaEncoding​(String 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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MediaEncoding, MediaEncoding

      • mediaEncoding

        StartCallAnalyticsStreamTranscriptionRequest.Builder mediaEncoding​(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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MediaEncoding, MediaEncoding

      • vocabularyName

        StartCallAnalyticsStreamTranscriptionRequest.Builder vocabularyName​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • sessionId

        StartCallAnalyticsStreamTranscriptionRequest.Builder sessionId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • vocabularyFilterName

        StartCallAnalyticsStreamTranscriptionRequest.Builder vocabularyFilterName​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • vocabularyFilterMethod

        StartCallAnalyticsStreamTranscriptionRequest.Builder vocabularyFilterMethod​(String 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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        VocabularyFilterMethod, VocabularyFilterMethod

      • vocabularyFilterMethod

        StartCallAnalyticsStreamTranscriptionRequest.Builder vocabularyFilterMethod​(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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        VocabularyFilterMethod, VocabularyFilterMethod

      • languageModelName

        StartCallAnalyticsStreamTranscriptionRequest.Builder languageModelName​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • enablePartialResultsStabilization

        StartCallAnalyticsStreamTranscriptionRequest.Builder enablePartialResultsStabilization​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • partialResultsStability

        StartCallAnalyticsStreamTranscriptionRequest.Builder partialResultsStability​(String 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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PartialResultsStability, PartialResultsStability

      • partialResultsStability

        StartCallAnalyticsStreamTranscriptionRequest.Builder partialResultsStability​(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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PartialResultsStability, PartialResultsStability

      • contentIdentificationType

        StartCallAnalyticsStreamTranscriptionRequest.Builder contentIdentificationType​(String 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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ContentIdentificationType, ContentIdentificationType

      • contentIdentificationType

        StartCallAnalyticsStreamTranscriptionRequest.Builder contentIdentificationType​(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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ContentIdentificationType, ContentIdentificationType

      • contentRedactionType

        StartCallAnalyticsStreamTranscriptionRequest.Builder contentRedactionType​(String 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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ContentRedactionType, ContentRedactionType

      • contentRedactionType

        StartCallAnalyticsStreamTranscriptionRequest.Builder contentRedactionType​(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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ContentRedactionType, ContentRedactionType

      • piiEntityTypes

        StartCallAnalyticsStreamTranscriptionRequest.Builder piiEntityTypes​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.