Class: Aws::Chime::Types::EngineTranscribeSettings

Inherits:

Struct

• Object
• Struct
• Aws::Chime::Types::EngineTranscribeSettings

Defined in:

gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb

Overview

Note:

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

{
  language_code: "en-US", # required, accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN
  vocabulary_filter_method: "remove", # accepts remove, mask, tag
  vocabulary_filter_name: "String",
  vocabulary_name: "String",
  region: "us-east-2", # accepts us-east-2, us-east-1, us-west-2, ap-northeast-2, ap-southeast-2, ap-northeast-1, ca-central-1, eu-central-1, eu-west-1, eu-west-2, sa-east-1, auto
  enable_partial_results_stabilization: false,
  partial_results_stability: "low", # accepts low, medium, high
  content_identification_type: "PII", # accepts PII
  content_redaction_type: "PII", # accepts PII
  pii_entity_types: "TranscribePiiEntityTypes",
  language_model_name: "TranscribeLanguageModelName",
}

Settings specific to the Amazon Transcribe engine.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #content_identification_type ⇒ String

  Set this field to PII to identify personally identifiable information in the transcription output.

• #content_redaction_type ⇒ String

  Set this field to PII to redact personally identifiable information in the transcription output.

• #enable_partial_results_stabilization ⇒ Boolean

  Generates partial transcription results that are less likely to change as meeting attendees speak.

• #language_code ⇒ String

  The language code specified for the Amazon Transcribe engine.

• #language_model_name ⇒ String

  The name of the language model used during transcription.

• #partial_results_stability ⇒ String

  The stabity level of a partial results transcription.

• #pii_entity_types ⇒ String

  Lists the PII entity types you want to identify or redact.

• #region ⇒ String

  The AWS Region passed to Amazon Transcribe.

• #vocabulary_filter_method ⇒ String

  The filtering method passed to Amazon Transcribe.

• #vocabulary_filter_name ⇒ String

  The name of the vocabulary filter passed to Amazon Transcribe.

• #vocabulary_name ⇒ String

  The name of the vocabulary passed to Amazon Transcribe.

Instance Attribute Details

#content_identification_type ⇒ String

Set this field to PII to identify personally identifiable information in the transcription output.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 4586

class EngineTranscribeSettings < Struct.new(
  :language_code,
  :vocabulary_filter_method,
  :vocabulary_filter_name,
  :vocabulary_name,
  :region,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name)
  SENSITIVE = []
  include Aws::Structure
end

#content_redaction_type ⇒ String

Set this field to PII to redact personally identifiable information in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 4586

class EngineTranscribeSettings < Struct.new(
  :language_code,
  :vocabulary_filter_method,
  :vocabulary_filter_name,
  :vocabulary_name,
  :region,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name)
  SENSITIVE = []
  include Aws::Structure
end

#enable_partial_results_stabilization ⇒ Boolean

Generates partial transcription results that are less likely to change as meeting attendees speak. It does so by only allowing the last few words from the partial results to change.

Returns:

• (Boolean)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 4586

class EngineTranscribeSettings < Struct.new(
  :language_code,
  :vocabulary_filter_method,
  :vocabulary_filter_name,
  :vocabulary_name,
  :region,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

The language code specified for the Amazon Transcribe engine.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 4586

class EngineTranscribeSettings < Struct.new(
  :language_code,
  :vocabulary_filter_method,
  :vocabulary_filter_name,
  :vocabulary_name,
  :region,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name)
  SENSITIVE = []
  include Aws::Structure
end

#language_model_name ⇒ String

The name of the language model used during transcription.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 4586

class EngineTranscribeSettings < Struct.new(
  :language_code,
  :vocabulary_filter_method,
  :vocabulary_filter_name,
  :vocabulary_name,
  :region,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name)
  SENSITIVE = []
  include Aws::Structure
end

#partial_results_stability ⇒ String

The stabity level of a partial results transcription. Determines how stable you want the transcription results to be. A higher level means the transcription results are less likely to change.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 4586

class EngineTranscribeSettings < Struct.new(
  :language_code,
  :vocabulary_filter_method,
  :vocabulary_filter_name,
  :vocabulary_name,
  :region,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name)
  SENSITIVE = []
  include Aws::Structure
end

#pii_entity_types ⇒ String

Lists the PII entity types you want to identify or redact. To specify entity types, you must enable ContentIdentificationType or ContentRedactionType.

PIIEntityTypes must be comma-separated. The available values are: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL.

PiiEntityTypes is an optional parameter with a default value of ALL.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 4586

class EngineTranscribeSettings < Struct.new(
  :language_code,
  :vocabulary_filter_method,
  :vocabulary_filter_name,
  :vocabulary_name,
  :region,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name)
  SENSITIVE = []
  include Aws::Structure
end

#region ⇒ String

The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 4586

class EngineTranscribeSettings < Struct.new(
  :language_code,
  :vocabulary_filter_method,
  :vocabulary_filter_name,
  :vocabulary_name,
  :region,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_method ⇒ String

The filtering method passed to Amazon Transcribe.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 4586

class EngineTranscribeSettings < Struct.new(
  :language_code,
  :vocabulary_filter_method,
  :vocabulary_filter_name,
  :vocabulary_name,
  :region,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_name ⇒ String

The name of the vocabulary filter passed to Amazon Transcribe.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 4586

class EngineTranscribeSettings < Struct.new(
  :language_code,
  :vocabulary_filter_method,
  :vocabulary_filter_name,
  :vocabulary_name,
  :region,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_name ⇒ String

The name of the vocabulary passed to Amazon Transcribe.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 4586

class EngineTranscribeSettings < Struct.new(
  :language_code,
  :vocabulary_filter_method,
  :vocabulary_filter_name,
  :vocabulary_name,
  :region,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name)
  SENSITIVE = []
  include Aws::Structure
end