Class: Aws::TranscribeService::Types::CallAnalyticsJobSettings

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-transcribeservice/types.rb

Overview

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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#content_redaction ⇒ Types::ContentRedaction

Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ‘ContentRedaction`, you must also include the sub-parameters: `RedactionOutput` and `RedactionType`. You can optionally include `PiiEntityTypes` to choose which types of PII you want to redact.

Returns:



403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 403

class CallAnalyticsJobSettings < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :language_model_name,
  :content_redaction,
  :language_options,
  :language_id_settings,
  :summarization)
  SENSITIVE = []
  include Aws::Structure
end

#language_id_settings ⇒ Hash<String,Types::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.</p> For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features. `

Returns:



403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 403

class CallAnalyticsJobSettings < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :language_model_name,
  :content_redaction,
  :language_options,
  :language_id_settings,
  :summarization)
  SENSITIVE = []
  include Aws::Structure
end

#language_model_name ⇒ String

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:

  • (String) 


403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 403

class CallAnalyticsJobSettings < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :language_model_name,
  :content_redaction,
  :language_options,
  :language_id_settings,
  :summarization)
  SENSITIVE = []
  include Aws::Structure
end

#language_options ⇒ Array<String>

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][1

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.

[1]: docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html

Returns:

  • (Array<String>) 


403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 403

class CallAnalyticsJobSettings < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :language_model_name,
  :content_redaction,
  :language_options,
  :language_id_settings,
  :summarization)
  SENSITIVE = []
  include Aws::Structure
end

#summarization ⇒ Types::Summarization

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

Returns:



403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 403

class CallAnalyticsJobSettings < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :language_model_name,
  :content_redaction,
  :language_options,
  :language_id_settings,
  :summarization)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_method ⇒ String

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

Returns:

  • (String) 


403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 403

class CallAnalyticsJobSettings < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :language_model_name,
  :content_redaction,
  :language_options,
  :language_id_settings,
  :summarization)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_name ⇒ String

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

Returns:

  • (String) 


403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 403

class CallAnalyticsJobSettings < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :language_model_name,
  :content_redaction,
  :language_options,
  :language_id_settings,
  :summarization)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_name ⇒ String

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

Returns:

  • (String) 


403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 403

class CallAnalyticsJobSettings < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :language_model_name,
  :content_redaction,
  :language_options,
  :language_id_settings,
  :summarization)
  SENSITIVE = []
  include Aws::Structure
end