Действия

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

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

Строка 24: Строка 24:
!Ответ
!Ответ
|-
|-
|qas/doc
|/qas/doc
|POST
|POST
|Добавление документа в базу
|Добавление документа в базу
Строка 45: Строка 45:


<code>{ "error": 0, "answer": "''ответ на вопрос''"}</code>
<code>{ "error": 0, "answer": "''ответ на вопрос''"}</code>
|-
|/sbs/embedding/{id}
|POST
|Получение оцифрованного представления говорящего
|
* '''id''' - идентификатор модели.
* '''wav''' - файл для анализа
|Пример ответа:
<code>{</code> <code>error: 0,</code> <code>embedding: [</code> <code>0.019493144005537033,</code> <code>-0.08348844200372696,</code> <code>...</code> <code>]</code> <code>}</code>
|-
|-
|/qas/doc/search/
|/qas/doc/search/
Строка 62: Строка 53:
* '''category''' - категория документа.
* '''category''' - категория документа.
|
|
|-
|/sbs/speaker/{id}/{speaker_id}
|POST
|Добавление слепка в базу.
|
* '''id''' - идентификатор модели
* '''speaker_id''' - идентификатор говорящего
* '''wav''' - файл для создания оцифрованного представления говорящего
|<code>{ error: INT, message: DESCRIPTION }</code>
|-
|-
|/qas/doc/{id}
|/qas/doc/{id}
Строка 78: Строка 60:
|<code>{"error": 0, "message": "success"}</code>
|<code>{"error": 0, "message": "success"}</code>
|-
|-
|/qas/list/{id}
|/qas/list/
|GET
|GET
|Получение списка всех документов
|Получение списка всех документов
Строка 99: Строка 81:
<code>]</code>
<code>]</code>
|-
|-
|/sbs/verify/{id}/{speaker_id}
|/qas/reinit
|POST
|GET
|Сравнение оцифрованного представления wav-файла cо слепком в базе
|Метод для обновления базы данных
|
|<nowiki>-</nowiki>
* '''id''' - идентификатор модели
|<code>{"error": 0, "message": "success"}</code>
* '''speaker_id''' - идентификатор говорящего
|<code>{</code>
<code>"error": 0,</code>
 
<code>"confidence": 0.78</code>
 
<code>}</code>
|}
|}

Версия от 17:03, 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 со всеми методами с возможностью их проверки.

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

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

/qas/doc/ask/ GET Метод генерирует ответ на поставленный вопрос на основе информации из документов
  • text for search - вопрос, по которому нужно отыскать фрагмент в документах.
  • category - категория документа.


{ "error": 0, "answer": "ответ на вопрос"}

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

},

......

]

/qas/reinit GET Метод для обновления базы данных - {"error": 0, "message": "success"}
Источник — https://wiki.connect2ai.net/index.php?title=QAS._Руководство_пользователя&oldid=797