Dictionary Resource

Definition

This is an object representing a text-based dictionary that contains words and phrases. Dictionaries can be used in various mining modules in order to customize their results.

A dictionary object has a file associated with it. The file must be a text file with one entry per line. An example of Dictionary object is provided bellow.

The following mining modules provide the support for dictionaries:

• Lower-Third Recognition
• Speech Recognition

ENDPOINTS

GET /v1/dictionaries/

GET /v1/dictionaries/{DICTIONARY_ID}/

POST /v1/dictionaries/

DELETE /v1/datasets/{DICTIONARY_ID}/

Attributes

Name	Type	Description
id	string	Global identifier to access the actual resource
name	string	Name of the dictionary
language	string	Language of the dictionary. For more information, see below.
time_created	string	Creation time of the dictionary (ISO Time String)
is_public	boolean	Flag indicating whether the dictionary is public or not. For user-uploaded dictionaries it is always false while for dictionaries provided by DeepVA the value is true. Public dictionaries are available to all users and cannot be updated or deleted.

Language

Optionally, a language can be provided for each dictionary. A dictionary in a specific language will be used only for results in the same language during the mining.

The following values are supported for language field:

• any - Represents a dictionary that can be applied to any language (default)
• auto - Indicates that the language of the dictionary should be automatically detected. Initially, the language is set to any immediately after the upload and the language detection is triggered. After DeepVA detects the language, the field is updated to the corresponding language. If the language could not be recognized, the value remains any.
• Any of the supported languages

JSON Example

The following JSON snippet is showing a Dictionary object.

{
    "id": "9538e44c-6f30-40b7-8d7c-73bda1d41a9e",
    "name": "City names",
    "language": "english",
    "time_created": "2020-01-23 09:34:31.422000",
    "is_public": false
}