Class CallAnalyticsJobSettings
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CallAnalyticsJobSettings.Builder,
CallAnalyticsJobSettings>
Provides additional optional settings for your request, including content redaction, automatic language identification; allows you to apply custom language models, custom vocabulary filters, and custom vocabularies.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final ContentRedaction
Returns the value of the ContentRedaction property for this object.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LanguageIdSettings property.final boolean
For responses, this returns true if the service returned a value for the LanguageOptions property.final Map
<LanguageCode, 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, includeLanguageIdSettings
with the relevant sub-parameters (VocabularyName
,LanguageModelName
, andVocabularyFilterName
).final Map
<String, 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, includeLanguageIdSettings
with the relevant sub-parameters (VocabularyName
,LanguageModelName
, andVocabularyFilterName
).final String
The name of the custom language model you want to use when processing your Call Analytics job.final List
<LanguageCode> You can specify two or more language codes that represent the languages you think may be present in your media.You can specify two or more language codes that represent the languages you think may be present in your media.static Class
<? extends CallAnalyticsJobSettings.Builder> final Summarization
ContainsGenerateAbstractiveSummary
, which is a required parameter if you want to enable Generative call summarization in your Call Analytics request.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final VocabularyFilterMethod
Specify how you want your custom vocabulary filter applied to your transcript.final String
Specify how you want your custom vocabulary filter applied to your transcript.final String
The name of the custom vocabulary filter you want to include in your Call Analytics transcription request.final String
The name of the custom vocabulary you want to include in your Call Analytics transcription request.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
vocabularyName
The name of the custom vocabulary you want to include in your Call Analytics transcription request. Custom vocabulary names are case sensitive.
- Returns:
- The name of the custom vocabulary you want to include in your Call Analytics transcription request. Custom vocabulary names are case sensitive.
-
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 includeVocabularyFilterMethod
.- Returns:
- 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 includeVocabularyFilterMethod
.
-
vocabularyFilterMethod
Specify how you want your custom vocabulary filter applied to your transcript.
To replace words with
***
, choosemask
.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 returnVocabularyFilterMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvocabularyFilterMethodAsString()
.- Returns:
- Specify how you want your custom vocabulary filter applied to your transcript.
To replace words with
***
, choosemask
.To delete words, choose
remove
.To flag words without changing them, choose
tag
. - See Also:
-
vocabularyFilterMethodAsString
Specify how you want your custom vocabulary filter applied to your transcript.
To replace words with
***
, choosemask
.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 returnVocabularyFilterMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvocabularyFilterMethodAsString()
.- Returns:
- Specify how you want your custom vocabulary filter applied to your transcript.
To replace words with
***
, choosemask
.To delete words, choose
remove
.To flag words without changing them, choose
tag
. - See Also:
-
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:
- 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.
-
contentRedaction
Returns the value of the ContentRedaction property for this object.- Returns:
- The value of the ContentRedaction property for this object.
-
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.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.
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.
-
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 theisEmpty()
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
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.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.
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.
-
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
, andVocabularyFilterName
).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 usingLanguageIdSettings
to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is inen-US
but Amazon Transcribe determines that the language spoken in your media isen-AU
, your custom vocabulary is not applied to your transcription. If you includeLanguageOptions
and includeen-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
, orVocabularyFilterName
sub-parameters.For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.
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 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
, andVocabularyFilterName
).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 usingLanguageIdSettings
to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is inen-US
but Amazon Transcribe determines that the language spoken in your media isen-AU
, your custom vocabulary is not applied to your transcription. If you includeLanguageOptions
and includeen-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
, orVocabularyFilterName
sub-parameters.For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.
-
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 theisEmpty()
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
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
, andVocabularyFilterName
).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 usingLanguageIdSettings
to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is inen-US
but Amazon Transcribe determines that the language spoken in your media isen-AU
, your custom vocabulary is not applied to your transcription. If you includeLanguageOptions
and includeen-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
, orVocabularyFilterName
sub-parameters.For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.
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 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
, andVocabularyFilterName
).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 usingLanguageIdSettings
to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is inen-US
but Amazon Transcribe determines that the language spoken in your media isen-AU
, your custom vocabulary is not applied to your transcription. If you includeLanguageOptions
and includeen-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
, orVocabularyFilterName
sub-parameters.For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.
-
summarization
Contains
GenerateAbstractiveSummary
, which is a required parameter if you want to enable Generative call summarization in your Call Analytics request.- Returns:
- Contains
GenerateAbstractiveSummary
, which is a required parameter if you want to enable Generative call summarization in your Call Analytics request.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CallAnalyticsJobSettings.Builder,
CallAnalyticsJobSettings> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-