UPS. Описание API

Описание часто используемых параметров

Параметр	Тип	Описание
servicetype	запрос	Тип сервиса. Возможные значения: spr, smc, see, sbs, tts
servertype	запрос	Тип группы серверов. Возможные значения: trainer (серверы обучения), cluster (рабочие серверы)
model	запрос	Название модели
modeltype	запрос	Тип модели. Возможные значения: future - планируемая/черновик, current - текущая/рабочая, previous - архивная.
error	ответ	Флаг ошибки
message	ответ	Информационное сообщение

/lang: методы мультиязычности

Метод	Описание	Входные параметры	Ответ	Пояснения
GET /	Предназначен для вывода информации о переводе элементов интерфейса на текущий язык	-	{ "see":"Сущности", "smc":"Классификатор", ... }	-

/server: получение информации о серверах

Метод	Описание	Входные параметры	Ответ	Пояснения
GET /get/addresses/{servicetype}	Предназначен для вывода информации о сервера, обслуживающих данный сервис, а также настроеных параметров обращения к данным серверам	servicetype - тип сервиса	{   "trainer": "http://127.0.0.1:6181",   "cluster": [     "http://127.0.0.1:6181"   ],   "timers": {     "connect": 0.5,     "read": 1,     "failed": 600,     "install": 60,     "info": 3   },   "counter": 0,   "current": 0,   "fail": { "http://127.0.0.1:6181":1686295678 } }	trainer - сервер обучения cluster - рабочие серверы connect - время на подключение read - время на ответ failed - время пребывание в сбойных install - время на установку модели info - время на получение информации о модели counter - счетчик запросов current - индекс последнего опрошенного cluster-сервера fail - массив сбойных серверов со временем постановки в сбой
GET /get/models/{servicetype}/{servertype}	Предназначен для вывода информации о моделях указанного сервиса на каждом сервере указанного типа	servicetype - тип сервиса servertype - тип серверов	{   "http://127.0.0.1:6181": [     "model1",     ...     "modelN"   ],   ... }	Вывод представляет собой массив url серверов, для каждого из которых указан список моделей

/model: методы работы с моделями

Метод	Описание	Входные параметры	Ответ	Пояснения
POST /add/{servicetype}/{model}	Предназначен для создания пустой модели в указанном сервисе. Доступно для следующих сервисов: smc, see, spr.	servicetype - тип сервиса model - название модели	{ "error":0, "message":"success" }	-
POST /install/{servicetype}/{model}	Предназначен для установки импортированной или обученной модели на рабочих серверах. Доступно для следующих сервисов: smc, see, spr.	servicetype - тип сервиса model - название модели	{ "error":0, "message":"success" }	-
POST /apply/{servicetype}/{model}	Предназначен для применения установленной на рабочих серверах модели. После применения модель становится доступна для штатного режима работы. Доступно для следующих сервисов: smc, see, spr.	servicetype - тип сервиса model - название модели	{ "error":0, "message":"success" }	-
POST /restore/{servicetype}/{model}	Откат модели. Делает текущую рабочую модель черновиком (future), рабочие серверы после выполнения данного метода продолжают уже с возвращенной моделью. Схематично действия над modeltype в результате выполнения данного метода можно представить так: current -> future previous -> current null -> previous	servicetype - тип сервиса model - название модели	{"error":0, "message":"success" }	-
DELETE /delete/{servicetype}/{model}	Полностью удаляет модель из системы и со всех управляемых серверов. Доступно для следующих сервисов: smc, see, spr.	servicetype - тип сервиса model - название модели	{ "error":0, "message":"success" }	-
GET /errors/{servicetype}/{model}/{modeltype}	Запрос на получение списка ошибок модели после тестирования. Если тестирования не было, то содержит ошибки проверки на обучающем корпусе. Доступен для сервисов see и smc	servicetype - тип сервиса model - название модели modeltype - тип модели	[ [true, predicted, phrase], ... ]	содержит список вложенных списков. В каждом три значения: правильное значение, предсказанное моделью значение и начальные данные (фраза)
GET /export/{servicetype}/{model}/{modeltype}	Экспортирует модель в виде zip-архива	servicetype - тип сервиса model - название модели modeltype - тип модели	файл model.zip, где model - название модели	-
POST /import/{servicetype}/{model}	Импортирует модель в черновик (modeltype=future).	servicetype - тип сервиса model - название модели zip-model - zip с файлами модели	{ "error":0, "message":"success" }	-
GET /info/{servicetype}/{model}	Получение информации о каждом типе (modeltype) указанной модели.	servicetype - тип сервиса model - название модели	{   "previous": null,   "current":  {     "status": "trained",     ...   },   "future": {     "status": "trained",     ...   } }	Итоговый массив содержит переменные типа modeltype, в каждой из который содержится информация о модели, более подробно о которой можно прочитать в руководствах пользователя smc и see.
GET /info/{servicetype}	Получение информации о всех моделях указанного сервиса. Аналогичен методу GET /info/{servicetype}/{model}, но выводит информацию обо всех моделях.	servicetype - тип сервиса	{   "model1": {     "previous": null,     "current": null,     "future": {       "status": "empty",       ...     }   },   ... }	-
GET /log/{servicetype}/{model}/{modeltype}	Выводит лог обучения и тестирования модели. Доступно для следующих сервисов: smc, see.	servicetype - тип сервиса model - название модели modeltype - тип модели	[   "training",   "preparing data",   "tokenizing",   ... ]	-
GET /handler/{servicetype}/{model}	Получение файла-постобработчика из модели типа future.	servicetype - тип сервиса model - название модели	Файл handler.py	более подробно об обработчике см. руководства пользователя smc и see.
POST /handler/{servicetype}/{model}	Отправка файла-постобработчика в указанную модель типа future. Становится активным сразу после успешной отправки.	servicetype - тип сервиса model - название модели handler - файл, содержащий программный код python постобработчика	{"error":0, "message":"success" }	более подробно об обработчике см. руководства пользователя smc и see.
DELETE /handler/{servicetype}/{model}	Удаление постобработчика из модели типа future.	servicetype - тип сервиса model - название модели	{"error":0, "message":"success" }	более подробно об обработчике см. руководства пользователя smc и see.