/AWS1/CL_TNBCALLALYSJOBSTGS

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_vocabularyname TYPE /AWS1/TNBVOCABULARYNAME /AWS1/TNBVOCABULARYNAME

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

iv_vocabularyfiltername TYPE /AWS1/TNBVOCABULARYFILTERNAME /AWS1/TNBVOCABULARYFILTERNAME

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.

iv_vocabularyfiltermethod TYPE /AWS1/TNBVOCABULARYFILTERMETH /AWS1/TNBVOCABULARYFILTERMETH

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.

iv_languagemodelname TYPE /AWS1/TNBMODELNAME /AWS1/TNBMODELNAME

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.

io_contentredaction TYPE REF TO /AWS1/CL_TNBCONTENTREDACTION /AWS1/CL_TNBCONTENTREDACTION

ContentRedaction

it_languageoptions TYPE /AWS1/CL_TNBLANGUAGEOPTIONS_W=>TT_LANGUAGEOPTIONS TT_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) in Amazon Web Services GovCloud (US) (US-West, us-gov-west-1), Amazon Web Services GovCloud (US) (US-East, us-gov-east-1), Canada (Calgary) ca-west-1 and Africa (Cape Town) af-south-1, your media file must be encoded at a sample rate of 16,000 Hz or higher.

it_languageidsettings TYPE /AWS1/CL_TNBLANGUAGEIDSETTINGS=>TT_LANGUAGEIDSETTINGSMAP TT_LANGUAGEIDSETTINGSMAP

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.

io_summarization TYPE REF TO /AWS1/CL_TNBSUMMARIZATION /AWS1/CL_TNBSUMMARIZATION

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

---

Queryable Attributes

VocabularyName

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

Accessible with the following methods

Method	Description
GET_VOCABULARYNAME()	Getter for VOCABULARYNAME, with configurable default
ASK_VOCABULARYNAME()	Getter for VOCABULARYNAME w/ exceptions if field has no valu
HAS_VOCABULARYNAME()	Determine if VOCABULARYNAME has a value

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.

Accessible with the following methods

Method	Description
GET_VOCABULARYFILTERNAME()	Getter for VOCABULARYFILTERNAME, with configurable default
ASK_VOCABULARYFILTERNAME()	Getter for VOCABULARYFILTERNAME w/ exceptions if field has n
HAS_VOCABULARYFILTERNAME()	Determine if VOCABULARYFILTERNAME has a value

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.

Accessible with the following methods

Method	Description
GET_VOCABULARYFILTERMETHOD()	Getter for VOCABULARYFILTERMETHOD, with configurable default
ASK_VOCABULARYFILTERMETHOD()	Getter for VOCABULARYFILTERMETHOD w/ exceptions if field has
HAS_VOCABULARYFILTERMETHOD()	Determine if VOCABULARYFILTERMETHOD has a value

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.

Accessible with the following methods

Method	Description
GET_LANGUAGEMODELNAME()	Getter for LANGUAGEMODELNAME, with configurable default
ASK_LANGUAGEMODELNAME()	Getter for LANGUAGEMODELNAME w/ exceptions if field has no v
HAS_LANGUAGEMODELNAME()	Determine if LANGUAGEMODELNAME has a value

ContentRedaction

ContentRedaction

Accessible with the following methods

Method	Description
GET_CONTENTREDACTION()	Getter for CONTENTREDACTION

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) in Amazon Web Services GovCloud (US) (US-West, us-gov-west-1), Amazon Web Services GovCloud (US) (US-East, us-gov-east-1), Canada (Calgary) ca-west-1 and Africa (Cape Town) af-south-1, your media file must be encoded at a sample rate of 16,000 Hz or higher.

Accessible with the following methods

Method	Description
GET_LANGUAGEOPTIONS()	Getter for LANGUAGEOPTIONS, with configurable default
ASK_LANGUAGEOPTIONS()	Getter for LANGUAGEOPTIONS w/ exceptions if field has no val
HAS_LANGUAGEOPTIONS()	Determine if LANGUAGEOPTIONS has a value

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.

Accessible with the following methods

Method	Description
GET_LANGUAGEIDSETTINGS()	Getter for LANGUAGEIDSETTINGS, with configurable default
ASK_LANGUAGEIDSETTINGS()	Getter for LANGUAGEIDSETTINGS w/ exceptions if field has no
HAS_LANGUAGEIDSETTINGS()	Determine if LANGUAGEIDSETTINGS has a value

Summarization

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

Accessible with the following methods

Method	Description
GET_SUMMARIZATION()	Getter for SUMMARIZATION