| 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.CreateLanguageModel
Description
Creates a new custom language model.
When creating a new custom language model, you must specify:
- If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model
- The location of your training and tuning files (this must be an Amazon S3 URI)
- The language of your model
- A unique name for your model
Synopsis
- data CreateLanguageModel = CreateLanguageModel' {}
- newCreateLanguageModel :: CLMLanguageCode -> BaseModelName -> Text -> InputDataConfig -> CreateLanguageModel
- createLanguageModel_tags :: Lens' CreateLanguageModel (Maybe (NonEmpty Tag))
- createLanguageModel_languageCode :: Lens' CreateLanguageModel CLMLanguageCode
- createLanguageModel_baseModelName :: Lens' CreateLanguageModel BaseModelName
- createLanguageModel_modelName :: Lens' CreateLanguageModel Text
- createLanguageModel_inputDataConfig :: Lens' CreateLanguageModel InputDataConfig
- data CreateLanguageModelResponse = CreateLanguageModelResponse' {}
- newCreateLanguageModelResponse :: Int -> CreateLanguageModelResponse
- createLanguageModelResponse_baseModelName :: Lens' CreateLanguageModelResponse (Maybe BaseModelName)
- createLanguageModelResponse_inputDataConfig :: Lens' CreateLanguageModelResponse (Maybe InputDataConfig)
- createLanguageModelResponse_languageCode :: Lens' CreateLanguageModelResponse (Maybe CLMLanguageCode)
- createLanguageModelResponse_modelName :: Lens' CreateLanguageModelResponse (Maybe Text)
- createLanguageModelResponse_modelStatus :: Lens' CreateLanguageModelResponse (Maybe ModelStatus)
- createLanguageModelResponse_httpStatus :: Lens' CreateLanguageModelResponse Int
Creating a Request
data CreateLanguageModel Source #
See: newCreateLanguageModel smart constructor.
Constructors
| CreateLanguageModel' | |
Fields
| |
Instances
newCreateLanguageModel Source #
Arguments
| :: CLMLanguageCode | |
| -> BaseModelName | |
| -> Text | |
| -> InputDataConfig | |
| -> 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:
CreateLanguageModel, createLanguageModel_tags - Adds one or more custom tags, each in the form of a key:value pair, to a
new custom language model at the time you create this new model.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
CreateLanguageModel, createLanguageModel_languageCode - The language code that represents the language of your 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.
A custom language model can only be used to transcribe files in the same
language as the model. For example, if you create a custom language
model using US English (en-US), you can only apply this model to files
that contain English audio.
CreateLanguageModel, createLanguageModel_baseModelName - The Amazon Transcribe standard language model, or base model, used to
create your custom language model. Amazon Transcribe offers two options
for base models: Wideband and Narrowband.
If the audio you want to transcribe has a sample rate of 16,000 Hz or
greater, choose WideBand. To transcribe audio with a sample rate less
than 16,000 Hz, choose NarrowBand.
CreateLanguageModel, createLanguageModel_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. If you try to create a new custom
language model with the same name as an existing custom language model,
you get a ConflictException error.
CreateLanguageModel, createLanguageModel_inputDataConfig - Contains the Amazon S3 location of the training data you want to use to
create a new custom language model, and permissions to access this
location.
When using InputDataConfig, you must include these sub-parameters:
S3Uri, which is the Amazon S3 location of your training data, and
DataAccessRoleArn, which is the Amazon Resource Name (ARN) of the role
that has permission to access your specified Amazon S3 location. You can
optionally include TuningDataS3Uri, which is the Amazon S3 location of
your tuning data. If you specify different Amazon S3 locations for
training and tuning data, the ARN you use must have permissions to
access both locations.
Request Lenses
createLanguageModel_tags :: Lens' CreateLanguageModel (Maybe (NonEmpty Tag)) Source #
Adds one or more custom tags, each in the form of a key:value pair, to a new custom language model at the time you create this new model.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
createLanguageModel_languageCode :: Lens' CreateLanguageModel CLMLanguageCode Source #
The language code that represents the language of your 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.
A custom language model can only be used to transcribe files in the same
language as the model. For example, if you create a custom language
model using US English (en-US), you can only apply this model to files
that contain English audio.
createLanguageModel_baseModelName :: Lens' CreateLanguageModel BaseModelName Source #
The Amazon Transcribe standard language model, or base model, used to create your custom language model. Amazon Transcribe offers two options for base models: Wideband and Narrowband.
If the audio you want to transcribe has a sample rate of 16,000 Hz or
greater, choose WideBand. To transcribe audio with a sample rate less
than 16,000 Hz, choose NarrowBand.
createLanguageModel_modelName :: Lens' CreateLanguageModel 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. If you try to create a new custom
language model with the same name as an existing custom language model,
you get a ConflictException error.
createLanguageModel_inputDataConfig :: Lens' CreateLanguageModel InputDataConfig Source #
Contains the Amazon S3 location of the training data you want to use to create a new custom language model, and permissions to access this location.
When using InputDataConfig, you must include these sub-parameters:
S3Uri, which is the Amazon S3 location of your training data, and
DataAccessRoleArn, which is the Amazon Resource Name (ARN) of the role
that has permission to access your specified Amazon S3 location. You can
optionally include TuningDataS3Uri, which is the Amazon S3 location of
your tuning data. If you specify different Amazon S3 locations for
training and tuning data, the ARN you use must have permissions to
access both locations.
Destructuring the Response
data CreateLanguageModelResponse Source #
See: newCreateLanguageModelResponse smart constructor.
Constructors
| CreateLanguageModelResponse' | |
Fields
| |
Instances
newCreateLanguageModelResponse Source #
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:
CreateLanguageModel, createLanguageModelResponse_baseModelName - The Amazon Transcribe standard language model, or base model, you
specified when creating your custom language model.
CreateLanguageModel, createLanguageModelResponse_inputDataConfig - Lists your data access role ARN (Amazon Resource Name) and the Amazon S3
locations you provided for your training (S3Uri) and tuning
(TuningDataS3Uri) data.
CreateLanguageModel, createLanguageModelResponse_languageCode - The language code you selected for your custom language model.
CreateLanguageModel, createLanguageModelResponse_modelName - The name of your custom language model.
CreateLanguageModelResponse, createLanguageModelResponse_modelStatus - The status of your custom language model. When the status displays as
COMPLETED, your model is ready to use.
$sel:httpStatus:CreateLanguageModelResponse', createLanguageModelResponse_httpStatus - The response's http status code.
Response Lenses
createLanguageModelResponse_baseModelName :: Lens' CreateLanguageModelResponse (Maybe BaseModelName) Source #
The Amazon Transcribe standard language model, or base model, you specified when creating your custom language model.
createLanguageModelResponse_inputDataConfig :: Lens' CreateLanguageModelResponse (Maybe InputDataConfig) Source #
Lists your data access role ARN (Amazon Resource Name) and the Amazon S3
locations you provided for your training (S3Uri) and tuning
(TuningDataS3Uri) data.
createLanguageModelResponse_languageCode :: Lens' CreateLanguageModelResponse (Maybe CLMLanguageCode) Source #
The language code you selected for your custom language model.
createLanguageModelResponse_modelName :: Lens' CreateLanguageModelResponse (Maybe Text) Source #
The name of your custom language model.
createLanguageModelResponse_modelStatus :: Lens' CreateLanguageModelResponse (Maybe ModelStatus) Source #
The status of your custom language model. When the status displays as
COMPLETED, your model is ready to use.
createLanguageModelResponse_httpStatus :: Lens' CreateLanguageModelResponse Int Source #
The response's http status code.