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

Interface StartCallAnalyticsStreamTranscriptionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartCallAnalyticsStreamTranscriptionRequest.Builder,StartCallAnalyticsStreamTranscriptionRequest>, SdkBuilder<StartCallAnalyticsStreamTranscriptionRequest.Builder,StartCallAnalyticsStreamTranscriptionRequest>, SdkPojo, SdkRequest.Builder, TranscribeStreamingRequest.Builder
Enclosing class:
StartCallAnalyticsStreamTranscriptionRequest
public static interface StartCallAnalyticsStreamTranscriptionRequest.Builder extends TranscribeStreamingRequest.Builder, SdkPojo, CopyableBuilder<StartCallAnalyticsStreamTranscriptionRequest.Builder,StartCallAnalyticsStreamTranscriptionRequest>

  • Method Details

    • languageCode

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

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

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

    • languageCode

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

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

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

    • 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

      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:

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

      You can use a session ID to retry a streaming session.

      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.

      You can use a session ID to retry a streaming session.

      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

      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:

    • 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

      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:

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

      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.

      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

      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.

      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.

      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:

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

      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.

      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

      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.

      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.

      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:

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

      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.

      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.

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

    • overrideConfiguration

      StartCallAnalyticsStreamTranscriptionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartCallAnalyticsStreamTranscriptionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.