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

Inherits:

Struct

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

show all

Defined in:: gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb

Overview

Settings specific for Amazon Transcribe as the live transcription engine.

If you specify an invalid combination of parameters, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#content_identification_type ⇒ String
Labels all personally identifiable information (PII) identified in your transcript.
#content_redaction_type ⇒ String
Content redaction is performed at the segment level.
#enable_partial_results_stabilization ⇒ Boolean
Enables partial result stabilization for your transcription.
#identify_language ⇒ Boolean
Enables automatic language identification for your transcription.
#language_code ⇒ String
Specify the language code that represents the language spoken.
#language_model_name ⇒ String
Specify the name of the custom language model that you want to use when processing your transcription.
#language_options ⇒ String
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.
#partial_results_stability ⇒ String
Specify the level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization).
#pii_entity_types ⇒ String
Specify which types of personally identifiable information (PII) you want to redact in your transcript.
#preferred_language ⇒ String
Specify a preferred language from the subset of languages codes you specified in LanguageOptions.
#region ⇒ String
The AWS Region in which to use Amazon Transcribe.
#vocabulary_filter_method ⇒ String
Specify how you want your vocabulary filter applied to your transcript.
#vocabulary_filter_name ⇒ String
Specify the name of the custom vocabulary filter that you want to use when processing your transcription.
#vocabulary_filter_names ⇒ String
Specify the names of the custom vocabulary filters that you want to use when processing your transcription.
#vocabulary_name ⇒ String
Specify the name of the custom vocabulary that you want to use when processing your transcription.
#vocabulary_names ⇒ String
Specify the names of the custom vocabularies that you want to use when processing your transcription.

Instance Attribute Details

#content_identification_type ⇒ `String`

Labels all personally identifiable information (PII) identified in your transcript. If you don't include PiiEntityTypes, all PII is identified.

You can’t set ContentIdentificationType and ContentRedactionType.

Returns:

(String)

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

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,
  :identify_language,
  :language_options,
  :preferred_language,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#content_redaction_type ⇒ `String`

Content redaction is performed at the segment level. If you don't include PiiEntityTypes, all PII is redacted.

You can’t set ContentIdentificationType and ContentRedactionType.

Returns:

(String)

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

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,
  :identify_language,
  :language_options,
  :preferred_language,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#enable_partial_results_stabilization ⇒ `Boolean`

Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.

Returns:

(Boolean)

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

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,
  :identify_language,
  :language_options,
  :preferred_language,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#identify_language ⇒ `Boolean`

Enables automatic language identification for your transcription.

If you include IdentifyLanguage, you can optionally use LanguageOptions to include a list of language codes that you think may be present in your audio stream. Including language options can improve transcription accuracy.

You can also use PreferredLanguage to include a preferred language. Doing so can help Amazon Transcribe identify the language faster.

You must include either LanguageCode or IdentifyLanguage.

Language identification can't be combined with custom language models or redaction.

Returns:

(Boolean)

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

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,
  :identify_language,
  :language_options,
  :preferred_language,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ `String`

Specify the language code that represents the language spoken.

If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification.

Returns:

(String)

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

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,
  :identify_language,
  :language_options,
  :preferred_language,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#language_model_name ⇒ `String`

Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.

The language of the specified language model must match the language code. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

If you use Amazon Transcribe in multiple Regions, the custom language model must be available in Amazon Transcribe in each Region.

Returns:

(String)

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

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,
  :identify_language,
  :language_options,
  :preferred_language,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#language_options ⇒ `String`

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.

If you include LanguageOptions, you must also include IdentifyLanguage.

You can only include one language dialect per language. For example, you cannot include en-US and en-AU.

Returns:

(String)

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

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,
  :identify_language,
  :language_options,
  :preferred_language,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#partial_results_stability ⇒ `String`

Specify the level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization).

Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.

Returns:

(String)

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

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,
  :identify_language,
  :language_options,
  :preferred_language,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#pii_entity_types ⇒ `String`

Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL.

Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY CREDIT_DEBIT_NUMBER, EMAIL,NAME, PHONE, PIN, SSN, or ALL.

Note that if you include PiiEntityTypes, you must also include ContentIdentificationType or ContentRedactionType.

If you include ContentRedactionType or ContentIdentificationType, but do not include PiiEntityTypes, all PII is redacted or identified.

Returns:

(String)

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

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,
  :identify_language,
  :language_options,
  :preferred_language,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_language ⇒ `String`

Specify a preferred language from the subset of languages codes you specified in LanguageOptions.

You can only use this parameter if you include IdentifyLanguage and LanguageOptions.

Returns:

(String)

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

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,
  :identify_language,
  :language_options,
  :preferred_language,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#region ⇒ `String`

The AWS Region in which to use Amazon Transcribe.

If you don't specify a Region, then the MediaRegion parameter of the CreateMeeting.html API will be used. However, if Amazon Transcribe is not available in the MediaRegion, then a TranscriptFailed event is sent.

Use auto to use Amazon Transcribe in a Region near the meeting’s MediaRegion. For more information, refer to Choosing a transcription Region in the Amazon Chime SDK Developer Guide.

Returns:

(String)

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

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,
  :identify_language,
  :language_options,
  :preferred_language,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_method ⇒ `String`

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)

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

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,
  :identify_language,
  :language_options,
  :preferred_language,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_name ⇒ `String`

Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.

If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.

If you include IdentifyLanguage and want to use one or more vocabulary filters with your transcription, use the VocabularyFilterNames parameter instead.

Returns:

(String)

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

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,
  :identify_language,
  :language_options,
  :preferred_language,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_names ⇒ `String`

Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.

If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.

If you're not including IdentifyLanguage and want to use a custom vocabulary filter with your transcription, use the VocabularyFilterName parameter instead.

Returns:

(String)

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

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,
  :identify_language,
  :language_options,
  :preferred_language,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_name ⇒ `String`

Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

If you use Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.

If you include IdentifyLanguage and want to use one or more custom vocabularies with your transcription, use the VocabularyNames parameter instead.

Returns:

(String)

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

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,
  :identify_language,
  :language_options,
  :preferred_language,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_names ⇒ `String`

Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

If you use Amazon Transcribe in multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.

If you don't include IdentifyLanguage and want to use a custom vocabulary with your transcription, use the VocabularyName parameter instead.

Returns:

(String)

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

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,
  :identify_language,
  :language_options,
  :preferred_language,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#content_identification_type ⇒ String

#content_redaction_type ⇒ String

#enable_partial_results_stabilization ⇒ Boolean

#identify_language ⇒ Boolean

#language_code ⇒ String

#language_model_name ⇒ String

#language_options ⇒ String

#partial_results_stability ⇒ String

#pii_entity_types ⇒ String

#preferred_language ⇒ String

#region ⇒ String

#vocabulary_filter_method ⇒ String

#vocabulary_filter_name ⇒ String

#vocabulary_filter_names ⇒ String

#vocabulary_name ⇒ String

#vocabulary_names ⇒ String

#content_identification_type ⇒ `String`

#content_redaction_type ⇒ `String`

#enable_partial_results_stabilization ⇒ `Boolean`

#identify_language ⇒ `Boolean`

#language_code ⇒ `String`

#language_model_name ⇒ `String`

#language_options ⇒ `String`

#partial_results_stability ⇒ `String`

#pii_entity_types ⇒ `String`

#preferred_language ⇒ `String`

#region ⇒ `String`

#vocabulary_filter_method ⇒ `String`

#vocabulary_filter_name ⇒ `String`

#vocabulary_filter_names ⇒ `String`

#vocabulary_name ⇒ `String`

#vocabulary_names ⇒ `String`