Действия

QAS. Руководство пользователя: различия между версиями

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

Строка 40: Строка 40:
* '''id''' - идентификатор модели.
* '''id''' - идентификатор модели.
* '''wav''' - файл для анализа
* '''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''' - возраст
** 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}
|/sbs/embedding/{id}

Версия от 16:53, 26 февраля 2024

Общее описание

Сервис предназначен для поиска ответа на заданный вопрос. Входным значением для сервиса являются данные в текстовом формате. В ответ на входящий запрос сервис возвращает данные в формате JSON.


Термины и определения

Question Answering System (QAS) – сервис ответов на вопросы.


Описание методов API

Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SBS. По умолчанию используется порт 6187/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок "accept: application/json"

Ответ сервиса представляет собой JSON-документ в кодировке UTF-8 или двоичный файл. Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6187 будет отображен интерфейс swagger со всеми методами с возможностью их проверки.

Метод Тип Описание Входные параметры Ответ
/doc/ POST Добавление документа в базу
  • title - заголовок файла.
  • category - категория документа.
  • text file - поле для загрузки файла.
Пример:

{"error": 0, "message": "success", "id": "92da6b1968616db4e8d3981c62e0f71f"}

/sbs/analyze/{id} POST Получение аналитических метаданных из голосового фрагмента
  • id - идентификатор модели.
  • wav - файл для анализа
/sbs/embedding/{id} POST Получение оцифрованного представления говорящего
  • id - идентификатор модели.
  • wav - файл для анализа
Пример ответа:

{ error: 0, embedding: [ 0.019493144005537033, -0.08348844200372696, ... ] }

/qas/doc/search/ GET Поиск фрагмента (фрагментов) в документах указанной категории по заданному вопросу.
  • text for search - вопрос, по которому нужно отыскать фрагмент в документах.
  • category - категория документа.
/sbs/speaker/{id}/{speaker_id} POST Добавление слепка в базу.
  • id - идентификатор модели
  • speaker_id - идентификатор говорящего
  • wav - файл для создания оцифрованного представления говорящего
{ error: INT, message: DESCRIPTION }
/qas/doc/{id} DELETE Удаление документа из базы
  • id - идентификатор документа.
{"error": 0, "message": "success"}
/qas/list/{id} GET Получение списка всех документов - Пример:
[
  {
    "id": "Идентификатор документа",
    "title": "Название документа",
    "category": "Категория документа"
  },
  {
    "id": "Идентификатор документа",
    "title": "Название документа",
    "category": "Категория документа" 

},

......

]

/sbs/verify/{id}/{speaker_id} POST Сравнение оцифрованного представления wav-файла cо слепком в базе
  • id - идентификатор модели
  • speaker_id - идентификатор говорящего
{

"error": 0,

"confidence": 0.78

}