QAS. Руководство пользователя: различия между версиями
Материал из Флора AI
E.Elagina (обсуждение | вклад) |
E.Elagina (обсуждение | вклад) |
||
| Строка 30: | Строка 30: | ||
* '''title''' - заголовок файла. | * '''title''' - заголовок файла. | ||
* '''category''' - категория документа. | * '''category''' - категория документа. | ||
* '''text | * '''text''' - поле для загрузки файла. | ||
|Пример: | |Пример: | ||
<code>{"error": 0, "message": "success", "id": "92da6b1968616db4e8d3981c62e0f71f"}</code> | <code>{"error": 0, "message": "success", "id": "92da6b1968616db4e8d3981c62e0f71f"}</code> | ||
| Строка 38: | Строка 38: | ||
|Метод генерирует ответ на поставленный вопрос на основе информации из документов | |Метод генерирует ответ на поставленный вопрос на основе информации из документов | ||
| | | | ||
*'''text | *'''text''' - вопрос, по которому нужно отыскать фрагмент в документах. | ||
* '''category''' - категория документа. | * '''category''' - категория документа. | ||
| | | | ||
| Строка 50: | Строка 50: | ||
|Поиск фрагмента (фрагментов) в документах указанной категории по заданному вопросу | |Поиск фрагмента (фрагментов) в документах указанной категории по заданному вопросу | ||
| | | | ||
* '''text | * '''text''' - вопрос, по которому нужно отыскать фрагмент в документах. | ||
* '''category''' - категория документа. | * '''category''' - категория документа. | ||
|На выходе 2 фрагмента из документа указанной категории. Поиск нужного фрагмента осуществляется с помощью векторизации: выбирается ближайшее предложение по вектору из текста, добавляются по 5 фраз до и после фразы-вопроса — это и является результатом работы метода. | |На выходе 2 фрагмента из документа указанной категории. Поиск нужного фрагмента осуществляется с помощью векторизации: выбирается ближайшее предложение по вектору из текста, добавляются по 5 фраз до и после фразы-вопроса — это и является результатом работы метода. | ||
Версия от 11:35, 27 февраля 2024
Общее описание
Сервис предназначен для поиска ответа на заданный вопрос. Входным значением для сервиса являются данные в текстовом формате. В ответ на входящий запрос сервис возвращает данные в формате JSON.
Термины и определения
Question Answering System (QAS) – сервис ответов на вопросы.
Описание методов API
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом QAS. По умолчанию используется порт 6187/tcp.
Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок "accept: application/json"
Ответ сервиса представляет собой JSON-документ в кодировке UTF-8 или двоичный файл. Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6187 будет отображен интерфейс swagger со всеми методами с возможностью их проверки.
| Метод | Тип | Описание | Входные параметры | Ответ |
|---|---|---|---|---|
| /qas/doc | POST | Добавление документа в базу |
|
Пример:
|
| /qas/doc/ask | GET | Метод генерирует ответ на поставленный вопрос на основе информации из документов |
|
|
| /qas/doc/search | GET | Поиск фрагмента (фрагментов) в документах указанной категории по заданному вопросу |
|
На выходе 2 фрагмента из документа указанной категории. Поиск нужного фрагмента осуществляется с помощью векторизации: выбирается ближайшее предложение по вектору из текста, добавляются по 5 фраз до и после фразы-вопроса — это и является результатом работы метода. |
| /qas/doc/{id} | GET | Метод для вывода текста документа | id - идентификатор документа. | На выходе полный текст документа, соответствующий указанному идентификатору. |
| /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"}
|