Данную документацию можно найти по адресу: <IP_HOST>:9010/api/v1/swagger где <IP_HOST> это ip адрес хоста с установленным пакетом ecss-clerk

Таблица full names

Описание: Таблица предназначена для добавления полных имен. После создания имени ему будет присвоен id, необходимый при добавлении алиаса.

Добавление полных имен:

Path: /api/v1/fullNames
Request-type: POST
Content-type: application/json
Требуемые поля в json: name

Запрос:
curl -X POST "<IP_HOST>:9010/api/v1/fullNames" -H "accept: application/json" -H "content-type: application/json" -d "{ \"name\": \"александр\"}"

Ответ:
{
  "data": {
    "attributes": {
      "name": "александр"
    },
    "id": "1592",
    "type": "fullNames"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

CODE

IP_HOST - ip хоста

Удаление полных имен:

Path: /api/v1/fullNames
Request-type: DELETE
Content-type: application/json
Требуемые поля в json: Full Name ID

Пример:

Запрос:
curl -X DELETE "<IP_HOST>:9010/api/v1/fullNames/<Full_Name_ID>" -H "accept: application/json"

CODE

IP_HOST - ip хоста
Full_Name_ID - id присвоенный при создании полного имени

Таблица aliases

Описание: Таблица предназначена для добавления сокращений к полный именам (саша -> александр). Соответственно, fullName это id полного имени полученного из запроса FullNames.
Связка alias => fullName должна быть уникальной, при попытке добавления дублирующийся записи будет возвращена ошибка.

Добавление алиаса:

Path: /api/v1/aliases
Request-type: POST
Content-type: application/json
Требуемые поля в json: alias и fullNameId

Запрос:
curl -x POST "<IP_HOST>:9010/api/v1/aliases" -H "accept: application/json" -H "content-type: application/json; charset=utf-8" -d '{"alias": "слава", \"fullNameId\": \"83\"}'

Ответ:
{
  "data": {
    "attributes": {
      "alias": "слава",
      "default": false
    },
    "id": "6451",
    "relationships": {
      "fullName": {
        "data": {
          "id": "83",
          "type": "fullNames"
        }
      }
    },
    "type": "aliases"
  },
  "included": [
    {
      "attributes": {
        "name": null
      },
      "id": "83",
      "type": "fullNames"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

CODE

IP_HOST - ip хоста;
fullNameId - id полного имени которое ставится в соответствии этому алиасу.

Удаление алиаса:

Path: /api/v1/aliases
Request-type: DELETE
Content-type: application/json
Требуемые поля в json: Alias ID

Пример:

Запрос:
curl -X DELETE "<IP_HOST>:9010api/v1/aliases/<Alias_ID>" -H "accept: application/json"

CODE

IP_HOST - ip хоста;
Alias_ID - id присвоенный при создании алиаса.

Таблица hard_aliases (жесткие алиасы)

Описание: Жесткие алиасы предназначены для корректировки работы инструмента распознавания речи. К примеру, некоторое имя (целиком) может стабильно распознаваться как одна и та же фраза.
Эта таблица призвана решить данную проблему путем добавления фразы и определения для неё имени из телефонной книги.
Пример: На предприятии плохо распознается имя «игорь николаев», результатом распознавания часто является «игорь николай». Для решения этой проблемы нужно добавить запись в таблицу
вида «игорь николай» -> «игорь николаев».
Поле alias должно быть уникальным, иначе при добавлении вернется ошибка.

Добавление

Path: /api/v1/hardAliases
Request-type: POST
Content-type: application/json
Требуемые поля в json: alias и realName

Запрос:
curl -X POST "<IP_HOST>:9010/api/v1/hardAliases" -H "accept: application/json" -H "content-type: application/json" -d '{"alias": "игорь николай", "realName": "игорь николаев"}'

Ответ:
{
  "data": {
    "attributes": {
      "alias": "игорь николай",
      "realName": "игорь николаев"
    },
    "id": "34",
    "type": "hardAliases"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

CODE

IP_HOST - ip хоста.

Удаление

Path: /api/v1/hardAliases
Request-type: DELETE
Content-type: application/json
Требуемые поля в json: Hard_alias_ID

Пример:

Запрос:
curl -X DELETE "<IP_HOST>:9010/api/v1/hardAliases/<Hard_alias_ID>" -H "accept: application/json"

CODE

IP_HOST - ip хоста;
Hard_alias_ID - id hard aliases которого нужно удалить.

Таблица extended_word

Основные поля: word
Описание: Таблица нужна для компиляции модели распознавания речи. Корпус новых слов, которые будут добавлены в модель строятся из двух источников: телефонной книги и данной таблицы.
Если по какой-то причине требуется распознавание слов, отсутствующих в телефонной книге, то вам поможет эта таблица.

Добавление

Path: /api/v1/words
Request-type: POST
Content-type: application/json
Требуемые поля в json: words

Пример:

Запрос:
curl -X POST "<IP_HOST>:9010/api/v1/words" -H "accept: application/json" -H "content-type: application/json" -d "{ \"word\": \"элтекс\"}"

Ответ:
{
  "data": {
    "attributes": {
      "word": "элтекс"
    },
    "id": "7",
    "type": "words"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

CODE

IP_HOST - ip хоста;

Удаление

Path: /api/v1/words
Request-type: DELETE
Content-type: application/json
Требуемые поля в json: Word_ID

Пример:

Запрос:
curl -X DELETE "<IP_HOST>:9010/api/v1/words/<Word_ID>" -H "accept: application/json"

CODE

IP_HOST - ip хоста;
Word_ID - id слова которое нужно удалить.