Archives/DocsGPT
2
0
Fork 0
mirror of https://github.com/arc53/DocsGPT synced 2024-11-17 21:26:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update API-docs.md

Browse Source
This commit is contained in:
Dimitri POSTOLOV 2023-09-16 02:18:01 +02:00 committed by GitHub
parent e5c43cfc4b
commit 9303f3b47b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/pages/Developing/API-docs.md
View File

@ -4,7 +4,7 @@ App currently has two main api endpoints:
Its a POST request that sends a JSON in body with 4 values. Here is a JavaScript fetch example Its a POST request that sends a JSON in body with 4 values. Here is a JavaScript fetch example
It will recieve an answer for a user provided question It will recieve an answer for a user provided question
``` ```js
// answer (POST http://127.0.0.1:5000/api/answer) // answer (POST http://127.0.0.1:5000/api/answer)
fetch("http://127.0.0.1:5000/api/answer", { fetch("http://127.0.0.1:5000/api/answer", {
"method": "POST", "method": "POST",
@ -20,7 +20,7 @@ fetch("http://127.0.0.1:5000/api/answer", {
In response you will get a json document like this one: In response you will get a json document like this one:
``` ```json
{ {
"answer": " Hi there! How can I help you?\n", "answer": " Hi there! How can I help you?\n",
"query": "Hi", "query": "Hi",
@ -32,7 +32,7 @@ In response you will get a json document like this one:
It will make sure documentation is loaded on a server (just run it everytime user is switching between libraries (documentations) It will make sure documentation is loaded on a server (just run it everytime user is switching between libraries (documentations)
Its a POST request that sends a JSON in body with 1 value. Here is a JavaScript fetch example Its a POST request that sends a JSON in body with 1 value. Here is a JavaScript fetch example
``` ```js
// answer (POST http://127.0.0.1:5000/api/docs_check) // answer (POST http://127.0.0.1:5000/api/docs_check)
fetch("http://127.0.0.1:5000/api/docs_check", { fetch("http://127.0.0.1:5000/api/docs_check", {
"method": "POST", "method": "POST",
@ -46,7 +46,7 @@ fetch("http://127.0.0.1:5000/api/docs_check", {
``` ```
In response you will get a json document like this one: In response you will get a json document like this one:
``` ```json
{ {
"status": "exists" "status": "exists"
} }
@ -67,7 +67,7 @@ Example of json in Docshub and local:
Uploads file that needs to be trained, response is json with task id, which can be used to check on tasks progress Uploads file that needs to be trained, response is json with task id, which can be used to check on tasks progress
HTML example: HTML example:
``` ```html
<form action="/api/upload" method="post" enctype="multipart/form-data" class="mt-2"> <form action="/api/upload" method="post" enctype="multipart/form-data" class="mt-2">
<input type="file" name="file" class="py-4" id="file-upload"> <input type="file" name="file" class="py-4" id="file-upload">
<input type="text" name="user" value="local" hidden> <input type="text" name="user" value="local" hidden>
@ -81,7 +81,7 @@ HTML example:
``` ```
Response: Response:
``` ```json
{ {
"status": "ok", "status": "ok",
"task_id": "b2684988-9047-428b-bd47-08518679103c" "task_id": "b2684988-9047-428b-bd47-08518679103c"
@ -91,7 +91,7 @@ Response:
### /api/task_status ### /api/task_status
Gets task status (task_id) from /api/upload Gets task status (task_id) from /api/upload
``` ```js
// Task status (Get http://127.0.0.1:5000/api/task_status) // Task status (Get http://127.0.0.1:5000/api/task_status)
fetch("http://localhost:5001/api/task_status?task_id=b2d2a0f4-387c-44fd-a443-e4fe2e7454d1", { fetch("http://localhost:5001/api/task_status?task_id=b2d2a0f4-387c-44fd-a443-e4fe2e7454d1", {
"method": "GET", "method": "GET",
@ -106,7 +106,7 @@ fetch("http://localhost:5001/api/task_status?task_id=b2d2a0f4-387c-44fd-a443-e4f
Responses: Responses:
There are two types of repsonses: There are two types of repsonses:
1. while task it still running, where "current" will show progress from 0 - 100 1. while task it still running, where "current" will show progress from 0 - 100
``` ```json
{ {
"result": { "result": {
"current": 1 "current": 1
@ -116,7 +116,7 @@ There are two types of repsonses:
``` ```
2. When task is completed 2. When task is completed
``` ```json
{ {
"result": { "result": {
"directory": "temp", "directory": "temp",
@ -135,7 +135,7 @@ There are two types of repsonses:
### /api/delete_old ### /api/delete_old
deletes old vecotstores deletes old vecotstores
``` ```js
// Task status (GET http://127.0.0.1:5000/api/docs_check) // Task status (GET http://127.0.0.1:5000/api/docs_check)
fetch("http://localhost:5001/api/task_status?task_id=b2d2a0f4-387c-44fd-a443-e4fe2e7454d1", { fetch("http://localhost:5001/api/task_status?task_id=b2d2a0f4-387c-44fd-a443-e4fe2e7454d1", {
"method": "GET", "method": "GET",
@ -148,6 +148,6 @@ fetch("http://localhost:5001/api/task_status?task_id=b2d2a0f4-387c-44fd-a443-e4f
``` ```
response: response:
``` ```json
{"status": 'ok'} { "status": "ok" }
``` ```