Class: Aws::ChimeSDKMeetings::Types::EngineTranscribeSettings

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

Overview

Note:

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

{
  language_code: "en-US", # 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, us-gov-west-1
  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",
  identify_language: false,
  language_options: "TranscribeLanguageOptions",
  preferred_language: "en-US", # 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
}

Settings specific to the Amazon Transcribe engine.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#content_identification_typeString

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

Returns:

  • (String)


953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/types.rb', line 953

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)
  SENSITIVE = []
  include Aws::Structure
end

#content_redaction_typeString

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.

You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.

Returns:

  • (String)


953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/types.rb', line 953

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)
  SENSITIVE = []
  include Aws::Structure
end

#enable_partial_results_stabilizationBoolean

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)


953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/types.rb', line 953

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)
  SENSITIVE = []
  include Aws::Structure
end

#identify_languageBoolean

Automatically identifies the language spoken in media files.

Returns:

  • (Boolean)


953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/types.rb', line 953

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)
  SENSITIVE = []
  include Aws::Structure
end

#language_codeString

The language code specified for the Amazon Transcribe engine.

Returns:

  • (String)


953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/types.rb', line 953

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)
  SENSITIVE = []
  include Aws::Structure
end

#language_model_nameString

The name of the language model used during transcription.

Returns:

  • (String)


953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/types.rb', line 953

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)
  SENSITIVE = []
  include Aws::Structure
end

#language_optionsString

Language codes for the languages that you want to identify. You must provide at least 2 codes.

Returns:

  • (String)


953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/types.rb', line 953

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)
  SENSITIVE = []
  include Aws::Structure
end

#partial_results_stabilityString

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)


953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/types.rb', line 953

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)
  SENSITIVE = []
  include Aws::Structure
end

#pii_entity_typesString

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)


953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/types.rb', line 953

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)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_languageString

Language code for the preferred language.

Returns:

  • (String)


953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/types.rb', line 953

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)
  SENSITIVE = []
  include Aws::Structure
end

#regionString

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

Returns:

  • (String)


953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/types.rb', line 953

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)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_methodString

The filtering method passed to Amazon Transcribe.

Returns:

  • (String)


953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/types.rb', line 953

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)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_nameString

The name of the vocabulary filter passed to Amazon Transcribe.

Returns:

  • (String)


953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/types.rb', line 953

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)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_nameString

The name of the vocabulary passed to Amazon Transcribe.

Returns:

  • (String)


953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/types.rb', line 953

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)
  SENSITIVE = []
  include Aws::Structure
end