com.amazonaws.services.transcribe.model

Class CallAnalyticsJobSettings

java.lang.Object

com.amazonaws.services.transcribe.model.CallAnalyticsJobSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CallAnalyticsJobSettings
extends Object
implements Serializable, Cloneable, StructuredPojo

Provides additional optional settings for your request, including content redaction, automatic language identification; allows you to apply custom language models, vocabulary filters, and custom vocabularies.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CallAnalyticsJobSettings()

Method Summary

Modifier and Type	Method and Description
CallAnalyticsJobSettings	addLanguageIdSettingsEntry(String key, LanguageIdSettings value) Add a single LanguageIdSettings entry
CallAnalyticsJobSettings	clearLanguageIdSettingsEntries() Removes all the entries added into LanguageIdSettings.
CallAnalyticsJobSettings	clone()
boolean	equals(Object obj)
ContentRedaction	getContentRedaction()
Map<String,LanguageIdSettings>	getLanguageIdSettings() 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).
String	getLanguageModelName() The name of the custom language model you want to use when processing your Call Analytics job.
List<String>	getLanguageOptions() 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.
String	getVocabularyFilterMethod() Specify how you want your vocabulary filter applied to your transcript.
String	getVocabularyFilterName() The name of the custom vocabulary filter you want to include in your Call Analytics transcription request.
String	getVocabularyName() The name of the custom vocabulary you want to include in your Call Analytics transcription request.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setContentRedaction(ContentRedaction contentRedaction)
void	setLanguageIdSettings(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).
void	setLanguageModelName(String languageModelName) The name of the custom language model you want to use when processing your Call Analytics job.
void	setLanguageOptions(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.
void	setVocabularyFilterMethod(String vocabularyFilterMethod) Specify how you want your vocabulary filter applied to your transcript.
void	setVocabularyFilterName(String vocabularyFilterName) The name of the custom vocabulary filter you want to include in your Call Analytics transcription request.
void	setVocabularyName(String vocabularyName) The name of the custom vocabulary you want to include in your Call Analytics transcription request.
String	toString() Returns a string representation of this object.
CallAnalyticsJobSettings	withContentRedaction(ContentRedaction contentRedaction)
CallAnalyticsJobSettings	withLanguageIdSettings(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	withLanguageModelName(String languageModelName) The name of the custom language model you want to use when processing your Call Analytics job.
CallAnalyticsJobSettings	withLanguageOptions(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	withLanguageOptions(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	withLanguageOptions(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	withVocabularyFilterMethod(String vocabularyFilterMethod) Specify how you want your vocabulary filter applied to your transcript.
CallAnalyticsJobSettings	withVocabularyFilterMethod(VocabularyFilterMethod vocabularyFilterMethod) Specify how you want your vocabulary filter applied to your transcript.
CallAnalyticsJobSettings	withVocabularyFilterName(String vocabularyFilterName) The name of the custom vocabulary filter you want to include in your Call Analytics transcription request.
CallAnalyticsJobSettings	withVocabularyName(String vocabularyName) The name of the custom vocabulary you want to include in your Call Analytics transcription request.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CallAnalyticsJobSettings

public CallAnalyticsJobSettings()

Method Detail

setVocabularyName

public void setVocabularyName(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.

getVocabularyName

public String getVocabularyName()

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

Returns:

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

withVocabularyName

public CallAnalyticsJobSettings withVocabularyName(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.

setVocabularyFilterName

public void setVocabularyFilterName(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.

getVocabularyFilterName

public String getVocabularyFilterName()

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:

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.

withVocabularyFilterName

public CallAnalyticsJobSettings withVocabularyFilterName(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.

setVocabularyFilterMethod

public void setVocabularyFilterMethod(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.

See Also:

VocabularyFilterMethod

getVocabularyFilterMethod

public String getVocabularyFilterMethod()

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:

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.

See Also:

VocabularyFilterMethod

withVocabularyFilterMethod

public CallAnalyticsJobSettings withVocabularyFilterMethod(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

withVocabularyFilterMethod

public CallAnalyticsJobSettings withVocabularyFilterMethod(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

setLanguageModelName

public void setLanguageModelName(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.

getLanguageModelName

public String getLanguageModelName()

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:

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.

withLanguageModelName

public CallAnalyticsJobSettings withLanguageModelName(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.

setContentRedaction

public void setContentRedaction(ContentRedaction contentRedaction)

Parameters:

contentRedaction -

getContentRedaction

public ContentRedaction getContentRedaction()

Returns:

withContentRedaction

public CallAnalyticsJobSettings withContentRedaction(ContentRedaction contentRedaction)

Parameters:

contentRedaction -

Returns:

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

getLanguageOptions

public List<String> getLanguageOptions()

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:

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.

See Also:

LanguageCode

setLanguageOptions

public void setLanguageOptions(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.

See Also:

LanguageCode

withLanguageOptions

public CallAnalyticsJobSettings withLanguageOptions(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.

NOTE: This method appends the values to the existing list (if any). Use setLanguageOptions(java.util.Collection) or withLanguageOptions(java.util.Collection) if you want to override the existing values.

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.

See Also:

LanguageCode

withLanguageOptions

public CallAnalyticsJobSettings withLanguageOptions(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.

See Also:

LanguageCode

withLanguageOptions

public CallAnalyticsJobSettings withLanguageOptions(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.

See Also:

LanguageCode

getLanguageIdSettings

public Map<String,LanguageIdSettings> getLanguageIdSettings()

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:

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.

setLanguageIdSettings

public void setLanguageIdSettings(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.

withLanguageIdSettings

public CallAnalyticsJobSettings withLanguageIdSettings(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.

addLanguageIdSettingsEntry

public CallAnalyticsJobSettings addLanguageIdSettingsEntry(String key,
                                                           LanguageIdSettings value)

Add a single LanguageIdSettings entry

See Also:

withLanguageIdSettings(java.util.Map<java.lang.String, com.amazonaws.services.transcribe.model.LanguageIdSettings>)

clearLanguageIdSettingsEntries

public CallAnalyticsJobSettings clearLanguageIdSettingsEntries()

Removes all the entries added into LanguageIdSettings.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CallAnalyticsJobSettings clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.