- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateLanguageModelCommand
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
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { TranscribeClient, CreateLanguageModelCommand } from "@aws-sdk/client-transcribe"; // ES Modules import
// const { TranscribeClient, CreateLanguageModelCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import
const client = new TranscribeClient(config);
const input = { // CreateLanguageModelRequest
LanguageCode: "en-US" || "hi-IN" || "es-US" || "en-GB" || "en-AU" || "de-DE" || "ja-JP", // required
BaseModelName: "NarrowBand" || "WideBand", // required
ModelName: "STRING_VALUE", // required
InputDataConfig: { // InputDataConfig
S3Uri: "STRING_VALUE", // required
TuningDataS3Uri: "STRING_VALUE",
DataAccessRoleArn: "STRING_VALUE", // required
},
Tags: [ // TagList
{ // Tag
Key: "STRING_VALUE", // required
Value: "STRING_VALUE", // required
},
],
};
const command = new CreateLanguageModelCommand(input);
const response = await client.send(command);
// { // CreateLanguageModelResponse
// LanguageCode: "en-US" || "hi-IN" || "es-US" || "en-GB" || "en-AU" || "de-DE" || "ja-JP",
// BaseModelName: "NarrowBand" || "WideBand",
// ModelName: "STRING_VALUE",
// InputDataConfig: { // InputDataConfig
// S3Uri: "STRING_VALUE", // required
// TuningDataS3Uri: "STRING_VALUE",
// DataAccessRoleArn: "STRING_VALUE", // required
// },
// ModelStatus: "IN_PROGRESS" || "FAILED" || "COMPLETED",
// };
CreateLanguageModelCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
BaseModelName Required | BaseModelName | undefined | 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 |
InputDataConfig Required | InputDataConfig | undefined | 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 |
LanguageCode Required | CLMLanguageCode | undefined | 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 ( 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 ( |
ModelName Required | string | undefined | 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 |
Tags | Tag[] | undefined | 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 . |
CreateLanguageModelCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
BaseModelName | BaseModelName | undefined | The Amazon Transcribe standard language model, or base model, you specified when creating your custom language model. |
InputDataConfig | InputDataConfig | undefined | Lists your data access role ARN (Amazon Resource Name) and the Amazon S3 locations you provided for your training ( |
LanguageCode | CLMLanguageCode | undefined | The language code you selected for your custom language model. |
ModelName | string | undefined | The name of your custom language model. |
ModelStatus | ModelStatus | undefined | The status of your custom language model. When the status displays as |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
BadRequestException | client | Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as |
ConflictException | client | A resource already exists with this name. Resource names must be unique within an Amazon Web Services account. |
InternalFailureException | server | There was an internal error. Check the error message, correct the issue, and try your request again. |
LimitExceededException | client | You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. |
TranscribeServiceException | Base exception class for all service exceptions from Transcribe service. |