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

Interface AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder

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

  • Method Details

    • languageCode

      AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder languageCode(String languageCode)

      The language code in the configuration.

      Parameters:
      languageCode - The language code in the configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • languageCode

      AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder languageCode(CallAnalyticsLanguageCode languageCode)

      The language code in the configuration.

      Parameters:
      languageCode - The language code in the configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vocabularyName

      AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder vocabularyName(String vocabularyName)

      Specifies the name of the custom vocabulary to use when processing a 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 in the Amazon Transcribe Developer Guide.

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

      Parameters:
      vocabularyName - Specifies the name of the custom vocabulary to use when processing a 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 in the Amazon Transcribe Developer Guide.

      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

      AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder vocabularyFilterName(String vocabularyFilterName)

      Specifies the name of the custom vocabulary filter to use when processing a 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 in the Amazon Transcribe Developer Guide.

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

      Parameters:
      vocabularyFilterName - Specifies the name of the custom vocabulary filter to use when processing a 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 in the Amazon Transcribe Developer Guide.

      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

      AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder vocabularyFilterMethod(String vocabularyFilterMethod)

      Specifies how to apply a vocabulary filter to a transcript.

      To replace words with ***, choose mask.

      To delete words, choose remove.

      To flag words without changing them, choose tag.

      Parameters:
      vocabularyFilterMethod - Specifies how to apply a vocabulary filter to a 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

      AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder vocabularyFilterMethod(VocabularyFilterMethod vocabularyFilterMethod)

      Specifies how to apply a vocabulary filter to a transcript.

      To replace words with ***, choose mask.

      To delete words, choose remove.

      To flag words without changing them, choose tag.

      Parameters:
      vocabularyFilterMethod - Specifies how to apply a vocabulary filter to a 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

      AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder languageModelName(String languageModelName)

      Specifies the name of the custom language model to use when processing a transcription. Note that language model names are case sensitive.

      The language of the specified language model must match the language code specified in the transcription request. If the languages don't match, the custom language model isn't applied. Language mismatches don't generate errors or warnings.

      For more information, see Custom language models in the Amazon Transcribe Developer Guide.

      Parameters:
      languageModelName - Specifies the name of the custom language model to use when processing a transcription. Note that language model names are case sensitive.

      The language of the specified language model must match the language code specified in the transcription request. If the languages don't match, the custom language model isn't applied. Language mismatches don't generate errors or warnings.

      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.

    • enablePartialResultsStabilization

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

      AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder partialResultsStability(String partialResultsStability)

      Specifies 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 - Specifies 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

      AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder partialResultsStability(PartialResultsStability partialResultsStability)

      Specifies 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 - Specifies 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

      AmazonTranscribeCallAnalyticsProcessorConfiguration.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 do, 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 do, 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

      AmazonTranscribeCallAnalyticsProcessorConfiguration.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 do, 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 do, 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

      AmazonTranscribeCallAnalyticsProcessorConfiguration.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 do, 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 do, 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

      AmazonTranscribeCallAnalyticsProcessorConfiguration.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 do, 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 do, 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

      AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder piiEntityTypes(String piiEntityTypes)

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

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

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

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

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

    • filterPartialResults

      AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder filterPartialResults(Boolean filterPartialResults)

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

      Parameters:
      filterPartialResults - If true, UtteranceEvents 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.

    • postCallAnalyticsSettings

      AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder postCallAnalyticsSettings(PostCallAnalyticsSettings postCallAnalyticsSettings)

      The settings for a post-call analysis task in an analytics configuration.

      Parameters:
      postCallAnalyticsSettings - The settings for a post-call analysis task in an analytics configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • postCallAnalyticsSettings

      default AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder postCallAnalyticsSettings(Consumer<PostCallAnalyticsSettings.Builder> postCallAnalyticsSettings)

      The settings for a post-call analysis task in an analytics configuration.

      This is a convenience method that creates an instance of the PostCallAnalyticsSettings.Builder avoiding the need to create one manually via PostCallAnalyticsSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to postCallAnalyticsSettings(PostCallAnalyticsSettings).

      Parameters:
      postCallAnalyticsSettings - a consumer that will call methods on PostCallAnalyticsSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • callAnalyticsStreamCategories

      AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder callAnalyticsStreamCategories(Collection<String> callAnalyticsStreamCategories)

      By default, all CategoryEvents are sent to the insights target. If this parameter is specified, only included categories are sent to the insights target.

      Parameters:
      callAnalyticsStreamCategories - By default, all CategoryEvents are sent to the insights target. If this parameter is specified, only included categories are sent to the insights target.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • callAnalyticsStreamCategories

      AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder callAnalyticsStreamCategories(String... callAnalyticsStreamCategories)

      By default, all CategoryEvents are sent to the insights target. If this parameter is specified, only included categories are sent to the insights target.

      Parameters:
      callAnalyticsStreamCategories - By default, all CategoryEvents are sent to the insights target. If this parameter is specified, only included categories are sent to the insights target.
      Returns:
      Returns a reference to this object so that method calls can be chained together.