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

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

Overview

Note:

When making an API call, you may pass CallAnalyticsJobSettings data as a hash:

{
  vocabulary_name: "VocabularyName",
  vocabulary_filter_name: "VocabularyFilterName",
  vocabulary_filter_method: "remove", # accepts remove, mask, tag
  language_model_name: "ModelName",
  content_redaction: {
    redaction_type: "PII", # required, accepts PII
    redaction_output: "redacted", # required, accepts redacted, redacted_and_unredacted
    pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, ALL
  },
  language_options: ["af-ZA"], # accepts af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
  language_id_settings: {
    "af-ZA" => {
      vocabulary_name: "VocabularyName",
      vocabulary_filter_name: "VocabularyFilterName",
      language_model_name: "ModelName",
    },
  },
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#content_redactionTypes::ContentRedaction

Allows you to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: PiiEntityTypes, RedactionOutput, and RedactionType.



419
420
421
422
423
424
425
426
427
428
429
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 419

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

#language_id_settingsHash<String,Types::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.</p> 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.</p>

Returns:



419
420
421
422
423
424
425
426
427
428
429
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 419

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

#language_model_nameString

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:

  • (String)


419
420
421
422
423
424
425
426
427
428
429
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 419

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

#language_optionsArray<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 table.

Returns:

  • (Array<String>)


419
420
421
422
423
424
425
426
427
428
429
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 419

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

#vocabulary_filter_methodString

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:

  • (String)


419
420
421
422
423
424
425
426
427
428
429
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 419

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

#vocabulary_filter_nameString

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:

  • (String)


419
420
421
422
423
424
425
426
427
428
429
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 419

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

#vocabulary_nameString

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

Returns:

  • (String)


419
420
421
422
423
424
425
426
427
428
429
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 419

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