UPS. Описание API: различия между версиями
Материал из Флора AI
Нет описания правки |
Нет описания правки |
||
| Строка 1: | Строка 1: | ||
===== ''' | ===== '''ElfztОписание часто используемых параметров''' ===== | ||
{| class="wikitable" | {| class="wikitable" | ||
|+ | |+ | ||
!Параметр | !Параметр | ||
!Тип | |||
!Описание | !Описание | ||
|- | |- | ||
|servicetype | |'''<small>servicetype</small>''' | ||
|Тип сервиса. Возможные значения: spr, smc, see, sbs, tts | |<small>запрос</small> | ||
|<small>Тип сервиса. Возможные значения: spr, smc, see, sbs, tts</small> | |||
|- | |||
|'''<small>servertype</small>''' | |||
|<small>запрос</small> | |||
|<small>Тип группы серверов. Возможные значения: trainer (серверы обучения), cluster (рабочие серверы)</small> | |||
|- | |||
|'''<small>model</small>''' | |||
|<small>запрос</small> | |||
|<small>Название модели</small> | |||
|- | |- | ||
| | |'''<small>error</small>''' | ||
| | |<small>ответ</small> | ||
|<small>Флаг ошибки</small> | |||
|- | |- | ||
| | |'''<small>message</small>''' | ||
| | |<small>ответ</small> | ||
|<small>Информационное сообщение</small> | |||
|} | |} | ||
===== '''/lang: методы мультиязычности''' ===== | |||
{| class="wikitable" | |||
!Метод | |||
!Описание | |||
!Входные параметры | |||
!Ответ | |||
!Пояснения | |||
|- | |||
|<small>GET</small><small>/</small> | |||
|<small>Предназначен для вывода информации о переводе элементов интерфейса на текущий язык</small> | |||
|<small>-</small> | |||
|<code><small>{</small></code> | |||
<code><small>"see":"Сущности",</small></code> | |||
<code><small>"smc":"Классификатор",</small></code> | |||
<code><small>...</small></code> | |||
<code><small>}</small></code> | |||
|<small>-</small> | |||
|} | |||
===== '''/server: получение информации о серверах''' ===== | ===== '''/server: получение информации о серверах''' ===== | ||
| Строка 20: | Строка 53: | ||
|+ | |+ | ||
!Метод | !Метод | ||
!Описание | !Описание | ||
!Входные параметры | !Входные параметры | ||
| Строка 26: | Строка 58: | ||
!Пояснения | !Пояснения | ||
|- | |- | ||
|<small>/get/addresses/{servicetype} | |<small>GET</small><small>/get/addresses/{servicetype}</small> | ||
|<small>Предназначен для вывода информации о сервера, обслуживающих данный сервис, а также настроеных параметров обращения к данным серверам</small> | |<small>Предназначен для вывода информации о сервера, обслуживающих данный сервис, а также настроеных параметров обращения к данным серверам</small> | ||
| | | | ||
| Строка 77: | Строка 108: | ||
* <small>'''fail''' - массив сбойных серверов со временем постановки в сбой</small> | * <small>'''fail''' - массив сбойных серверов со временем постановки в сбой</small> | ||
|- | |- | ||
|<small>/get/models/{servicetype}/{servertype} | |<small>GET</small><small>/get/models/{servicetype}/{servertype}</small> | ||
|<small>Предназначен для вывода информации о моделях указанного сервиса на каждом сервере указанного типа</small> | |<small>Предназначен для вывода информации о моделях указанного сервиса на каждом сервере указанного типа</small> | ||
| | | | ||
| Строка 98: | Строка 128: | ||
<code><small>}</small></code> | <code><small>}</small></code> | ||
|<small>Вывод представляет собой массив url серверов, для каждого из которых указан список моделей</small> | |<small>Вывод представляет собой массив url серверов, для каждого из которых указан список моделей</small> | ||
|} | |||
'''/model: методы работы с моделями''' | |||
{| class="wikitable" | |||
!Метод | |||
!Описание | |||
!Входные параметры | |||
!Ответ | |||
!Пояснения | |||
|- | |||
|<small>POST</small><small>/add/{servicetype}/{model}</small> | |||
|<small>Предназначен для создания пустой модели в указанном сервисе.</small><small>Доступно для следующих сервисов: : smc, see, spr.</small> | |||
| | |||
* <small>'''servicetype''' - тип сервиса</small> | |||
* <small>'''model''' - название модели</small> | |||
|<code><small>{</small></code> | |||
<code><small>"error":0,</small></code> | |||
<code><small>"message":"success"</small></code> | |||
<code><small>}</small></code> | |||
|<small>-</small> | |||
|- | |||
|<small>POST</small><small>/apply/{servicetype}/{model}</small> | |||
|<small>Предназначен для применения установленной на рабочих серверах модели. После применения модель становится доступна для штатного режима работы.</small><small>Доступно для следующих сервисов: smc, see, spr.</small> | |||
| | |||
* <small>'''servicetype''' - тип сервиса</small> | |||
* <small>'''model''' - название модели</small> | |||
|<code><small>{</small></code> | |||
<code><small>"error":0,</small></code> | |||
<code><small>"message":"success"</small></code> | |||
<code><small>}</small></code> | |||
|<small>-</small> | |||
|- | |||
|<small>DELETE</small><small>/delete/{servicetype}/{model}</small> | |||
|<small>Полностью удаляет модель из системы и со всех управляемых серверов.</small><small>Доступно для следующих сервисов: : smc, see, spr.</small> | |||
| | |||
* <small>'''servicetype''' - тип сервиса</small> | |||
* <small>'''model''' - название модели</small> | |||
|<code><small>{</small></code> | |||
<code><small>"error":0,</small></code> | |||
<code><small>"message":"success"</small></code> | |||
<code><small>}</small></code> | |||
|<small>-</small> | |||
|} | |} | ||
Версия от 10:58, 9 июня 2023
ElfztОписание часто используемых параметров
| Параметр | Тип | Описание |
|---|---|---|
| servicetype | запрос | Тип сервиса. Возможные значения: spr, smc, see, sbs, tts |
| servertype | запрос | Тип группы серверов. Возможные значения: trainer (серверы обучения), cluster (рабочие серверы) |
| model | запрос | Название модели |
| error | ответ | Флаг ошибки |
| message | ответ | Информационное сообщение |
/lang: методы мультиязычности
| Метод | Описание | Входные параметры | Ответ | Пояснения |
|---|---|---|---|---|
| GET/ | Предназначен для вывода информации о переводе элементов интерфейса на текущий язык | - | {
|
- |
/server: получение информации о серверах
| Метод | Описание | Входные параметры | Ответ | Пояснения |
|---|---|---|---|---|
| GET/get/addresses/{servicetype} | Предназначен для вывода информации о сервера, обслуживающих данный сервис, а также настроеных параметров обращения к данным серверам |
|
{
|
|
| GET/get/models/{servicetype}/{servertype} | Предназначен для вывода информации о моделях указанного сервиса на каждом сервере указанного типа |
|
{
|
Вывод представляет собой массив url серверов, для каждого из которых указан список моделей |
/model: методы работы с моделями
| Метод | Описание | Входные параметры | Ответ | Пояснения |
|---|---|---|---|---|
| POST/add/{servicetype}/{model} | Предназначен для создания пустой модели в указанном сервисе.Доступно для следующих сервисов: : smc, see, spr. |
|
{
|
- |
| POST/apply/{servicetype}/{model} | Предназначен для применения установленной на рабочих серверах модели. После применения модель становится доступна для штатного режима работы.Доступно для следующих сервисов: smc, see, spr. |
|
{
|
- |
| DELETE/delete/{servicetype}/{model} | Полностью удаляет модель из системы и со всех управляемых серверов.Доступно для следующих сервисов: : smc, see, spr. |
|
{
|
- |