QAS. Руководство пользователя

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

Сервис предназначен для поиска ответа на заданный вопрос. Входным значением для сервиса являются данные в текстовом формате. В ответ на входящий запрос сервис возвращает данные в формате 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}	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"}