ElementalInference / Client / create_dictionary

create_dictionary

ElementalInference.Client.create_dictionary(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_dictionary(
    name='string',
    language='eng'|'fra'|'ita'|'deu'|'spa'|'por',
    entries='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • name (string) –

    [REQUIRED]

    A user-friendly name for this dictionary.

  • language (string) –

    [REQUIRED]

    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.

  • entries (string) – The dictionary entries payload. Contains the custom words and phrases for the dictionary. Maximum size is 40,960 characters.

  • tags (dict) –

    Optional tags to associate with the dictionary.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'arn': 'string',
    'id': 'string',
    'language': 'eng'|'fra'|'ita'|'deu'|'spa'|'por',
    'status': 'CREATING'|'AVAILABLE'|'REFERENCED'|'DELETING'|'DELETED',
    'references': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • name (string) –

      The name that you specified in the request.

    • arn (string) –

      The ARN of the dictionary.

    • id (string) –

      A unique ID that Elemental Inference assigns to the dictionary.

    • language (string) –

      The language of the dictionary.

    • status (string) –

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

    • references (list) –

      A list of feed IDs that reference this dictionary.

      • (string) –

    • tags (dict) –

      Any tags that you included when you created the dictionary.

      • (string) –

        • (string) –

Exceptions