LanguageModel

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

BaseModelName

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

Type: String

Valid Values: NarrowBand | WideBand

Required: No

CreateTime

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.

Type: Timestamp

Required: No

FailureReason

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

Type: String

Required: No

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.

Type: InputDataConfig object

Required: No

LanguageCode

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.

Type: String

Required: No

LastModifiedTime

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.

Type: Timestamp

Required: No

ModelName

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 AWS account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[0-9a-zA-Z._-]+

Required: No

ModelStatus

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

Type: String

Valid Values: IN_PROGRESS | FAILED | COMPLETED

Required: No

UpgradeAvailability

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.

Type: Boolean

Required: No

LanguageModel

Contents

See Also