Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateDictionary

Creates a custom dictionary for improving transcription accuracy. A dictionary contains custom words and phrases that the ASR engine might not recognize, such as brand names, technical terms, or proper nouns. You can reference a dictionary when configuring a smart subtitles output.

Request Syntax


POST /v1/dictionary HTTP/1.1
Content-type: application/json

{
   "entries": "string",
   "language": "string",
   "name": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

entries

The dictionary entries payload. Contains the custom words and phrases for the dictionary. Maximum size is 40,960 characters.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 40960.

Required: No

language

The language of the dictionary entries. Specify the language using an ISO 639-2/T three-letter code. Supported values: eng, fra, ita, deu, spa, por.

Type: String

Valid Values: eng | fra | ita | deu | spa | por

Required: Yes

name

A user-friendly name for this dictionary.

Type: String

Pattern: [a-zA-Z0-9]([a-zA-Z0-9-_]{0,126}[a-zA-Z0-9])?

Required: Yes

tags

Optional tags to associate with the dictionary.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "arn": "string",
   "id": "string",
   "language": "string",
   "name": "string",
   "references": [ "string" ],
   "status": "string",
   "tags": { 
      "string" : "string" 
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

arn

The ARN of the dictionary.

Type: String

id

A unique ID that Elemental Inference assigns to the dictionary.

Type: String

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

Pattern: [a-zA-Z0-9]+

language

The language of the dictionary.

Type: String

Valid Values: eng | fra | ita | deu | spa | por

name

The name that you specified in the request.

Type: String

Pattern: [a-zA-Z0-9]([a-zA-Z0-9-_]{0,126}[a-zA-Z0-9])?

references

A list of feed IDs that reference this dictionary.

Type: Array of strings

Pattern: [a-z0-9]{19}

status

The current status of the dictionary. After creation succeeds, the status will be AVAILABLE.

Type: String

Valid Values: CREATING | AVAILABLE | REFERENCED | DELETING | DELETED

tags

Any tags that you included when you created the dictionary.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request could not be completed due to a conflict.

HTTP Status Code: 409

InternalServerErrorException

An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.

HTTP Status Code: 500

ServiceQuotaExceededException

The request was rejected because it would exceed one or more service quotas for your account. Review your service quotas and either delete unused resources or request a quota increase.

HTTP Status Code: 402

TooManyRequestException

The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.

HTTP Status Code: 400