Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Transcribe.Types.LanguageModel

Description

Synopsis

data LanguageModel = LanguageModel' {
- baseModelName :: Maybe BaseModelName
- createTime :: Maybe POSIX
- failureReason :: Maybe Text
- inputDataConfig :: Maybe InputDataConfig
- languageCode :: Maybe CLMLanguageCode
- lastModifiedTime :: Maybe POSIX
- modelName :: Maybe Text
- modelStatus :: Maybe ModelStatus
- upgradeAvailability :: Maybe Bool
}
newLanguageModel :: LanguageModel
languageModel_baseModelName :: Lens' LanguageModel (Maybe BaseModelName)
languageModel_createTime :: Lens' LanguageModel (Maybe UTCTime)
languageModel_failureReason :: Lens' LanguageModel (Maybe Text)
languageModel_inputDataConfig :: Lens' LanguageModel (Maybe InputDataConfig)
languageModel_languageCode :: Lens' LanguageModel (Maybe CLMLanguageCode)
languageModel_lastModifiedTime :: Lens' LanguageModel (Maybe UTCTime)
languageModel_modelName :: Lens' LanguageModel (Maybe Text)
languageModel_modelStatus :: Lens' LanguageModel (Maybe ModelStatus)
languageModel_upgradeAvailability :: Lens' LanguageModel (Maybe Bool)

Documentation

data LanguageModel Source #

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, its language, its processing state, and if there is an upgrade available for the base model.

See: newLanguageModel smart constructor.

Constructors

LanguageModel'

Fields

baseModelName :: Maybe BaseModelName
The Amazon Transcribe standard language model, or base model, used to create your custom language model.
createTime :: Maybe POSIX
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.
failureReason :: Maybe Text
If ModelStatus is FAILED, FailureReason contains information about why the custom language model request failed. See also: Common Errors.
inputDataConfig :: Maybe 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.
languageCode :: Maybe CLMLanguageCode
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 U.S. English (en-US) is the only language supported with Amazon Transcribe Medical.
lastModifiedTime :: Maybe POSIX
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.
modelName :: Maybe Text
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.
modelStatus :: Maybe ModelStatus
The status of the specified custom language model. When the status displays as COMPLETED the model is ready for use.
upgradeAvailability :: Maybe Bool
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.

Instances

Instances details

FromJSON LanguageModel Source #
Instance details Defined in Amazonka.Transcribe.Types.LanguageModel Methods parseJSON :: Value -> Parser LanguageModel # parseJSONList :: Value -> Parser [LanguageModel] #
Generic LanguageModel Source #
Instance details Defined in Amazonka.Transcribe.Types.LanguageModel Associated Types type Rep LanguageModel :: Type -> Type # Methods from :: LanguageModel -> Rep LanguageModel x # to :: Rep LanguageModel x -> LanguageModel #
Read LanguageModel Source #
Instance details Defined in Amazonka.Transcribe.Types.LanguageModel Methods readsPrec :: Int -> ReadS LanguageModel # readList :: ReadS [LanguageModel] # readPrec :: ReadPrec LanguageModel # readListPrec :: ReadPrec [LanguageModel] #
Show LanguageModel Source #
Instance details Defined in Amazonka.Transcribe.Types.LanguageModel Methods showsPrec :: Int -> LanguageModel -> ShowS # show :: LanguageModel -> String # showList :: [LanguageModel] -> ShowS #
NFData LanguageModel Source #
Instance details Defined in Amazonka.Transcribe.Types.LanguageModel Methods rnf :: LanguageModel -> () #
Eq LanguageModel Source #
Instance details Defined in Amazonka.Transcribe.Types.LanguageModel Methods (==) :: LanguageModel -> LanguageModel -> Bool # (/=) :: LanguageModel -> LanguageModel -> Bool #
Hashable LanguageModel Source #
Instance details Defined in Amazonka.Transcribe.Types.LanguageModel Methods hashWithSalt :: Int -> LanguageModel -> Int # hash :: LanguageModel -> Int #
type Rep LanguageModel Source #
Instance details Defined in Amazonka.Transcribe.Types.LanguageModel type Rep LanguageModel = D1 ('MetaData "LanguageModel" "Amazonka.Transcribe.Types.LanguageModel" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "LanguageModel'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "baseModelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BaseModelName)) :: S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputDataConfig)))) :: ((S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CLMLanguageCode)) :: S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "modelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "modelStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelStatus)) :: S1 ('MetaSel ('Just "upgradeAvailability") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))))

newLanguageModel :: LanguageModel Source #

Create a value of LanguageModel with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:baseModelName:LanguageModel', languageModel_baseModelName - The Amazon Transcribe standard language model, or base model, used to create your custom language model.

$sel:createTime:LanguageModel', languageModel_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.

$sel:failureReason:LanguageModel', languageModel_failureReason - If ModelStatus is FAILED, FailureReason contains information about why the custom language model request failed. See also: Common Errors.

$sel:inputDataConfig:LanguageModel', languageModel_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.

$sel:languageCode:LanguageModel', languageModel_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 U.S. English (en-US) is the only language supported with Amazon Transcribe Medical.

$sel:lastModifiedTime:LanguageModel', languageModel_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.

$sel:modelName:LanguageModel', languageModel_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 Amazon Web Services account.

$sel:modelStatus:LanguageModel', languageModel_modelStatus - The status of the specified custom language model. When the status displays as COMPLETED the model is ready for use.

$sel:upgradeAvailability:LanguageModel', languageModel_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.

languageModel_baseModelName :: Lens' LanguageModel (Maybe BaseModelName) Source #

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

languageModel_createTime :: Lens' LanguageModel (Maybe UTCTime) Source #

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.

languageModel_failureReason :: Lens' LanguageModel (Maybe Text) Source #

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

languageModel_inputDataConfig :: Lens' LanguageModel (Maybe InputDataConfig) Source #

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.

languageModel_languageCode :: Lens' LanguageModel (Maybe CLMLanguageCode) Source #

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 U.S. English (en-US) is the only language supported with Amazon Transcribe Medical.

languageModel_lastModifiedTime :: Lens' LanguageModel (Maybe UTCTime) Source #

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.

languageModel_modelName :: Lens' LanguageModel (Maybe Text) Source #

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.

languageModel_modelStatus :: Lens' LanguageModel (Maybe ModelStatus) Source #

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

languageModel_upgradeAvailability :: Lens' LanguageModel (Maybe Bool) Source #

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.