Действия

UPS. Описание API: различия между версиями

Материал из Флора AI

Нет описания правки
Нет описания правки
Строка 17: Строка 17:
|<small>запрос</small>
|<small>запрос</small>
|<small>Название модели</small>
|<small>Название модели</small>
|-
|'''<small>modeltype</small>'''
|<small>запрос</small>
|<small>Тип модели. Возможные значения: '''future''' - планируемая/черновик, '''current''' - текущая/рабочая, '''archive''' - архивная.</small>
|-
|-
|'''<small>error</small>'''
|'''<small>error</small>'''
Строка 38: Строка 42:
|GET
|GET
/
/
|<small>Предназначен для вывода информации о переводе элементов интерфейса на текущий язык</small>
|Предназначен для вывода информации о переводе элементов интерфейса на текущий язык
|<small>-</small>
| -
|<code><small>{</small></code>
|<code>{</code>
<code><small>"see":"Сущности",</small></code>
<code>"see":"Сущности",</code>


<code><small>"smc":"Классификатор",</small></code>
<code>"smc":"Классификатор",</code>


<code><small>...</small></code>
<code>...</code>


<code><small>}</small></code>
<code>}</code>
|<small>-</small>
| -
|}
|}


Строка 61: Строка 65:
!Пояснения
!Пояснения
|-
|-
|<small>GET</small><small>/get/addresses/{servicetype}</small>
|GET
|<small>Предназначен для вывода информации о сервера, обслуживающих данный сервис, а также настроеных параметров обращения к данным серверам</small>
/get/addresses/{servicetype}
|Предназначен для вывода информации о сервера, обслуживающих данный сервис, а также настроеных параметров обращения к данным серверам
|
|
* <small>'''servicetype''' - тип сервиса</small>
* '''servicetype''' - тип сервиса
|<code><small>{</small></code>  
|<code>{</code>  
<code><small>  "trainer": "<nowiki>http://127.0.0.1:6181</nowiki>",</small></code>
<code>  "trainer": "<nowiki>http://127.0.0.1:6181</nowiki>",</code>


<code><small>  "cluster": [</small></code>  
<code>  "cluster": [</code>  


<code><small>    "<nowiki>http://127.0.0.1:6181</nowiki>"</small></code>
<code>    "<nowiki>http://127.0.0.1:6181</nowiki>"</code>


<code><small>  ],</small></code>  
<code>  ],</code>  


<code><small>  "timers": {</small></code>
<code>  "timers": {</code>


<code><small>    "connect": 0.5,</small></code>
<code>    "connect": 0.5,</code>


<code><small>    "read": 1,</small></code>
<code>    "read": 1,</code>


<code><small>    "failed": 600,</small></code>
<code>    "failed": 600,</code>


<code><small>    "install": 60,</small></code>
<code>    "install": 60,</code>


<code><small>    "info": 3</small></code>
<code>    "info": 3</code>


<code><small>  },</small></code>
<code>  },</code>


<code><small>  "counter": 0,</small></code>
<code>  "counter": 0,</code>


<code><small>  "current": 0,</small></code>
<code>  "current": 0,</code>


<code><small>  "fail": {</small></code>
<code>  "fail": {</code>


<small><code>"<nowiki>http://127.0.0.1:6181</nowiki>":1686295678</code></small>
<code>"<nowiki>http://127.0.0.1:6181</nowiki>":1686295678</code>


<code><small>}</small></code>
<code>}</code>


<code><small>}</small></code>
<code>}</code>
|
|
* <small>'''trainer''' - сервер обучения</small>
* '''trainer''' - сервер обучения
* <small>'''cluster''' - рабочие серверы</small>
* '''cluster''' - рабочие серверы
* <small>'''connect''' - время на подключение</small>
* '''connect''' - время на подключение
* <small>'''read''' - время на ответ</small>
* '''read''' - время на ответ
* <small>'''failed''' - время пребывание в сбойных</small>
* '''failed''' - время пребывание в сбойных
* <small>'''install''' - время на установку модели</small>
* '''install''' - время на установку модели
* <small>'''info''' - время на получение информации о модели</small>
* '''info''' - время на получение информации о модели
* <small>'''counter''' - счетчик запросов</small>
* '''counter''' - счетчик запросов
* <small>'''current''' - индекс последнего опрошенного cluster-сервера</small>
* '''current''' - индекс последнего опрошенного cluster-сервера
* <small>'''fail''' - массив сбойных серверов со временем постановки в сбой</small>
* '''fail''' - массив сбойных серверов со временем постановки в сбой
|-
|-
|<small>GET</small><small>/get/models/{servicetype}/{servertype}</small>
|GET
|<small>Предназначен для вывода информации о моделях указанного сервиса на каждом сервере указанного типа</small>
/get/models/{servicetype}/{servertype}
|Предназначен для вывода информации о моделях указанного сервиса на каждом сервере указанного типа
|
|
* <small>'''servicetype''' - тип сервиса</small>
* '''servicetype''' - тип сервиса
* <small>'''servertype''' - тип серверов</small>
* '''servertype''' - тип серверов
|<code><small>{</small></code>
|<code>{</code>
<code><small>  "<nowiki>http://127.0.0.1:6181</nowiki>": [</small></code>
<code>  "<nowiki>http://127.0.0.1:6181</nowiki>": [</code>


<code><small>    "model1",</small></code>
<code>    "model1",</code>


<code><small>    ...</small></code>
<code>    ...</code>


<code><small>    "modelN"</small></code>
<code>    "modelN"</code>


<code><small>  ],</small></code>
<code>  ],</code>


<code><small>  ...</small></code>
<code>  ...</code>


<code><small>}</small></code>
<code>}</code>
|<small>Вывод представляет собой массив url серверов, для каждого из которых указан список моделей</small>
|Вывод представляет собой массив url серверов, для каждого из которых указан список моделей
|}
|}


Строка 143: Строка 149:
!Пояснения
!Пояснения
|-
|-
|<small>POST</small><small>/add/{servicetype}/{model}</small>
|POST
|<small>Предназначен для создания пустой модели в указанном сервисе.</small><small>Доступно для следующих сервисов: : smc, see, spr.</small>
/add/{servicetype}/{model}
|Предназначен для создания пустой модели в указанном сервисе.
Доступно для следующих сервисов: smc, see, spr.
|
|
* <small>'''servicetype''' - тип сервиса</small>
* '''servicetype''' - тип сервиса
* <small>'''model''' - название модели</small>
* '''model''' - название модели
|<code><small>{</small></code>
|<code>{</code>
<code><small>"error":0,</small></code>
<code>"error":0,</code>


<code><small>"message":"success"</small></code>
<code>"message":"success"</code>


<code><small>}</small></code>
<code>}</code>
|<small>-</small>
| -
|-
|-
|<small>POST</small><small>/apply/{servicetype}/{model}</small>
|POST
|<small>Предназначен для применения установленной на рабочих серверах модели. После применения модель становится доступна для штатного режима работы.</small><small>Доступно для следующих сервисов: smc, see, spr.</small>
/apply/{servicetype}/{model}
|Предназначен для применения установленной на рабочих серверах модели. После применения модель становится доступна для штатного режима работы.
Доступно для следующих сервисов: smc, see, spr.
|
|
* <small>'''servicetype''' - тип сервиса</small>
* '''servicetype''' - тип сервиса
* <small>'''model''' - название модели</small>
* '''model''' - название модели
|<code><small>{</small></code>
|<code>{</code>
<code><small>"error":0,</small></code>
<code>"error":0,</code>


<code><small>"message":"success"</small></code>
<code>"message":"success"</code>


<code><small>}</small></code>
<code>}</code>
|<small>-</small>
| -
|-
|-
|<small>DELETE</small><small>/delete/{servicetype}/{model}</small>
|DELETE
|<small>Полностью удаляет модель из системы и со всех управляемых серверов.</small><small>Доступно для следующих сервисов: : smc, see, spr.</small>
/delete/{servicetype}/{model}
|Полностью удаляет модель из системы и со всех управляемых серверов.
Доступно для следующих сервисов: smc, see, spr.
|
|
* <small>'''servicetype''' - тип сервиса</small>
* '''servicetype''' - тип сервиса
* <small>'''model''' - название модели</small>
* '''model''' - название модели
|<code><small>{</small></code>
|<code>{</code>
<code><small>"error":0,</small></code>
<code>"error":0,</code>


<code><small>"message":"success"</small></code>
<code>"message":"success"</code>


<code><small>}</small></code>
<code>}</code>
|<small>-</small>
| -
|-
|GET
/errors/{servicetype}/{model}/{modeltype}
|Запрос на получение списка ошибок модели после тестирования. Если тестирования не было, то содержит ошибки проверки на обучающем корпусе. Доступен для сервисов see и smc
|
*'''servicetype''' - тип сервиса
* '''model''' - название модели
* '''modeltype''' - тип модели
|<code>[</code>  <code>[true, predicted, phrase],</code>
<code>...</code>
<code>]</code>
|содержит список вложенных списков. В каждом три значения: правильное значение, предсказанное моделью значение и начальные данные (фраза)
|-
|-
|
|

Версия от 11:21, 9 июня 2023

Описание часто используемых параметров
Параметр Тип Описание
servicetype запрос Тип сервиса. Возможные значения: spr, smc, see, sbs, tts
servertype запрос Тип группы серверов. Возможные значения: trainer (серверы обучения), cluster (рабочие серверы)
model запрос Название модели
modeltype запрос Тип модели. Возможные значения: future - планируемая/черновик, current - текущая/рабочая, archive - архивная.
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

/apply/{servicetype}/{model}

Предназначен для применения установленной на рабочих серверах модели. После применения модель становится доступна для штатного режима работы.

Доступно для следующих сервисов: smc, see, spr.

  • 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],

... ]

содержит список вложенных списков. В каждом три значения: правильное значение, предсказанное моделью значение и начальные данные (фраза)
Источник — https://wiki.connect2ai.net/index.php?title=UPS._Описание_API&oldid=90