Class: Aws::TranscribeService::Types::LanguageModel

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

Overview

Provides information about a custom language model, including:

  • The base model name

  • When the model was created

  • The location of the files used to train the model

  • When the model was last modified

  • The name you chose for the model

  • The model’s language

  • The model’s processing state

  • Any available upgrades for the base model

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#base_model_name ⇒ String

The Amazon Transcribe standard language model, or base model, used to create your custom language model.

Returns:

  • (String) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class LanguageModel < Struct.new(
  :model_name,
  :create_time,
  :last_modified_time,
  :language_code,
  :base_model_name,
  :model_status,
  :upgrade_availability,
  :failure_reason,
  :input_data_config)
  SENSITIVE = []
  include Aws::Structure
end

#create_time ⇒ Time

The date and time the specified custom language model was created.

Timestamps are in the format ‘YYYY-MM-DD’T’HH:MM:SS.SSSSSS-UTC`. For example, ‘2022-05-04T12:32:58.761000-07:00` represents 12:32 PM UTC-7 on May 4, 2022.

Returns:

  • (Time) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class LanguageModel < Struct.new(
  :model_name,
  :create_time,
  :last_modified_time,
  :language_code,
  :base_model_name,
  :model_status,
  :upgrade_availability,
  :failure_reason,
  :input_data_config)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

If ‘ModelStatus` is `FAILED`, `FailureReason` contains information about why the custom language model request failed. See also: [Common Errors].

[1]: docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html

Returns:

  • (String) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class LanguageModel < Struct.new(
  :model_name,
  :create_time,
  :last_modified_time,
  :language_code,
  :base_model_name,
  :model_status,
  :upgrade_availability,
  :failure_reason,
  :input_data_config)
  SENSITIVE = []
  include Aws::Structure
end

#input_data_config ⇒ Types::InputDataConfig

The Amazon S3 location of the input files used to train and tune your custom language model, in addition to the data access role ARN (Amazon Resource Name) that has permissions to access these data.

Returns:



2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class LanguageModel < Struct.new(
  :model_name,
  :create_time,
  :last_modified_time,
  :language_code,
  :base_model_name,
  :model_status,
  :upgrade_availability,
  :failure_reason,
  :input_data_config)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

The language code used to create your custom language model. Each custom language model must contain terms in only one language, and the language you select for your custom language model must match the language of your training and tuning data.

For a list of supported languages and their associated language codes, refer to the [Supported languages] table. Note that US English (‘en-US`) is the only language supported with Amazon Transcribe Medical.

[1]: docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html

Returns:

  • (String) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class LanguageModel < Struct.new(
  :model_name,
  :create_time,
  :last_modified_time,
  :language_code,
  :base_model_name,
  :model_status,
  :upgrade_availability,
  :failure_reason,
  :input_data_config)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ Time

The date and time the specified custom language model was last modified.

Timestamps are in the format ‘YYYY-MM-DD’T’HH:MM:SS.SSSSSS-UTC`. For example, ‘2022-05-04T12:32:58.761000-07:00` represents 12:32 PM UTC-7 on May 4, 2022.

Returns:

  • (Time) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class LanguageModel < Struct.new(
  :model_name,
  :create_time,
  :last_modified_time,
  :language_code,
  :base_model_name,
  :model_status,
  :upgrade_availability,
  :failure_reason,
  :input_data_config)
  SENSITIVE = []
  include Aws::Structure
end

#model_name ⇒ String

A unique name, chosen by you, for your custom language model.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

Returns:

  • (String) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class LanguageModel < Struct.new(
  :model_name,
  :create_time,
  :last_modified_time,
  :language_code,
  :base_model_name,
  :model_status,
  :upgrade_availability,
  :failure_reason,
  :input_data_config)
  SENSITIVE = []
  include Aws::Structure
end

#model_status ⇒ String

The status of the specified custom language model. When the status displays as ‘COMPLETED` the model is ready for use.

Returns:

  • (String) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class LanguageModel < Struct.new(
  :model_name,
  :create_time,
  :last_modified_time,
  :language_code,
  :base_model_name,
  :model_status,
  :upgrade_availability,
  :failure_reason,
  :input_data_config)
  SENSITIVE = []
  include Aws::Structure
end

#upgrade_availability ⇒ Boolean

Shows if a more current base model is available for use with the specified custom language model.

If ‘false`, your custom language model is using the most up-to-date base model.

If ‘true`, there is a newer base model available than the one your language model is using.

Note that to update a base model, you must recreate the custom language model using the new base model. Base model upgrades for existing custom language models are not supported.

Returns:

  • (Boolean) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class LanguageModel < Struct.new(
  :model_name,
  :create_time,
  :last_modified_time,
  :language_code,
  :base_model_name,
  :model_status,
  :upgrade_availability,
  :failure_reason,
  :input_data_config)
  SENSITIVE = []
  include Aws::Structure
end