REST Dictionary API API Reference

Dictionary

The Dictionary API is used to manage SYSTRAN dictionaries.

Authentication

  • In header the access token generated from the authorization-server (ses-console) using OAuth2 Flow Client Credentials or PKCE.
Authorization: Bearer YOUR_ACCESS_TOKEN
  • In header the API Key generated from the authorization-server (ses-console)
Authorization: Key YOUR_API_KEY
  • In querystring the API Key as key parameter
?key=YOUR_API_KEY

Note about the input/output text

  • The input text passed as a URL parameter will be escaped with an equivalent of the javascript 'encodeURIComponent' function.
  • The input text must be encoded in UTF-8.
  • The output text will be encoded in UTF-8.

Language code values

The language codes to be used are the two-letter codes defined by the ISO 639-1:2002, Codes for the representation of names of languages - Part 1: Alpha-2 code standard.

Refer to the column 'ISO 639-1 code' of this list: http://www.loc.gov/standards/iso639-2/php/code_list.php.

In addition to this list, the following codes are used:

Language Code Language
auto Language Detection
tj Tajik (cyrillic script)
zh-Hans Chinese (Simplified)
zh-Hant Chinese (Traditional)
Schemes: https
Version: 1.2.0

Authentication

accessToken

"Bearer access_token" OR "Key api_key"

type
apiKey
name
Authorization
in
header

apiKey

API Key

type
apiKey
name
key
in
query

Paths

Get API version

GET /resources/dictionary/apiVersion

Current version for this API

callback: string
in query

Javascript callback function name for JSONP Support

Successful response

400 Bad Request

Invalid parameters

500 Internal Server Error

Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "version": "1.0.0"
}

Supported languages

GET /resources/dictionary/supportedLanguages

Get supported languages by dictionaries

200 OK

Successful response

type
object
500 Internal Server Error

Internal Error

Response Example (200 OK)
{
  "error": {
    "message": "Internal error",
    "statusCode": 500,
    "info": "object"
  },
  "languages": [
    "en",
    "fr",
    "nl",
    "es"
  ]
}

Lookup

GET /resources/dictionary/lookup

Lookup words from a source language to a target language.

source: string
in query

Language code of the source text

target: string
in query

Language code in which to lookup the source text

input: string[]
in query

Input word (the 'input' parameter can be repeated)

Array values passed as multiple parameters: ?input=aaa&input=bbb

autocomplete: boolean false
in query

With this option, if the input word is not found in the source language, it will be filled in with autocompletion to perform the lookup

Default: false

callback: string
in query

Javascript callback function name for JSONP Support

200 OK

Successful response

type
object
400 Bad Request

Invalid parameters

500 Internal Server Error

Error

Response Example (200 OK)
{
  "warning": "string",
  "error": {
    "message": "Internal error",
    "statusCode": 500,
    "info": "object"
  },
  "outputs": [
    {
      "output": {
        "matches": [
          {
            "auto_complete": false,
            "model_name": "mono-enfr.mod",
            "other_expressions": [
              {
                "context": "",
                "source": "borax dog",
                "target": "borax chez le chien"
              },
              {
                "context": "",
                "source": "lucky dog",
                "target": "veinard"
              },
              {
                "context": "",
                "source": "sea dog",
                "target": "loup de mer"
              },
              {
                "context": "",
                "source": "top dog",
                "target": "grand chef"
              }
            ],
            "source": {
              "inflection": "(pl:dogs)",
              "info": "",
              "lemma": "dog",
              "phonetic": "[dɑɡ]",
              "pos": "noun",
              "term": "dog"
            },
            "targets": [
              {
                "context": "",
                "domain": "",
                "entry_id": 4987,
                "expressions": [
                  {
                    "source": "small dog",
                    "target": "petit chien"
                  },
                  {
                    "source": "treated dogs",
                    "target": "chien traité"
                  },
                  {
                    "source": "large dog",
                    "target": "grand chien"
                  },
                  {
                    "source": "male dog",
                    "target": "chien mâle"
                  }
                ],
                "info": "",
                "invmeanings": [
                  "dog"
                ],
                "lemma": "chien",
                "rank": "95",
                "synonym": "",
                "variant": ""
              },
              {
                "context": "",
                "domain": "",
                "entry_id": 4987,
                "expressions": [],
                "info": "",
                "invmeanings": [
                  "bitch",
                  "dog",
                  "slut"
                ],
                "lemma": "chienne",
                "rank": "1",
                "synonym": "",
                "variant": ""
              }
            ]
          }
        ],
        "sDictSearch": true
      }
    }
  ]
}

Lookup supported languages

GET /resources/dictionary/lookup/supportedLanguages

List of language pairs in which lookup is supported. This list can be limited to a specific source language or target language.

source: string
in query

Language code of the source text

target: string
in query

Language code into which to translate the source text

callback: string
in query

Javascript callback function name for JSONP Support

200 OK

Successful response

type
object
400 Bad Request

Invalid parameters

500 Internal Server Error

Error

Response Example (200 OK)
{
  "error": {
    "message": "Internal error",
    "statusCode": 500,
    "info": "object"
  },
  "languagePairs": [
    {
      "source": "en",
      "target": "fr"
    },
    {
      "source": "en",
      "target": "nl"
    },
    {
      "source": "fr",
      "target": "en"
    },
    {
      "source": "fr",
      "target": "es"
    }
  ]
}

Add dictionary

POST /resources/dictionary/add

Add a new dictionary.

Input with dictionary information

dictionary: object
sourceLang: string
sourcePos: string acr, adj, adv, expr, noun, prep, proper noun, rule, verb

[Acronym, Adjetive, Adverb, Conjunction, Expression, Noun, Preposition, Proper Noun, Rule, Verb]

type: string UD, NORM UD

User Dictionary or Normalization Dictionary

name: string
targetLangs: string
comments: string
Request Example
{
  "dictionary": {
    "sourceLang": "en",
    "sourcePos": "adj",
    "name": "My Dictionary",
    "targetLangs": "fr",
    "comments": "My new dictionary enfr",
    "type": "UD"
  }
}
200 OK

Successful response

type
object
400 Bad Request

Invalid parameters

500 Internal Server Error

Error

Response Example (200 OK)
{
  "error": {
    "message": "Internal error",
    "statusCode": 500,
    "info": "object"
  },
  "added": {
    "id": "string",
    "name": "string",
    "sourceLang": "string",
    "sourcePos": "string",
    "targetLangs": "string",
    "comments": "string",
    "type": "string"
  }
}

Delete dictionary

POST /resources/dictionary/delete

Delete an existing dictionary.

dictionaryId: string
in query

Dictionary Id

200 OK

Successful response

400 Bad Request

Invalid parameters

500 Internal Server Error

Error

Export dictionary

POST /resources/dictionary/export

Export an existing dictionary.

dictionaryId: string
in query

Dictionary Id

200 OK

Successful response

400 Bad Request

Invalid parameters

500 Internal Server Error

Error

Update dictionary

POST /resources/dictionary/update

Update an existing dictionary.

Input with dictionary id

dictionary: object
name: string
sourceLang: string
targetLangs: string
comments: string
dictionaryId: string
in query

Dictionary Id

Request Example
{
  "name": "My Dictionary",
  "sourceLang": "en",
  "targetLangs": "fr,es",
  "comments": "My Dictionary with new settings"
}
200 OK

Successful response

type
object
400 Bad Request

Invalid parameters

500 Internal Server Error

Error

Response Example (200 OK)
{
  "error": {
    "message": "Internal error",
    "statusCode": 500,
    "info": "object"
  },
  "updated": {
    "name": "string",
    "sourceLang": "string",
    "targetLangs": "string",
    "comments": "string"
  }
}

List dictionaries

POST /resources/dictionary/list

List the dictionaries.

Different filters that can be applied to the list functionality (skip/limit/sort/match)

skip: integer
limit: integer
sort: object
nbEntries: integer 1, -1

1/-1 for ascending/descending order on nbEntries field

comments: integer 1, -1

1/-1 for ascending/descending order on comments field

name: integer 1, -1

1/-1 for ascending/descending order on name field

sourceLang: integer 1, -1

1/-1 for ascending/descending order on sourceLang field

targetLangs: integer 1, -1

1/-1 for ascending/descending order on targetLangs field

match: object
inSourceLang: string[]

Match all dictionaries with sourceLang present in a subset of values

string
ninSourceLang: string[]

Match all dictionaries with sourceLang not present in a subset of values

string
inTargetLangs: string[]

Match all dictionaries with targetLang from a subset of values present in targetLangs property

string
regexComments: string

Match all entries with comments containing the specified value

inNbEntries: integer[]

Match all dictionaries with nbEntries present in a subset of values

integer
ninNbEntries: integer[]

Match all dictionaries with nbEntries not present in a subset of values

integer
minNbEntries: integer

Match all entries with nbEntries equal and over specified value

maxNbEntries: integer

Match all entries with nbEntries under and equal specified value

inName: string[]

Match all entries with name present in a subset of values

string
ninName: string[]

Match all entries with name not present in a subset of values

string
regexName: string

Match all entries with name containing the specified value

Request Example
{
  "skip": 1,
  "limit": 3,
  "sort": {
    "nbEntries": 1,
    "comments": -1,
    "name": 1,
    "sourceLang": -1,
    "targetLangs": 1
  },
  "match": {
    "inSourceLang": [
      "en",
      "fr"
    ],
    "ninSourceLang": [
      "nl"
    ],
    "inTargetLangs": [
      "en",
      "fr"
    ],
    "regexComments": "My",
    "inNbEntries": [
      0
    ],
    "ninNbEntries": [
      10
    ],
    "minNbEntries": 0,
    "maxNbEntries": 0,
    "inName": [
      "My Dictionary NORM",
      "My Dictionary 2",
      "My new dictionary enfr 2"
    ],
    "ninName": [
      "Something"
    ],
    "inType": [
      "NORM",
      "UD"
    ],
    "ninType": [
      "UNKNOWN"
    ]
  }
}
200 OK

Successful response

type
object
400 Bad Request

Invalid parameters

500 Internal Server Error

Error

Response Example (200 OK)
{
  "error": {
    "message": "Internal error",
    "statusCode": 500,
    "info": "object"
  },
  "totalNoLimit": 3,
  "dictionaries": [
    {
      "sourceLang": "en",
      "targetLangs": "fr",
      "nbEntries": 0,
      "comments": "My new dictionary enfr 2",
      "name": "My Dictionary 2",
      "type": "UD",
      "id": "5649bb5d5a3227a4df900aa6"
    },
    {
      "sourceLang": "fr",
      "targetLangs": "fr",
      "nbEntries": 0,
      "comments": "My new dictionary NORM",
      "name": "My Dictionary NORM",
      "type": "NORM",
      "id": "fr-5649bb9a5a3227a4df900aa8"
    }
  ]
}

Add entry

POST /resources/dictionary/entry/add

Add a new entry to an existing dictionary.

"Input with dictionary id and entries information. Possible values for "type" : "translation", "dnt" (Do Not Translate) or "norm" For normalization targetLang is not necessary but type is mandatory and must be set to "norm""

entry: object
sourceLang: string
targetLang: string
source: string
target: string
type: string
sourcePos: string
targetPos: string
priority: string
dictionaryId: string
in query

Dictionary Id

Request Example
{
  "entry": {
    "sourceLang": "en",
    "targetLang": "fr",
    "source": "dog",
    "target": "chien",
    "type": "translation",
    "sourcePos": "noun",
    "priority": "9"
  }
}
200 OK

Successful response

type
object
400 Bad Request

Invalid parameters

500 Internal Server Error

Error

Response Example (200 OK)
{
  "error": {
    "message": "Internal error",
    "statusCode": 500,
    "info": "object"
  },
  "entry": {
    "confidence": "60.0000038",
    "pos": "noun",
    "status": "ok",
    "type": "translation",
    "sourceId": "5649e5ec5a3227a4df900ae3",
    "targetId": "5649e5ec5a3227a4df900ae2",
    "targetPos": "noun",
    "source": "dog",
    "target": "chien"
  }
}

Delete entry

POST /resources/dictionary/entry/delete

Delete an entry in an existing dictionary.

Input with dictionary id + entry id (src or tgt) to delete

entry: object
sourceId: string
targetId: string
dictionaryId: string
in query

Dictionary Id

Request Example
{
  "entry": {
    "sourceId": "5649e5ec5a3227a4df900ae3",
    "targetId": "5649e5ec5a3227a4df900ae2"
  }
}
200 OK

Successful response

type
object
400 Bad Request

Invalid parameters

500 Internal Server Error

Error

Response Example (200 OK)
{
  "status": "entry deleted with success"
}

Update entry

POST /resources/dictionary/entry/update

Update an entry in an existing dictionary.

Input with dictionary id + entry id (src or tgt) to delete

sourceId: string
targetId: string
update: object
sourceLang: string
targetLang: string
source: string
target: string
type: string
sourcePos: string
targetPos: string
priority: string
dictionaryId: string
in query

Dictionary Id

Request Example
{
  "sourceId": "5649fad7d335da43344cc9bf",
  "targetId": "5649fad7d335da43344cc9be",
  "update": {
    "sourceLang": "en",
    "targetLang": "fr",
    "source": "bug",
    "target": "insecte",
    "type": "translation",
    "sourcePos": "noun",
    "targetPos": "noun",
    "priority": 3
  }
}
200 OK

Successful response

type
object
400 Bad Request

Invalid parameters

500 Internal Server Error

Error

Response Example (200 OK)
{
  "confidence": "100",
  "source": "bug",
  "sourceId": "5649fb48d335da43344cc9c0",
  "target": "insecte",
  "targetId": "5649fad7d335da43344cc9be"
}

Import entries

POST /resources/dictionary/entry/import

Import entries to an existing dictionary.

dictionaryId: string
in query

Id of the dictionary where to import entries

sourceLang: string
in query

Source lang of the entries to import

inputFile: file
in formData

File with entries to import

200 OK

Successful response

type
object
400 Bad Request

Invalid parameters

500 Internal Server Error

Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "duplicates": 1,
  "inserted": 95,
  "total": 96
}

List entries

POST /resources/dictionary/entry/list

List entries for a specific dictionary.

Different filters that can be applied to the list functionality (skip/limit/sort/match)

skip: integer
limit: integer
sort: object
source: integer 1, -1

1/-1 for ascending/descending order on source field

target: integer 1, -1

1/-1 for ascending/descending order on target field

partOfSpeech: integer 1, -1

1/-1 for ascending/descending order on partOfSpeech field

priority: integer 1, -1

1/-1 for ascending/descending order on priority field

comments: integer 1, -1

1/-1 for ascending/descending order on comments field

sourceConfidence: integer 1, -1

1/-1 for ascending/descending order on sourceConfidence field

targetConfidence: integer 1, -1

1/-1 for ascending/descending order on targetConfidence field

targetLang: integer 1, -1

1/-1 for ascending/descending order on targetLang field

match: object
inSource: string[]

Match all entries with source present in a subset of values

string
ninSource: string[]

Match all entries with source not present in a subset of values

string
regexSource: string

Match all entries with source containing the specified value

inTarget: string[]

Match all entries with target present in a subset of values

string
ninTarget: string[]

Match all entries with target not present in a subset of values

string
regexTarget: string

Match all entries with target containing the specified value

inPartOfSpeech: string[]

Match all entries with part of speech present in a subset of values

string
ninPartOfSpeech: string[]

Match all entries with part of speech not present in a subset of values

string
regexComments: string

Match all entries with comments containing the specified value

inTargetLang: string[]

Match all entries with target lang present in a subset of values

string
ninTargetLang: string[]

Match all entries with target lang not present in a subset of values

string
minPriority: integer

Match all entries with priority equal and over specified value

maxPriority: integer

Match all entries with priority under and equal specified value

inPriority: integer[]

Match all entries with priority present in a subset of values

integer
ninPriority: integer[]

Match all entries with priority not present in a subset of values

integer
minSourceConfidence: integer

Match all entries with source confidence equal and over specified value

maxSourceConfidence: integer

Match all entries with source confidence under and equal specified value

inSourceConfidence: integer[]

Match all entries with sourceConfidence present in a subset of values

integer
ninSourceConfidence: integer[]

Match all entries with sourceConfidence not present in a subset of values

integer
minTargetConfidence: integer

Match all entries with target confidence equal and over specified value

maxTargetConfidence: integer

Match all entries with target confidence under and equal specified value

inTargetConfidence: integer[]

Match all entries with targetConfidence present in a subset of values

integer
ninTargetConfidence: integer[]

Match all entries with targetConfidence not present in a subset of values

integer
dictionaryId: string
in query

Dictionary Id

Request Example
{
  "skip": 0,
  "limit": 3,
  "sort": {
    "targetLang": 1,
    "targetConfidence": 1,
    "sourceConfidence": 1,
    "comments": 1,
    "priority": 1,
    "partOfSpeech": 1,
    "target": 1,
    "source": 1
  },
  "match": {
    "ninTargetConfidence": [
      75
    ],
    "inTargetConfidence": [
      100
    ],
    "maxTargetConfidence": 100,
    "minTargetConfidence": 0,
    "ninSourceConfidence": [
      75
    ],
    "inSourceConfidence": [
      100
    ],
    "maxSourceConfidence": 100,
    "minSourceConfidence": 0,
    "ninPriority": [
      3
    ],
    "inPriority": [
      0,
      10,
      9
    ],
    "maxPriority": 10,
    "minPriority": 0,
    "ninTargetLang": [
      "es"
    ],
    "inTargetLang": [
      "fr"
    ],
    "regexComments": "",
    "ninPartOfSpeech": [
      "adj"
    ],
    "inPartOfSpeech": [
      "noun"
    ],
    "regexTarget": "ba",
    "ninTarget": [
      "train"
    ],
    "inTarget": [
      "bateau"
    ],
    "regexSource": "bo",
    "ninSource": [
      "something"
    ],
    "inSource": [
      "boat"
    ]
  }
}
200 OK

Successful response

type
object
400 Bad Request

Invalid parameters

500 Internal Server Error

Error

Response Example (200 OK)
{
  "entries": [
    {
      "source": "boat",
      "target": "bateau",
      "partOfSpeech": "noun",
      "priority": 9,
      "comments": "",
      "sourceConfidence": 100,
      "targetConfidence": 100,
      "sourceLang": "en",
      "targetLang": "fr",
      "sourceId": "5649f12e5a3227a4df900aee",
      "targetId": "5649f12e5a3227a4df900aed"
    }
  ],
  "totalNoLimit": 1
}

Apply dictionary changes

POST /resources/dictionary/apply

redeploy the profiles attached to the dictionary that changes.

dictId: string
in query

Dictionary Id

type: string UD, NORM UD
in query

User Dictionary or Normalization Dictionary

200 OK

Successful response

400 Bad Request

Invalid parameters

500 Internal Server Error

Error

Schema Definitions

LookupSupportedLanguageResponse: object

error: ErrorResponse

Error at request level

languagePairs: object[]

Array of language pairs

object
source: string

Source language

target: string

Target language

Example
{
  "error": {
    "message": "Internal error",
    "statusCode": 500,
    "info": "object"
  },
  "languagePairs": [
    {
      "source": "en",
      "target": "fr"
    },
    {
      "source": "en",
      "target": "nl"
    },
    {
      "source": "fr",
      "target": "en"
    },
    {
      "source": "fr",
      "target": "es"
    }
  ]
}

SupportedLanguagesResponse: object

error: ErrorResponse

Error at request level

languages: string[]

Array of languages codes

string
Example
{
  "error": {
    "message": "Internal error",
    "statusCode": 500,
    "info": "object"
  },
  "languages": [
    "en",
    "fr",
    "nl",
    "es"
  ]
}

LookupLanguagePair: object

source: string

Source language

target: string

Target language

Example
{
  "source": "string",
  "target": "string"
}

LookupResponse: object

warning: string

Warning at request level

error: ErrorResponse

Error at request level

outputs: object[]

Array of lookup result

object
output: object

Output for a word

autoComplete: boolean
sDictSeach: boolean
matches: object[]
object
auto_complete: boolean
model_name: string
source: object
inflection: string
info: string
lemma: string
phonetic: string
pos: string
term: string
target: object
context: string
domain: string
entry_id: string
expressions: object[]
object
source: string
target: string
invmeanings: string[]
string
lemma: string
rank: string
synonym: string
variant: string
other_expressions: object[]
object
context: string
source: string
target: string
Example
{
  "warning": "string",
  "error": {
    "message": "Internal error",
    "statusCode": 500,
    "info": "object"
  },
  "outputs": [
    {
      "output": {
        "matches": [
          {
            "auto_complete": false,
            "model_name": "mono-enfr.mod",
            "other_expressions": [
              {
                "context": "",
                "source": "borax dog",
                "target": "borax chez le chien"
              },
              {
                "context": "",
                "source": "lucky dog",
                "target": "veinard"
              },
              {
                "context": "",
                "source": "sea dog",
                "target": "loup de mer"
              },
              {
                "context": "",
                "source": "top dog",
                "target": "grand chef"
              }
            ],
            "source": {
              "inflection": "(pl:dogs)",
              "info": "",
              "lemma": "dog",
              "phonetic": "[dɑɡ]",
              "pos": "noun",
              "term": "dog"
            },
            "targets": [
              {
                "context": "",
                "domain": "",
                "entry_id": 4987,
                "expressions": [
                  {
                    "source": "small dog",
                    "target": "petit chien"
                  },
                  {
                    "source": "treated dogs",
                    "target": "chien traité"
                  },
                  {
                    "source": "large dog",
                    "target": "grand chien"
                  },
                  {
                    "source": "male dog",
                    "target": "chien mâle"
                  }
                ],
                "info": "",
                "invmeanings": [
                  "dog"
                ],
                "lemma": "chien",
                "rank": "95",
                "synonym": "",
                "variant": ""
              },
              {
                "context": "",
                "domain": "",
                "entry_id": 4987,
                "expressions": [],
                "info": "",
                "invmeanings": [
                  "bitch",
                  "dog",
                  "slut"
                ],
                "lemma": "chienne",
                "rank": "1",
                "synonym": "",
                "variant": ""
              }
            ]
          }
        ],
        "sDictSearch": true
      }
    }
  ]
}

LookupResults: object

output: object

Output for a word

autoComplete: boolean
sDictSeach: boolean
matches: object[]
object
auto_complete: boolean
model_name: string
source: object
inflection: string
info: string
lemma: string
phonetic: string
pos: string
term: string
target: object
context: string
domain: string
entry_id: string
expressions: object[]
object
source: string
target: string
invmeanings: string[]
string
lemma: string
rank: string
synonym: string
variant: string
other_expressions: object[]
object
context: string
source: string
target: string
Example
{
  "output": {
    "autoComplete": "boolean",
    "sDictSeach": "boolean",
    "matches": [
      {
        "auto_complete": "boolean",
        "model_name": "string",
        "source": {
          "inflection": "string",
          "info": "string",
          "lemma": "string",
          "phonetic": "string",
          "pos": "string",
          "term": "string"
        },
        "target": {
          "context": "string",
          "domain": "string",
          "entry_id": "string",
          "expressions": [
            {
              "source": "string",
              "target": "string"
            }
          ],
          "invmeanings": [
            "string"
          ],
          "lemma": "string",
          "rank": "string",
          "synonym": "string",
          "variant": "string"
        },
        "other_expressions": [
          {
            "context": "string",
            "source": "string",
            "target": "string"
          }
        ]
      }
    ]
  }
}

LookupOutputObject: object

Output for a word

autoComplete: boolean
sDictSeach: boolean
matches: object[]
object
auto_complete: boolean
model_name: string
source: object
inflection: string
info: string
lemma: string
phonetic: string
pos: string
term: string
target: object
context: string
domain: string
entry_id: string
expressions: object[]
object
source: string
target: string
invmeanings: string[]
string
lemma: string
rank: string
synonym: string
variant: string
other_expressions: object[]
object
context: string
source: string
target: string
Example
{
  "autoComplete": "boolean",
  "sDictSeach": "boolean",
  "matches": [
    {
      "auto_complete": "boolean",
      "model_name": "string",
      "source": {
        "inflection": "string",
        "info": "string",
        "lemma": "string",
        "phonetic": "string",
        "pos": "string",
        "term": "string"
      },
      "target": {
        "context": "string",
        "domain": "string",
        "entry_id": "string",
        "expressions": [
          {
            "source": "string",
            "target": "string"
          }
        ],
        "invmeanings": [
          "string"
        ],
        "lemma": "string",
        "rank": "string",
        "synonym": "string",
        "variant": "string"
      },
      "other_expressions": [
        {
          "context": "string",
          "source": "string",
          "target": "string"
        }
      ]
    }
  ]
}

LookupMatchObject: object

auto_complete: boolean
model_name: string
source: object
inflection: string
info: string
lemma: string
phonetic: string
pos: string
term: string
target: object
context: string
domain: string
entry_id: string
expressions: object[]
object
source: string
target: string
invmeanings: string[]
string
lemma: string
rank: string
synonym: string
variant: string
other_expressions: object[]
object
context: string
source: string
target: string
Example
{
  "auto_complete": "boolean",
  "model_name": "string",
  "source": {
    "inflection": "string",
    "info": "string",
    "lemma": "string",
    "phonetic": "string",
    "pos": "string",
    "term": "string"
  },
  "target": {
    "context": "string",
    "domain": "string",
    "entry_id": "string",
    "expressions": [
      {
        "source": "string",
        "target": "string"
      }
    ],
    "invmeanings": [
      "string"
    ],
    "lemma": "string",
    "rank": "string",
    "synonym": "string",
    "variant": "string"
  },
  "other_expressions": [
    {
      "context": "string",
      "source": "string",
      "target": "string"
    }
  ]
}

LookupSourceObject: object

inflection: string
info: string
lemma: string
phonetic: string
pos: string
term: string
Example
{
  "inflection": "string",
  "info": "string",
  "lemma": "string",
  "phonetic": "string",
  "pos": "string",
  "term": "string"
}

LookupTargetObject: object

context: string
domain: string
entry_id: string
expressions: object[]
object
source: string
target: string
invmeanings: string[]
string
lemma: string
rank: string
synonym: string
variant: string
Example
{
  "context": "string",
  "domain": "string",
  "entry_id": "string",
  "expressions": [
    {
      "source": "string",
      "target": "string"
    }
  ],
  "invmeanings": [
    "string"
  ],
  "lemma": "string",
  "rank": "string",
  "synonym": "string",
  "variant": "string"
}

LookupExpressionObject: object

source: string
target: string
Example
{
  "source": "string",
  "target": "string"
}

LookupOtherExpression: object

context: string
source: string
target: string
Example
{
  "context": "string",
  "source": "string",
  "target": "string"
}

DictionaryAddBody: object

dictionary: object
sourceLang: string
sourcePos: string acr, adj, adv, expr, noun, prep, proper noun, rule, verb

[Acronym, Adjetive, Adverb, Conjunction, Expression, Noun, Preposition, Proper Noun, Rule, Verb]

type: string UD, NORM UD

User Dictionary or Normalization Dictionary

name: string
targetLangs: string
comments: string
Example
{
  "dictionary": {
    "sourceLang": "en",
    "sourcePos": "adj",
    "name": "My Dictionary",
    "targetLangs": "fr",
    "comments": "My new dictionary enfr",
    "type": "UD"
  }
}

DictionaryAddInput: object

sourceLang: string
sourcePos: string acr, adj, adv, expr, noun, prep, proper noun, rule, verb

[Acronym, Adjetive, Adverb, Conjunction, Expression, Noun, Preposition, Proper Noun, Rule, Verb]

type: string UD, NORM UD

User Dictionary or Normalization Dictionary

name: string
targetLangs: string
comments: string
Example
{
  "sourceLang": "en",
  "sourcePos": "adj",
  "name": "My Dictionary",
  "targetLangs": "fr",
  "comments": "My new dictionary enfr",
  "type": "UD"
}

DictionaryAddResponse: object

error: ErrorResponse

Error at request level

added: object
id: string
name: string
sourceLang: string
sourcePos: string
targetLangs: string
comments: string
type: string
Example
{
  "error": {
    "message": "Internal error",
    "statusCode": 500,
    "info": "object"
  },
  "added": {
    "id": "string",
    "name": "string",
    "sourceLang": "string",
    "sourcePos": "string",
    "targetLangs": "string",
    "comments": "string",
    "type": "string"
  }
}

DictionaryAddOutput: object

id: string
name: string
sourceLang: string
sourcePos: string
targetLangs: string
comments: string
type: string
Example
{
  "id": "string",
  "name": "string",
  "sourceLang": "string",
  "sourcePos": "string",
  "targetLangs": "string",
  "comments": "string",
  "type": "string"
}

DictionaryUpdateBody: object

dictionary: object
name: string
sourceLang: string
targetLangs: string
comments: string
Example
{
  "name": "My Dictionary",
  "sourceLang": "en",
  "targetLangs": "fr,es",
  "comments": "My Dictionary with new settings"
}

DictionaryUpdateInput: object

name: string
sourceLang: string
targetLangs: string
comments: string
Example
{
  "name": "string",
  "sourceLang": "string",
  "targetLangs": "string",
  "comments": "string"
}

DictionaryUpdateResponse: object

error: ErrorResponse

Error at request level

updated: object
name: string
sourceLang: string
targetLangs: string
comments: string
Example
{
  "error": {
    "message": "Internal error",
    "statusCode": 500,
    "info": "object"
  },
  "updated": {
    "name": "string",
    "sourceLang": "string",
    "targetLangs": "string",
    "comments": "string"
  }
}

DictionaryUpdateOutput: object

name: string
sourceLang: string
targetLangs: string
comments: string
Example
{
  "name": "string",
  "sourceLang": "string",
  "targetLangs": "string",
  "comments": "string"
}

DictionariesListFilters: object

skip: integer
limit: integer
sort: object
nbEntries: integer 1, -1

1/-1 for ascending/descending order on nbEntries field

comments: integer 1, -1

1/-1 for ascending/descending order on comments field

name: integer 1, -1

1/-1 for ascending/descending order on name field

sourceLang: integer 1, -1

1/-1 for ascending/descending order on sourceLang field

targetLangs: integer 1, -1

1/-1 for ascending/descending order on targetLangs field

match: object
inSourceLang: string[]

Match all dictionaries with sourceLang present in a subset of values

string
ninSourceLang: string[]

Match all dictionaries with sourceLang not present in a subset of values

string
inTargetLangs: string[]

Match all dictionaries with targetLang from a subset of values present in targetLangs property

string
regexComments: string

Match all entries with comments containing the specified value

inNbEntries: integer[]

Match all dictionaries with nbEntries present in a subset of values

integer
ninNbEntries: integer[]

Match all dictionaries with nbEntries not present in a subset of values

integer
minNbEntries: integer

Match all entries with nbEntries equal and over specified value

maxNbEntries: integer

Match all entries with nbEntries under and equal specified value

inName: string[]

Match all entries with name present in a subset of values

string
ninName: string[]

Match all entries with name not present in a subset of values

string
regexName: string

Match all entries with name containing the specified value

Example
{
  "skip": 1,
  "limit": 3,
  "sort": {
    "nbEntries": 1,
    "comments": -1,
    "name": 1,
    "sourceLang": -1,
    "targetLangs": 1
  },
  "match": {
    "inSourceLang": [
      "en",
      "fr"
    ],
    "ninSourceLang": [
      "nl"
    ],
    "inTargetLangs": [
      "en",
      "fr"
    ],
    "regexComments": "My",
    "inNbEntries": [
      0
    ],
    "ninNbEntries": [
      10
    ],
    "minNbEntries": 0,
    "maxNbEntries": 0,
    "inName": [
      "My Dictionary NORM",
      "My Dictionary 2",
      "My new dictionary enfr 2"
    ],
    "ninName": [
      "Something"
    ],
    "inType": [
      "NORM",
      "UD"
    ],
    "ninType": [
      "UNKNOWN"
    ]
  }
}

DictionariesListSortFilter: object

nbEntries: integer 1, -1

1/-1 for ascending/descending order on nbEntries field

comments: integer 1, -1

1/-1 for ascending/descending order on comments field

name: integer 1, -1

1/-1 for ascending/descending order on name field

sourceLang: integer 1, -1

1/-1 for ascending/descending order on sourceLang field

targetLangs: integer 1, -1

1/-1 for ascending/descending order on targetLangs field

Example
{
  "nbEntries": 1,
  "comments": -1,
  "name": 1,
  "sourceLang": -1,
  "targetLangs": 1
}

DictionariesListMatchFilter: object

inSourceLang: string[]

Match all dictionaries with sourceLang present in a subset of values

string
ninSourceLang: string[]

Match all dictionaries with sourceLang not present in a subset of values

string
inTargetLangs: string[]

Match all dictionaries with targetLang from a subset of values present in targetLangs property

string
regexComments: string

Match all entries with comments containing the specified value

inNbEntries: integer[]

Match all dictionaries with nbEntries present in a subset of values

integer
ninNbEntries: integer[]

Match all dictionaries with nbEntries not present in a subset of values

integer
minNbEntries: integer

Match all entries with nbEntries equal and over specified value

maxNbEntries: integer

Match all entries with nbEntries under and equal specified value

inName: string[]

Match all entries with name present in a subset of values

string
ninName: string[]

Match all entries with name not present in a subset of values

string
regexName: string

Match all entries with name containing the specified value

Example
{
  "inSourceLang": [
    "en",
    "fr"
  ],
  "ninSourceLang": [
    "nl"
  ],
  "inTargetLangs": [
    "en",
    "fr"
  ],
  "regexComments": "My",
  "inNbEntries": [
    0
  ],
  "ninNbEntries": [
    10
  ],
  "minNbEntries": 0,
  "maxNbEntries": 0,
  "inName": [
    "My Dictionary NORM",
    "My Dictionary 2",
    "My new dictionary enfr 2"
  ],
  "ninName": [
    "Something"
  ],
  "inType": [
    "NORM",
    "UD"
  ],
  "ninType": [
    "UNKNOWN"
  ]
}

DictionariesListResponse: object

error: ErrorResponse

Error at request level

totalNoLimit: integer

Number of dictionaries without skip/limit filter

dictionaries: object[]

List of dictionaries

object
nbEntries: integer
targetLangs: string
sourceLang: string
name: string
comments: string
type: string
id: string
Example
{
  "error": {
    "message": "Internal error",
    "statusCode": 500,
    "info": "object"
  },
  "totalNoLimit": 3,
  "dictionaries": [
    {
      "sourceLang": "en",
      "targetLangs": "fr",
      "nbEntries": 0,
      "comments": "My new dictionary enfr 2",
      "name": "My Dictionary 2",
      "type": "UD",
      "id": "5649bb5d5a3227a4df900aa6"
    },
    {
      "sourceLang": "fr",
      "targetLangs": "fr",
      "nbEntries": 0,
      "comments": "My new dictionary NORM",
      "name": "My Dictionary NORM",
      "type": "NORM",
      "id": "fr-5649bb9a5a3227a4df900aa8"
    }
  ]
}

DictionaryOutput: object

nbEntries: integer
targetLangs: string
sourceLang: string
name: string
comments: string
type: string
id: string
Example
{
  "nbEntries": "integer",
  "targetLangs": "string",
  "sourceLang": "string",
  "name": "string",
  "comments": "string",
  "type": "string",
  "id": "string"
}

DictionariesImportResponse: object

error: ErrorResponse

Error at request level

duplicates: integer

Number of entries that was already present in the dictionary

inserted: integer

Number of entries succesfully inserted

total: integer

Number of entries processed

Example
{
  "duplicates": 1,
  "inserted": 95,
  "total": 96
}

EntryAddBody: object

entry: object
sourceLang: string
targetLang: string
source: string
target: string
type: string
sourcePos: string
targetPos: string
priority: string
Example
{
  "entry": {
    "sourceLang": "en",
    "targetLang": "fr",
    "source": "dog",
    "target": "chien",
    "type": "translation",
    "sourcePos": "noun",
    "priority": "9"
  }
}

EntryAddInput: object

sourceLang: string
targetLang: string
source: string
target: string
type: string
sourcePos: string
targetPos: string
priority: string
Example
{
  "sourceLang": "en",
  "targetLang": "fr",
  "source": "dog",
  "target": "chien",
  "type": "translation",
  "sourcePos": "noun",
  "priority": "9"
}

EntryAddResponse: object

error: ErrorResponse

Error at request level

entry: object
confidence: string
sourceId: string
targetId: string
pos: string
targetPos: string
source: string
target: string
type: string
status: string
Example
{
  "error": {
    "message": "Internal error",
    "statusCode": 500,
    "info": "object"
  },
  "entry": {
    "confidence": "60.0000038",
    "pos": "noun",
    "status": "ok",
    "type": "translation",
    "sourceId": "5649e5ec5a3227a4df900ae3",
    "targetId": "5649e5ec5a3227a4df900ae2",
    "targetPos": "noun",
    "source": "dog",
    "target": "chien"
  }
}

EntryAddOutput: object

confidence: string
sourceId: string
targetId: string
pos: string
targetPos: string
source: string
target: string
type: string
status: string
Example
{
  "confidence": "60.0000038",
  "pos": "noun",
  "status": "ok",
  "type": "translation",
  "sourceId": "5649e5ec5a3227a4df900ae3",
  "targetId": "5649e5ec5a3227a4df900ae2",
  "targetPos": "noun",
  "source": "dog",
  "target": "chien"
}

EntryDeleteBody: object

entry: object
sourceId: string
targetId: string
Example
{
  "entry": {
    "sourceId": "5649e5ec5a3227a4df900ae3",
    "targetId": "5649e5ec5a3227a4df900ae2"
  }
}

EntryDeleteInput: object

sourceId: string
targetId: string
Example
{
  "sourceId": "5649e5ec5a3227a4df900ae3",
  "targetId": "5649e5ec5a3227a4df900ae2"
}

EntryDeleteResponse: object

error: ErrorResponse

Error at request level

status: string
Example
{
  "status": "entry deleted with success"
}

EntryUpdateBody: object

sourceId: string
targetId: string
update: object
sourceLang: string
targetLang: string
source: string
target: string
type: string
sourcePos: string
targetPos: string
priority: string
Example
{
  "sourceId": "5649fad7d335da43344cc9bf",
  "targetId": "5649fad7d335da43344cc9be",
  "update": {
    "sourceLang": "en",
    "targetLang": "fr",
    "source": "bug",
    "target": "insecte",
    "type": "translation",
    "sourcePos": "noun",
    "targetPos": "noun",
    "priority": 3
  }
}

EntryUpdateInput: object

sourceLang: string
targetLang: string
source: string
target: string
type: string
sourcePos: string
targetPos: string
priority: string
Example
{
  "sourceLang": "string",
  "targetLang": "string",
  "source": "string",
  "target": "string",
  "type": "string",
  "sourcePos": "string",
  "targetPos": "string",
  "priority": "string"
}

EntryUpdateResponse: object

error: ErrorResponse

Error at request level

sourceId: string
targetId: string
Example
{
  "confidence": "100",
  "source": "bug",
  "sourceId": "5649fb48d335da43344cc9c0",
  "target": "insecte",
  "targetId": "5649fad7d335da43344cc9be"
}

EntriesListFilters: object

skip: integer
limit: integer
sort: object
source: integer 1, -1

1/-1 for ascending/descending order on source field

target: integer 1, -1

1/-1 for ascending/descending order on target field

partOfSpeech: integer 1, -1

1/-1 for ascending/descending order on partOfSpeech field

priority: integer 1, -1

1/-1 for ascending/descending order on priority field

comments: integer 1, -1

1/-1 for ascending/descending order on comments field

sourceConfidence: integer 1, -1

1/-1 for ascending/descending order on sourceConfidence field

targetConfidence: integer 1, -1

1/-1 for ascending/descending order on targetConfidence field

targetLang: integer 1, -1

1/-1 for ascending/descending order on targetLang field

match: object
inSource: string[]

Match all entries with source present in a subset of values

string
ninSource: string[]

Match all entries with source not present in a subset of values

string
regexSource: string

Match all entries with source containing the specified value

inTarget: string[]

Match all entries with target present in a subset of values

string
ninTarget: string[]

Match all entries with target not present in a subset of values

string
regexTarget: string

Match all entries with target containing the specified value

inPartOfSpeech: string[]

Match all entries with part of speech present in a subset of values

string
ninPartOfSpeech: string[]

Match all entries with part of speech not present in a subset of values

string
regexComments: string

Match all entries with comments containing the specified value

inTargetLang: string[]

Match all entries with target lang present in a subset of values

string
ninTargetLang: string[]

Match all entries with target lang not present in a subset of values

string
minPriority: integer

Match all entries with priority equal and over specified value

maxPriority: integer

Match all entries with priority under and equal specified value

inPriority: integer[]

Match all entries with priority present in a subset of values

integer
ninPriority: integer[]

Match all entries with priority not present in a subset of values

integer
minSourceConfidence: integer

Match all entries with source confidence equal and over specified value

maxSourceConfidence: integer

Match all entries with source confidence under and equal specified value

inSourceConfidence: integer[]

Match all entries with sourceConfidence present in a subset of values

integer
ninSourceConfidence: integer[]

Match all entries with sourceConfidence not present in a subset of values

integer
minTargetConfidence: integer

Match all entries with target confidence equal and over specified value

maxTargetConfidence: integer

Match all entries with target confidence under and equal specified value

inTargetConfidence: integer[]

Match all entries with targetConfidence present in a subset of values

integer
ninTargetConfidence: integer[]

Match all entries with targetConfidence not present in a subset of values

integer
Example
{
  "skip": 0,
  "limit": 3,
  "sort": {
    "targetLang": 1,
    "targetConfidence": 1,
    "sourceConfidence": 1,
    "comments": 1,
    "priority": 1,
    "partOfSpeech": 1,
    "target": 1,
    "source": 1
  },
  "match": {
    "ninTargetConfidence": [
      75
    ],
    "inTargetConfidence": [
      100
    ],
    "maxTargetConfidence": 100,
    "minTargetConfidence": 0,
    "ninSourceConfidence": [
      75
    ],
    "inSourceConfidence": [
      100
    ],
    "maxSourceConfidence": 100,
    "minSourceConfidence": 0,
    "ninPriority": [
      3
    ],
    "inPriority": [
      0,
      10,
      9
    ],
    "maxPriority": 10,
    "minPriority": 0,
    "ninTargetLang": [
      "es"
    ],
    "inTargetLang": [
      "fr"
    ],
    "regexComments": "",
    "ninPartOfSpeech": [
      "adj"
    ],
    "inPartOfSpeech": [
      "noun"
    ],
    "regexTarget": "ba",
    "ninTarget": [
      "train"
    ],
    "inTarget": [
      "bateau"
    ],
    "regexSource": "bo",
    "ninSource": [
      "something"
    ],
    "inSource": [
      "boat"
    ]
  }
}

EntriesListSortFilter: object

source: integer 1, -1

1/-1 for ascending/descending order on source field

target: integer 1, -1

1/-1 for ascending/descending order on target field

partOfSpeech: integer 1, -1

1/-1 for ascending/descending order on partOfSpeech field

priority: integer 1, -1

1/-1 for ascending/descending order on priority field

comments: integer 1, -1

1/-1 for ascending/descending order on comments field

sourceConfidence: integer 1, -1

1/-1 for ascending/descending order on sourceConfidence field

targetConfidence: integer 1, -1

1/-1 for ascending/descending order on targetConfidence field

targetLang: integer 1, -1

1/-1 for ascending/descending order on targetLang field

Example
{
  "targetLang": 1,
  "targetConfidence": 1,
  "sourceConfidence": 1,
  "comments": 1,
  "priority": 1,
  "partOfSpeech": 1,
  "target": 1,
  "source": 1
}

EntriesListMatchFilter: object

inSource: string[]

Match all entries with source present in a subset of values

string
ninSource: string[]

Match all entries with source not present in a subset of values

string
regexSource: string

Match all entries with source containing the specified value

inTarget: string[]

Match all entries with target present in a subset of values

string
ninTarget: string[]

Match all entries with target not present in a subset of values

string
regexTarget: string

Match all entries with target containing the specified value

inPartOfSpeech: string[]

Match all entries with part of speech present in a subset of values

string
ninPartOfSpeech: string[]

Match all entries with part of speech not present in a subset of values

string
regexComments: string

Match all entries with comments containing the specified value

inTargetLang: string[]

Match all entries with target lang present in a subset of values

string
ninTargetLang: string[]

Match all entries with target lang not present in a subset of values

string
minPriority: integer

Match all entries with priority equal and over specified value

maxPriority: integer

Match all entries with priority under and equal specified value

inPriority: integer[]

Match all entries with priority present in a subset of values

integer
ninPriority: integer[]

Match all entries with priority not present in a subset of values

integer
minSourceConfidence: integer

Match all entries with source confidence equal and over specified value

maxSourceConfidence: integer

Match all entries with source confidence under and equal specified value

inSourceConfidence: integer[]

Match all entries with sourceConfidence present in a subset of values

integer
ninSourceConfidence: integer[]

Match all entries with sourceConfidence not present in a subset of values

integer
minTargetConfidence: integer

Match all entries with target confidence equal and over specified value

maxTargetConfidence: integer

Match all entries with target confidence under and equal specified value

inTargetConfidence: integer[]

Match all entries with targetConfidence present in a subset of values

integer
ninTargetConfidence: integer[]

Match all entries with targetConfidence not present in a subset of values

integer
Example
{
  "ninTargetConfidence": [
    75
  ],
  "inTargetConfidence": [
    100
  ],
  "maxTargetConfidence": 100,
  "minTargetConfidence": 0,
  "ninSourceConfidence": [
    75
  ],
  "inSourceConfidence": [
    100
  ],
  "maxSourceConfidence": 100,
  "minSourceConfidence": 0,
  "ninPriority": [
    3
  ],
  "inPriority": [
    0,
    10,
    9
  ],
  "maxPriority": 10,
  "minPriority": 0,
  "ninTargetLang": [
    "es"
  ],
  "inTargetLang": [
    "fr"
  ],
  "regexComments": "",
  "ninPartOfSpeech": [
    "adj"
  ],
  "inPartOfSpeech": [
    "noun"
  ],
  "regexTarget": "ba",
  "ninTarget": [
    "train"
  ],
  "inTarget": [
    "bateau"
  ],
  "regexSource": "bo",
  "ninSource": [
    "something"
  ],
  "inSource": [
    "boat"
  ]
}

EntriesListResponse: object

error: ErrorResponse

Error at request level

totalNoLimit: integer

Number of entries without skip/limit filter

entries: object[]

List of entries

object
source: string
target: string
partOfSpeech: string
priority: integer
comments: string
sourceConfidence: integer
targetConfidence: integer
sourceLang: string
targetLang: string
sourceId: string
targetId: string
Example
{
  "entries": [
    {
      "source": "boat",
      "target": "bateau",
      "partOfSpeech": "noun",
      "priority": 9,
      "comments": "",
      "sourceConfidence": 100,
      "targetConfidence": 100,
      "sourceLang": "en",
      "targetLang": "fr",
      "sourceId": "5649f12e5a3227a4df900aee",
      "targetId": "5649f12e5a3227a4df900aed"
    }
  ],
  "totalNoLimit": 1
}

EntryOutput: object

source: string
target: string
partOfSpeech: string
priority: integer
comments: string
sourceConfidence: integer
targetConfidence: integer
sourceLang: string
targetLang: string
sourceId: string
targetId: string
Example
{
  "source": "string",
  "target": "string",
  "partOfSpeech": "string",
  "priority": "integer",
  "comments": "string",
  "sourceConfidence": "integer",
  "targetConfidence": "integer",
  "sourceLang": "string",
  "targetLang": "string",
  "sourceId": "string",
  "targetId": "string"
}

Profile: object

Profile

id: string

Profile UUID (Universally Unique IDentifier)

private: boolean

Public or private profile

Example
{
  "id": "6b80a3f5-aff2-41ba-a5ce-21603738432e",
  "private": false
}

ApiVersionResponse: object

version: string
Example
{
  "version": "1.0.0"
}

ErrorResponse: object

message: string

Readable description of the error

statusCode: integer
info: object

Additional information about the error

Example
{
  "message": "Internal error",
  "statusCode": 500,
  "info": "object"
}