Package software.amazon.awssdk.services.chimesdkmediapipelines.model

Interface AmazonTranscribeProcessorConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AmazonTranscribeProcessorConfiguration.Builder,AmazonTranscribeProcessorConfiguration>, SdkBuilder<AmazonTranscribeProcessorConfiguration.Builder,AmazonTranscribeProcessorConfiguration>, SdkPojo
Enclosing class:
AmazonTranscribeProcessorConfiguration
public static interface AmazonTranscribeProcessorConfiguration.Builder extends SdkPojo, CopyableBuilder<AmazonTranscribeProcessorConfiguration.Builder,AmazonTranscribeProcessorConfiguration>

  • Method Details

    • languageCode

      AmazonTranscribeProcessorConfiguration.Builder languageCode(String languageCode)

      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 that real-time Call Analytics supports, see the Supported languages table in the Amazon Transcribe Developer Guide.

      Parameters:
      languageCode - 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 that real-time Call Analytics supports, see the Supported languages table in the Amazon Transcribe Developer Guide.

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

    • languageCode

      AmazonTranscribeProcessorConfiguration.Builder languageCode(CallAnalyticsLanguageCode languageCode)

      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 that real-time Call Analytics supports, see the Supported languages table in the Amazon Transcribe Developer Guide.

      Parameters:
      languageCode - 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 that real-time Call Analytics supports, see the Supported languages table in the Amazon Transcribe Developer Guide.

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

    • vocabularyName

      AmazonTranscribeProcessorConfiguration.Builder vocabularyName(String vocabularyName)

      The name of the custom vocabulary that you specified in your Call Analytics request.

      Length Constraints: Minimum length of 1. Maximum length of 200.

      Parameters:
      vocabularyName - The name of the custom vocabulary that you specified in your Call Analytics request.

      Length Constraints: Minimum length of 1. Maximum length of 200.

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

    • vocabularyFilterName

      AmazonTranscribeProcessorConfiguration.Builder vocabularyFilterName(String vocabularyFilterName)

      The name of the custom vocabulary filter that you specified in your Call Analytics request.

      Length Constraints: Minimum length of 1. Maximum length of 200.

      Parameters:
      vocabularyFilterName - The name of the custom vocabulary filter that you specified in your Call Analytics request.

      Length Constraints: Minimum length of 1. Maximum length of 200.

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

    • vocabularyFilterMethod

      AmazonTranscribeProcessorConfiguration.Builder vocabularyFilterMethod(String vocabularyFilterMethod)

      The vocabulary filtering method used in your Call Analytics transcription.

      Parameters:
      vocabularyFilterMethod - The vocabulary filtering method used in your Call Analytics transcription.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vocabularyFilterMethod

      AmazonTranscribeProcessorConfiguration.Builder vocabularyFilterMethod(VocabularyFilterMethod vocabularyFilterMethod)

      The vocabulary filtering method used in your Call Analytics transcription.

      Parameters:
      vocabularyFilterMethod - The vocabulary filtering method used in your Call Analytics transcription.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • showSpeakerLabel

      AmazonTranscribeProcessorConfiguration.Builder showSpeakerLabel(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) in the Amazon Transcribe Developer Guide.

      Parameters:
      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) in the Amazon Transcribe Developer Guide.

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

    • enablePartialResultsStabilization

      AmazonTranscribeProcessorConfiguration.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 in the Amazon Transcribe Developer Guide.

      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 in the Amazon Transcribe Developer Guide.

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

    • partialResultsStability

      AmazonTranscribeProcessorConfiguration.Builder partialResultsStability(String partialResultsStability)

      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 in the Amazon Transcribe Developer Guide.

      Parameters:
      partialResultsStability - 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 in the Amazon Transcribe Developer Guide.

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

    • partialResultsStability

      AmazonTranscribeProcessorConfiguration.Builder partialResultsStability(PartialResultsStability partialResultsStability)

      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 in the Amazon Transcribe Developer Guide.

      Parameters:
      partialResultsStability - 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 in the Amazon Transcribe Developer Guide.

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

    • contentIdentificationType

      AmazonTranscribeProcessorConfiguration.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 in the Amazon Transcribe Developer Guide.

      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 in the Amazon Transcribe Developer Guide.

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

    • contentIdentificationType

      AmazonTranscribeProcessorConfiguration.Builder contentIdentificationType(ContentType 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 in the Amazon Transcribe Developer Guide.

      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 in the Amazon Transcribe Developer Guide.

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

    • contentRedactionType

      AmazonTranscribeProcessorConfiguration.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 in the Amazon Transcribe Developer Guide.

      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 in the Amazon Transcribe Developer Guide.

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

    • contentRedactionType

      AmazonTranscribeProcessorConfiguration.Builder contentRedactionType(ContentType 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 in the Amazon Transcribe Developer Guide.

      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 in the Amazon Transcribe Developer Guide.

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

    • piiEntityTypes

      AmazonTranscribeProcessorConfiguration.Builder piiEntityTypes(String piiEntityTypes)

      The types of personally identifiable information (PII) to redact from a 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 ContentIdentificationType or ContentRedactionType, but you can't include both.

      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.

      If you leave this parameter empty, the default behavior is equivalent to ALL.

      Parameters:
      piiEntityTypes - The types of personally identifiable information (PII) to redact from a 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 ContentIdentificationType or ContentRedactionType, but you can't include both.

      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.

      If you leave this parameter empty, the default behavior is equivalent to ALL.

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

    • languageModelName

      AmazonTranscribeProcessorConfiguration.Builder languageModelName(String languageModelName)

      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 in the Amazon Transcribe Developer Guide.

      Parameters:
      languageModelName - 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 in the Amazon Transcribe Developer Guide.

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

    • filterPartialResults

      AmazonTranscribeProcessorConfiguration.Builder filterPartialResults(Boolean filterPartialResults)

      If true, TranscriptEvents with IsPartial: true are filtered out of the insights target.

      Parameters:
      filterPartialResults - If true, TranscriptEvents with IsPartial: true are filtered out of the insights target.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identifyLanguage

      AmazonTranscribeProcessorConfiguration.Builder identifyLanguage(Boolean identifyLanguage)

      Turns language identification on or off.

      Parameters:
      identifyLanguage - Turns language identification on or off.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identifyMultipleLanguages

      AmazonTranscribeProcessorConfiguration.Builder identifyMultipleLanguages(Boolean identifyMultipleLanguages)

      Turns language identification on or off for multiple languages.

      Parameters:
      identifyMultipleLanguages - Turns language identification on or off for multiple languages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • languageOptions

      AmazonTranscribeProcessorConfiguration.Builder languageOptions(String languageOptions)

      The language options for the transcription, such as automatic language detection.

      Parameters:
      languageOptions - The language options for the transcription, such as automatic language detection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • preferredLanguage

      AmazonTranscribeProcessorConfiguration.Builder preferredLanguage(String preferredLanguage)

      The preferred language for the transcription.

      Parameters:
      preferredLanguage - The preferred language for the transcription.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • preferredLanguage

      AmazonTranscribeProcessorConfiguration.Builder preferredLanguage(CallAnalyticsLanguageCode preferredLanguage)

      The preferred language for the transcription.

      Parameters:
      preferredLanguage - The preferred language for the transcription.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vocabularyNames

      AmazonTranscribeProcessorConfiguration.Builder vocabularyNames(String vocabularyNames)

      The names of the custom vocabulary or vocabularies used during transcription.

      Parameters:
      vocabularyNames - The names of the custom vocabulary or vocabularies used during transcription.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vocabularyFilterNames

      AmazonTranscribeProcessorConfiguration.Builder vocabularyFilterNames(String vocabularyFilterNames)

      The names of the custom vocabulary filter or filters using during transcription.

      Parameters:
      vocabularyFilterNames - The names of the custom vocabulary filter or filters using during transcription.
      Returns:
      Returns a reference to this object so that method calls can be chained together.