software.amazon.awssdk.services.transcribe.model

Class CallAnalyticsJobSettings

java.lang.Object

software.amazon.awssdk.services.transcribe.model.CallAnalyticsJobSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CallAnalyticsJobSettings.Builder,CallAnalyticsJobSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class CallAnalyticsJobSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CallAnalyticsJobSettings.Builder,CallAnalyticsJobSettings>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CallAnalyticsJobSettings.Builder

Method Summary

Modifier and Type	Method and Description
static CallAnalyticsJobSettings.Builder	builder()
ContentRedaction	contentRedaction() Returns the value of the ContentRedaction property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLanguageIdSettings() For responses, this returns true if the service returned a value for the LanguageIdSettings property.
boolean	hasLanguageOptions() For responses, this returns true if the service returned a value for the LanguageOptions property.
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).
Map<String,LanguageIdSettings>	languageIdSettingsAsStrings() 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	languageModelName() The name of the custom language model you want to use when processing your Call Analytics job.
List<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.
List<String>	languageOptionsAsStrings() 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.
List<SdkField<?>>	sdkFields()
static Class<? extends CallAnalyticsJobSettings.Builder>	serializableBuilderClass()
CallAnalyticsJobSettings.Builder	toBuilder()
String	toString() Returns a string representation of this object.
VocabularyFilterMethod	vocabularyFilterMethod() Specify how you want your vocabulary filter applied to your transcript.
String	vocabularyFilterMethodAsString() Specify how you want your vocabulary filter applied to your transcript.
String	vocabularyFilterName() The name of the custom vocabulary filter you want to include in your Call Analytics transcription request.
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

vocabularyName

public final String vocabularyName()

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.

vocabularyFilterName

public final 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.

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.

vocabularyFilterMethod

public final 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.

If the service returns an enum value that is not available in the current SDK version, vocabularyFilterMethod will return VocabularyFilterMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vocabularyFilterMethodAsString().

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

vocabularyFilterMethodAsString

public final String vocabularyFilterMethodAsString()

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.

If the service returns an enum value that is not available in the current SDK version, vocabularyFilterMethod will return VocabularyFilterMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vocabularyFilterMethodAsString().

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

languageModelName

public final 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.

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.

contentRedaction

public final ContentRedaction contentRedaction()

Returns the value of the ContentRedaction property for this object.

Returns:

The value of the ContentRedaction property for this object.

languageOptions

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLanguageOptions() method.

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.

hasLanguageOptions

public final boolean hasLanguageOptions()

For responses, this returns true if the service returned a value for the LanguageOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

languageOptionsAsStrings

public final List<String> languageOptionsAsStrings()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLanguageOptions() method.

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.

languageIdSettings

public final 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLanguageIdSettings() method.

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.

hasLanguageIdSettings

public final boolean hasLanguageIdSettings()

For responses, this returns true if the service returned a value for the LanguageIdSettings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

languageIdSettingsAsStrings

public final Map<String,LanguageIdSettings> languageIdSettingsAsStrings()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLanguageIdSettings() method.

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.

toBuilder

public CallAnalyticsJobSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CallAnalyticsJobSettings.Builder,CallAnalyticsJobSettings>

builder

public static CallAnalyticsJobSettings.Builder builder()

serializableBuilderClass

public static Class<? extends CallAnalyticsJobSettings.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo