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, cy-GB, 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, ga-IE, gd-GB, 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 optional settings for the CallAnalyticsJob operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#content_redactionTypes::ContentRedaction

Settings for content redaction within a transcription job.



315
316
317
318
319
320
321
322
323
324
325
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 315

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>

The language identification settings associated with your call analytics job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.

Returns:



315
316
317
318
319
320
321
322
323
324
325
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 315

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 structure used to describe a custom language model.

Returns:

  • (String)


315
316
317
318
319
320
321
322
323
324
325
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 315

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>

When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.

To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages for additional information.

Returns:

  • (Array<String>)


315
316
317
318
319
320
321
322
323
324
325
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 315

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

Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.

Returns:

  • (String)


315
316
317
318
319
320
321
322
323
324
325
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 315

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 vocabulary filter to use when running a call analytics job. The filter that you specify must have the same language code as the analytics job.

Returns:

  • (String)


315
316
317
318
319
320
321
322
323
324
325
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 315

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 a vocabulary to use when processing the call analytics job.

Returns:

  • (String)


315
316
317
318
319
320
321
322
323
324
325
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 315

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