Package software.amazon.awssdk.services.transcribe.model

Interface CallAnalyticsJobSettings.Builder

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

  • Method Details

    • vocabularyName

      CallAnalyticsJobSettings.Builder vocabularyName(String vocabularyName)

      The name of the custom vocabulary you want to include in your Call Analytics transcription request. Custom vocabulary names are case sensitive.

      Parameters:
      vocabularyName - The name of the custom vocabulary you want to include in your Call Analytics transcription request. Custom vocabulary names are case sensitive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vocabularyFilterName

      CallAnalyticsJobSettings.Builder vocabularyFilterName(String vocabularyFilterName)

      The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. Custom vocabulary filter names are case sensitive.

      Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

      Parameters:
      vocabularyFilterName - The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. Custom vocabulary filter names are case sensitive.

      Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

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

    • vocabularyFilterMethod

      CallAnalyticsJobSettings.Builder vocabularyFilterMethod(String vocabularyFilterMethod)

      Specify how you want your custom 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 custom 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

      CallAnalyticsJobSettings.Builder vocabularyFilterMethod(VocabularyFilterMethod vocabularyFilterMethod)

      Specify how you want your custom 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 custom 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

      CallAnalyticsJobSettings.Builder languageModelName(String languageModelName)

      The name of the custom language model you want to use when processing your Call Analytics job. Note that custom language model names are case sensitive.

      The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

      Parameters:
      languageModelName - The name of the custom language model you want to use when processing your Call Analytics job. Note that custom language model names are case sensitive.

      The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

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

    • contentRedaction

      CallAnalyticsJobSettings.Builder contentRedaction(ContentRedaction contentRedaction)
      Sets the value of the ContentRedaction property for this object.
      Parameters:
      contentRedaction - The new value for the ContentRedaction property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contentRedaction

      default CallAnalyticsJobSettings.Builder contentRedaction(Consumer<ContentRedaction.Builder> contentRedaction)
      Sets the value of the ContentRedaction property for this object. This is a convenience method that creates an instance of the ContentRedaction.Builder avoiding the need to create one manually via ContentRedaction.builder().

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

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

    • languageOptionsWithStrings

      CallAnalyticsJobSettings.Builder languageOptionsWithStrings(Collection<String> languageOptions)

      You can 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. If you're unsure what languages are present, do not include this parameter.

      Including language options can improve the accuracy of language identification.

      For a list of languages supported with Call Analytics, refer to the Supported languages table.

      To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.

      Parameters:
      languageOptions - You can 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. If you're unsure what languages are present, do not include this parameter.

      Including language options can improve the accuracy of language identification.

      For a list of languages supported with Call Analytics, refer to the Supported languages table.

      To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.

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

    • languageOptionsWithStrings

      CallAnalyticsJobSettings.Builder languageOptionsWithStrings(String... languageOptions)

      You can 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. If you're unsure what languages are present, do not include this parameter.

      Including language options can improve the accuracy of language identification.

      For a list of languages supported with Call Analytics, refer to the Supported languages table.

      To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.

      Parameters:
      languageOptions - You can 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. If you're unsure what languages are present, do not include this parameter.

      Including language options can improve the accuracy of language identification.

      For a list of languages supported with Call Analytics, refer to the Supported languages table.

      To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.

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

    • languageOptions

      CallAnalyticsJobSettings.Builder languageOptions(Collection<LanguageCode> languageOptions)

      You can 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. If you're unsure what languages are present, do not include this parameter.

      Including language options can improve the accuracy of language identification.

      For a list of languages supported with Call Analytics, refer to the Supported languages table.

      To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.

      Parameters:
      languageOptions - You can 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. If you're unsure what languages are present, do not include this parameter.

      Including language options can improve the accuracy of language identification.

      For a list of languages supported with Call Analytics, refer to the Supported languages table.

      To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.

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

    • languageOptions

      CallAnalyticsJobSettings.Builder languageOptions(LanguageCode... languageOptions)

      You can 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. If you're unsure what languages are present, do not include this parameter.

      Including language options can improve the accuracy of language identification.

      For a list of languages supported with Call Analytics, refer to the Supported languages table.

      To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.

      Parameters:
      languageOptions - You can 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. If you're unsure what languages are present, do not include this parameter.

      Including language options can improve the accuracy of language identification.

      For a list of languages supported with Call Analytics, refer to the Supported languages table.

      To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.

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

    • languageIdSettingsWithStrings

      CallAnalyticsJobSettings.Builder languageIdSettingsWithStrings(Map<String,LanguageIdSettings> languageIdSettings)

      If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName).

      LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.

      It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

      If you want to include a custom language model, custom vocabulary, or custom vocabulary filter with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName, VocabularyName, or VocabularyFilterName sub-parameters.

      For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.

      Parameters:
      languageIdSettings - If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName).

      LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.

      It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

      If you want to include a custom language model, custom vocabulary, or custom vocabulary filter with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName, VocabularyName, or VocabularyFilterName sub-parameters.

      For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.

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

    • languageIdSettings

      CallAnalyticsJobSettings.Builder languageIdSettings(Map<LanguageCode,LanguageIdSettings> languageIdSettings)

      If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName).

      LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.

      It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

      If you want to include a custom language model, custom vocabulary, or custom vocabulary filter with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName, VocabularyName, or VocabularyFilterName sub-parameters.

      For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.

      Parameters:
      languageIdSettings - If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName).

      LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.

      It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

      If you want to include a custom language model, custom vocabulary, or custom vocabulary filter with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName, VocabularyName, or VocabularyFilterName sub-parameters.

      For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.

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

    • summarization

      CallAnalyticsJobSettings.Builder summarization(Summarization summarization)

      Contains GenerateAbstractiveSummary, which is a required parameter if you want to enable Generative call summarization in your Call Analytics request.

      Parameters:
      summarization - Contains GenerateAbstractiveSummary, which is a required parameter if you want to enable Generative call summarization in your Call Analytics request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • summarization

      default CallAnalyticsJobSettings.Builder summarization(Consumer<Summarization.Builder> summarization)

      Contains GenerateAbstractiveSummary, which is a required parameter if you want to enable Generative call summarization in your Call Analytics request.

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

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

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