Действия

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

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

Нет описания правки
Нет описания правки
Строка 16: Строка 16:




===== '''Получение информации о серверах''' =====
===== '''/server: получение информации о серверах''' =====
{| class="wikitable"
{| class="wikitable"
|+
|+
Строка 24: Строка 24:
!Входные параметры
!Входные параметры
!Ответ
!Ответ
!Пояснения
|-
|-
|/server/get/addresses/{servicetype}
|<small>/get/addresses/{servicetype}</small>
|GET
|<small>GET</small>
|Предназначен для вывода информации о сервера, обслуживающих данный сервис, а также настроеных параметров обращения к данным серверам
|<small>Предназначен для вывода информации о сервера, обслуживающих данный сервис, а также настроеных параметров обращения к данным серверам</small>
|'''servicetype''' - тип сервиса
|
* <small>'''servicetype''' - тип сервиса</small>
|<code><small>{</small></code>  
|<code><small>{</small></code>  
<code><small>  "trainer": "<nowiki>http://127.0.0.1:6181</nowiki>",</small></code>
<code><small>  "trainer": "<nowiki>http://127.0.0.1:6181</nowiki>",</small></code>
Строка 56: Строка 58:
<code><small>  "current": 0,</small></code>
<code><small>  "current": 0,</small></code>


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


<code><small>}</small></code>
<code><small>}</small></code>
|-
|/sbs/analyze/{id}
|POST
|Получение аналитических метаданных из голосового фрагмента
|
*'''id''' - идентификатор модели.
*'''wav''' - файл для анализа
|Вернется массив с метаданными голосового фрагмента. Пример:
<code>{</code> <code>age: {</code> <code>class: 20-29,</code> <code>confidence: 0.99</code> <code>},</code> <code>emotion: {</code> <code>class: SADNESS,</code> <code>confidence: 0.99</code> <code>},</code> <code>gender: {</code> <code>class: FEMALE,</code> <code>confidence: 0.99</code> <code>}</code> <code>}</code>


*'''age''' - возраст
<code><small>}</small></code>
**00-05
**06-12
**13-19
**20-29
**30-39
**40-49
**50-59
**60+
*'''emotion''' - эмоция
**ANGER
**BORE
**DISAPPOINTMENT
**DISGUST
**EXCITEMENT
**FEAR
**NEUTRAL
**PAIN
**PLEASURE
**SADNESS
**SUPRISE
*'''gender''' - пол
**MALE
**FEMALE
|-
|/sbs/embedding/{id}
|POST
|Получение оцифрованного представления говорящего
|
|
*'''id''' - идентификатор модели.
* <small>'''trainer''' - сервер обучения</small>
*'''wav''' - файл для анализа
* <small>'''cluster''' - рабочие серверы</small>
|Пример ответа:
* <small>'''connect''' - время на подключение</small>
<code>{</code> <code>error: 0,</code> <code>embedding: [</code> <code>0.019493144005537033,</code> <code>-0.08348844200372696,</code> <code>...</code> <code>]</code> <code>}</code>
* <small>'''read''' - время на ответ</small>
* <small>'''failed''' - время пребывание в сбойных</small>
* <small>'''install''' - время на установку модели</small>
* <small>'''info''' - время на получение информации о модели</small>
* <small>'''counter''' - счетчик запросов</small>
* <small>'''current''' - индекс последнего опрошенного cluster-сервера</small>
* <small>'''fail''' - массив сбойных серверов со временем постановки в сбой</small>
|-
|-
|/sbs/search/{id}
|<small>/get/models/{servicetype}/{servertype}</small>
|POST
|<small>GET</small>
|Поиск говорящего по базе слепков
|<small>Предназначен для вывода информации о моделях указанного сервиса на каждом сервере указанного типа</small>
|
|
*'''id''' - идентификатор модели.
* <small>'''servicetype''' - тип сервиса</small>
*'''wav''' - файл для анализа
* <small>'''servertype''' - тип серверов</small>
|Пример ответа:
|<code><small>{</small></code>
<code>{</code> <code>error: 0,</code> <code>speaker: Ivan,</code> <code>confidence: 0.79</code> <code>}</code>
<code><small>  "<nowiki>http://127.0.0.1:6181</nowiki>": [</small></code>
|-
 
|/sbs/speaker/{id}/{speaker_id}
<code><small>    "model1",</small></code>
|POST
 
|Добавление слепка в базу.
<code><small>    ...</small></code>
|
 
*'''id''' - идентификатор модели
<code><small>    "modelN"</small></code>
*'''speaker_id''' - идентификатор говорящего
 
*'''wav''' - файл для создания оцифрованного представления говорящего
<code><small>  ],</small></code>
|<code>{ error: INT, message: DESCRIPTION }</code>
|-
|/sbs/speaker/{id}/{speaker_id}
|DELETE
|Удаление слепка из базы
|
*'''id''' - идентификатор модели
*'''speaker_id''' - идентификатор говорящего
|<code>{ error: INT, message: DESCRIPTION }</code>
|-
|/sbs/speakers/{id}
|GET
|Получение списка всех слепков
|'''id''' - идентификатор модели
|<code>[</code> <code>"Kiryl",</code>
<code>"Artem",</code> <code>"vladimir",</code> <code>"Sergey",</code> <code>"vladimir2",</code> <code>"Alla"</code> <code>]</code>
|-
|/sbs/verify/{id}/{speaker_id}
|POST
|Сравнение оцифрованного представления wav-файла cо слепком в базе
|
*'''id''' - идентификатор модели
*'''speaker_id''' - идентификатор говорящего
|<code>{</code>
<code>"error": 0,</code>


<code>"confidence": 0.78</code>
<code><small>  ...</small></code>


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

Версия от 10:35, 9 июня 2023

Описание часто используемых параметров
Параметр Описание
servicetype Тип сервиса. Возможные значения: spr, smc, see, sbs, tts
servertype Тип группы серверов. Возможные значения: trainer (серверы обучения), cluster (рабочие серверы)


/server: получение информации о серверах
Метод Тип Описание Входные параметры Ответ Пояснения
/get/addresses/{servicetype} GET Предназначен для вывода информации о сервера, обслуживающих данный сервис, а также настроеных параметров обращения к данным серверам
  • 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/models/{servicetype}/{servertype} GET Предназначен для вывода информации о моделях указанного сервиса на каждом сервере указанного типа
  • servicetype - тип сервиса
  • servertype - тип серверов
 {

  "http://127.0.0.1:6181": [

    "model1",

    ...

    "modelN"

  ],

  ...

}

Вывод представляет собой массив url серверов, для каждого из которых указан список моделей
Источник — https://wiki.connect2ai.net/index.php?title=UPS._Описание_API&oldid=85