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 Summary

Modifier and Type	Method and Description
default CallAnalyticsJobSettings.Builder	contentRedaction(Consumer<ContentRedaction.Builder> contentRedaction) Sets the value of the ContentRedaction property for this object.
CallAnalyticsJobSettings.Builder	contentRedaction(ContentRedaction contentRedaction) Sets the value of the ContentRedaction property for this object.
CallAnalyticsJobSettings.Builder	languageIdSettings(Map<LanguageCode,LanguageIdSettings> languageIdSettings) If using automatic language identification (IdentifyLanguage) 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).
CallAnalyticsJobSettings.Builder	languageIdSettingsWithStrings(Map<String,LanguageIdSettings> languageIdSettings) If using automatic language identification (IdentifyLanguage) 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).
CallAnalyticsJobSettings.Builder	languageModelName(String languageModelName) The name of the custom language model you want to use when processing your Call Analytics job.
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.
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.
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.
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.
CallAnalyticsJobSettings.Builder	vocabularyFilterMethod(String vocabularyFilterMethod) Specify how you want your vocabulary filter applied to your transcript.
CallAnalyticsJobSettings.Builder	vocabularyFilterMethod(VocabularyFilterMethod vocabularyFilterMethod) Specify how you want your vocabulary filter applied to your transcript.
CallAnalyticsJobSettings.Builder	vocabularyFilterName(String vocabularyFilterName) The name of the custom vocabulary filter you want to include in your Call Analytics transcription request.
CallAnalyticsJobSettings.Builder	vocabularyName(String vocabularyName) The name of the custom vocabulary you want to include in your Call Analytics transcription request.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

vocabularyName

CallAnalyticsJobSettings.Builder vocabularyName(String vocabularyName)

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

Parameters:

vocabularyName - The name of the custom vocabulary you want to include in your Call Analytics transcription request. 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. 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. 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 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

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

CallAnalyticsJobSettings.Builder languageModelName(String languageModelName)

The name of the custom language model you want to use when processing your Call Analytics job. 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 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 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 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:

contentRedaction(ContentRedaction)

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.

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.

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.

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.

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.

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.

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.

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.

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 (IdentifyLanguage) 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).

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. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.

To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification.

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

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

Parameters:

languageIdSettings - If using automatic language identification (IdentifyLanguage) 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).

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. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.

To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification.

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

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

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 (IdentifyLanguage) 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).

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. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.

To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification.

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

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

Parameters:

languageIdSettings - If using automatic language identification (IdentifyLanguage) 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).

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. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.

To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification.

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

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

Returns:

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