libZSservicesZSamazonka-transcribeZSamazonka-transcribe
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Transcribe.CreateLanguageModel

Description

Creates a new custom language model. Use Amazon S3 prefixes to provide the location of your input files. The time it takes to create your model depends on the size of your training data.

Synopsis

Creating a Request

data CreateLanguageModel Source #

See: newCreateLanguageModel smart constructor.

Constructors

CreateLanguageModel' 

Fields

  • tags :: Maybe (NonEmpty Tag)

    Adds one or more tags, each in the form of a key:value pair, to a new language model at the time you create this new model.

  • languageCode :: CLMLanguageCode

    The language of the input text you're using to train your custom language model.

  • baseModelName :: BaseModelName

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

    If you want to use your custom language model to transcribe audio with a sample rate of 16,000 Hz or greater, choose Wideband.

    If you want to use your custom language model to transcribe audio with a sample rate that is less than 16,000 Hz, choose Narrowband.

  • modelName :: Text

    The name you choose for your custom language model when you create it.

  • inputDataConfig :: InputDataConfig

    Contains the data access role and the Amazon S3 prefixes to read the required input files to create a custom language model.

Instances

Instances details
Eq CreateLanguageModel Source # 
Instance details

Defined in Amazonka.Transcribe.CreateLanguageModel

Methods

(==) :: CreateLanguageModel -> CreateLanguageModel -> Bool #

(/=) :: CreateLanguageModel -> CreateLanguageModel -> Bool #

Read CreateLanguageModel Source # 
Instance details

Defined in Amazonka.Transcribe.CreateLanguageModel

Methods

readsPrec :: Int -> ReadS CreateLanguageModel #

readList :: ReadS [CreateLanguageModel] #

readPrec :: ReadPrec CreateLanguageModel #

readListPrec :: ReadPrec [CreateLanguageModel] #

Show CreateLanguageModel Source # 
Instance details

Defined in Amazonka.Transcribe.CreateLanguageModel

Methods

showsPrec :: Int -> CreateLanguageModel -> ShowS #

show :: CreateLanguageModel -> String #

showList :: [CreateLanguageModel] -> ShowS #

Generic CreateLanguageModel Source # 
Instance details

Defined in Amazonka.Transcribe.CreateLanguageModel

Associated Types

type Rep CreateLanguageModel :: Type -> Type #

Methods

from :: CreateLanguageModel -> Rep CreateLanguageModel x #

to :: Rep CreateLanguageModel x -> CreateLanguageModel #

NFData CreateLanguageModel Source # 
Instance details

Defined in Amazonka.Transcribe.CreateLanguageModel

Methods

rnf :: CreateLanguageModel -> () #

Hashable CreateLanguageModel Source # 
Instance details

Defined in Amazonka.Transcribe.CreateLanguageModel

Methods

hashWithSalt :: Int -> CreateLanguageModel -> Int #

hash :: CreateLanguageModel -> Int #

ToJSON CreateLanguageModel Source # 
Instance details

Defined in Amazonka.Transcribe.CreateLanguageModel

Methods

toJSON :: CreateLanguageModel -> Value #

toEncoding :: CreateLanguageModel -> Encoding #

toJSONList :: [CreateLanguageModel] -> Value #

toEncodingList :: [CreateLanguageModel] -> Encoding #

AWSRequest CreateLanguageModel Source # 
Instance details

Defined in Amazonka.Transcribe.CreateLanguageModel

Associated Types

type AWSResponse CreateLanguageModel #

Methods

request :: CreateLanguageModel -> Request CreateLanguageModel #

response :: MonadResource m => Logger -> Service -> Proxy CreateLanguageModel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateLanguageModel))) #

ToHeaders CreateLanguageModel Source # 
Instance details

Defined in Amazonka.Transcribe.CreateLanguageModel

Methods

toHeaders :: CreateLanguageModel -> [Header] #

ToPath CreateLanguageModel Source # 
Instance details

Defined in Amazonka.Transcribe.CreateLanguageModel

Methods

toPath :: CreateLanguageModel -> ByteString #

ToQuery CreateLanguageModel Source # 
Instance details

Defined in Amazonka.Transcribe.CreateLanguageModel

Methods

toQuery :: CreateLanguageModel -> QueryString #

type Rep CreateLanguageModel Source # 
Instance details

Defined in Amazonka.Transcribe.CreateLanguageModel

type Rep CreateLanguageModel = D1 ('MetaData "CreateLanguageModel" "Amazonka.Transcribe.CreateLanguageModel" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "CreateLanguageModel'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CLMLanguageCode)) :*: (S1 ('MetaSel ('Just "baseModelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BaseModelName) :*: (S1 ('MetaSel ('Just "modelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputDataConfig)))))
type AWSResponse CreateLanguageModel Source # 
Instance details

Defined in Amazonka.Transcribe.CreateLanguageModel

type AWSResponse CreateLanguageModel = CreateLanguageModelResponse

newCreateLanguageModel Source #

Arguments

:: CLMLanguageCode

$sel:languageCode:CreateLanguageModel'

-> BaseModelName

$sel:baseModelName:CreateLanguageModel'

-> Text

$sel:modelName:CreateLanguageModel'

-> InputDataConfig

$sel:inputDataConfig:CreateLanguageModel'

-> CreateLanguageModel 

Create a value of CreateLanguageModel 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:tags:CreateLanguageModel', createLanguageModel_tags - Adds one or more tags, each in the form of a key:value pair, to a new language model at the time you create this new model.

$sel:languageCode:CreateLanguageModel', createLanguageModel_languageCode - The language of the input text you're using to train your custom language model.

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

If you want to use your custom language model to transcribe audio with a sample rate of 16,000 Hz or greater, choose Wideband.

If you want to use your custom language model to transcribe audio with a sample rate that is less than 16,000 Hz, choose Narrowband.

$sel:modelName:CreateLanguageModel', createLanguageModel_modelName - The name you choose for your custom language model when you create it.

$sel:inputDataConfig:CreateLanguageModel', createLanguageModel_inputDataConfig - Contains the data access role and the Amazon S3 prefixes to read the required input files to create a custom language model.

Request Lenses

createLanguageModel_tags :: Lens' CreateLanguageModel (Maybe (NonEmpty Tag)) Source #

Adds one or more tags, each in the form of a key:value pair, to a new language model at the time you create this new model.

createLanguageModel_languageCode :: Lens' CreateLanguageModel CLMLanguageCode Source #

The language of the input text you're using to train your custom language model.

createLanguageModel_baseModelName :: Lens' CreateLanguageModel BaseModelName Source #

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

If you want to use your custom language model to transcribe audio with a sample rate of 16,000 Hz or greater, choose Wideband.

If you want to use your custom language model to transcribe audio with a sample rate that is less than 16,000 Hz, choose Narrowband.

createLanguageModel_modelName :: Lens' CreateLanguageModel Text Source #

The name you choose for your custom language model when you create it.

createLanguageModel_inputDataConfig :: Lens' CreateLanguageModel InputDataConfig Source #

Contains the data access role and the Amazon S3 prefixes to read the required input files to create a custom language model.

Destructuring the Response

data CreateLanguageModelResponse Source #

See: newCreateLanguageModelResponse smart constructor.

Constructors

CreateLanguageModelResponse' 

Fields

Instances

Instances details
Eq CreateLanguageModelResponse Source # 
Instance details

Defined in Amazonka.Transcribe.CreateLanguageModel

Methods

(==) :: CreateLanguageModelResponse -> CreateLanguageModelResponse -> Bool #

(/=) :: CreateLanguageModelResponse -> CreateLanguageModelResponse -> Bool #

Read CreateLanguageModelResponse Source # 
Instance details

Defined in Amazonka.Transcribe.CreateLanguageModel

Methods

readsPrec :: Int -> ReadS CreateLanguageModelResponse #

readList :: ReadS [CreateLanguageModelResponse] #

readPrec :: ReadPrec CreateLanguageModelResponse #

readListPrec :: ReadPrec [CreateLanguageModelResponse] #

Show CreateLanguageModelResponse Source # 
Instance details

Defined in Amazonka.Transcribe.CreateLanguageModel

Methods

showsPrec :: Int -> CreateLanguageModelResponse -> ShowS #

show :: CreateLanguageModelResponse -> String #

showList :: [CreateLanguageModelResponse] -> ShowS #

Generic CreateLanguageModelResponse Source # 
Instance details

Defined in Amazonka.Transcribe.CreateLanguageModel

Associated Types

type Rep CreateLanguageModelResponse :: Type -> Type #

Methods

from :: CreateLanguageModelResponse -> Rep CreateLanguageModelResponse x #

to :: Rep CreateLanguageModelResponse x -> CreateLanguageModelResponse #

NFData CreateLanguageModelResponse Source # 
Instance details

Defined in Amazonka.Transcribe.CreateLanguageModel

Methods

rnf :: CreateLanguageModelResponse -> () #

type Rep CreateLanguageModelResponse Source # 
Instance details

Defined in Amazonka.Transcribe.CreateLanguageModel

type Rep CreateLanguageModelResponse = D1 ('MetaData "CreateLanguageModelResponse" "Amazonka.Transcribe.CreateLanguageModel" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "CreateLanguageModelResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CLMLanguageCode)) :*: (S1 ('MetaSel ('Just "modelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputDataConfig)))) :*: (S1 ('MetaSel ('Just "baseModelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BaseModelName)) :*: (S1 ('MetaSel ('Just "modelStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateLanguageModelResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateLanguageModelResponse'

-> CreateLanguageModelResponse 

Create a value of CreateLanguageModelResponse 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:languageCode:CreateLanguageModel', createLanguageModelResponse_languageCode - The language code of the text you've used to create a custom language model.

$sel:modelName:CreateLanguageModel', createLanguageModelResponse_modelName - The name you've chosen for your custom language model.

$sel:inputDataConfig:CreateLanguageModel', createLanguageModelResponse_inputDataConfig - The data access role and Amazon S3 prefixes you've chosen to create your custom language model.

$sel:baseModelName:CreateLanguageModel', createLanguageModelResponse_baseModelName - The Amazon Transcribe standard language model, or base model you've used to create a custom language model.

$sel:modelStatus:CreateLanguageModelResponse', createLanguageModelResponse_modelStatus - The status of the custom language model. When the status is COMPLETED the model is ready to use.

$sel:httpStatus:CreateLanguageModelResponse', createLanguageModelResponse_httpStatus - The response's http status code.

Response Lenses

createLanguageModelResponse_languageCode :: Lens' CreateLanguageModelResponse (Maybe CLMLanguageCode) Source #

The language code of the text you've used to create a custom language model.

createLanguageModelResponse_modelName :: Lens' CreateLanguageModelResponse (Maybe Text) Source #

The name you've chosen for your custom language model.

createLanguageModelResponse_inputDataConfig :: Lens' CreateLanguageModelResponse (Maybe InputDataConfig) Source #

The data access role and Amazon S3 prefixes you've chosen to create your custom language model.

createLanguageModelResponse_baseModelName :: Lens' CreateLanguageModelResponse (Maybe BaseModelName) Source #

The Amazon Transcribe standard language model, or base model you've used to create a custom language model.

createLanguageModelResponse_modelStatus :: Lens' CreateLanguageModelResponse (Maybe ModelStatus) Source #

The status of the custom language model. When the status is COMPLETED the model is ready to use.

createLanguageModelResponse_httpStatus :: Lens' CreateLanguageModelResponse Int Source #

The response's http status code.