LLM/DocsGPT
1
0
Fork 0
mirror of https://github.com/arc53/DocsGPT.git synced 2025-11-29 16:43:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' into docs-fix

Browse Source
This commit is contained in:
Alex
2023-10-09 16:30:11 +01:00
committed by GitHub
parent 261c674832 cb0e4b6e87
commit a809e72704
23 changed files with 164 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -18,7 +18,7 @@ fetch("http://127.0.0.1:5000/api/answer", {
.then(console.log.bind(console))
```
In response you will get a json document like this one:
In response, you will get a JSON document like this one:
```json
{
@@ -30,7 +30,7 @@ In response you will get a json document like this one:
### /api/docs_check
It will make sure documentation is loaded on a server (just run it every time user is switching between libraries (documentations)).
It's a POST request that sends a JSON in body with 1 value. Here is a JavaScript fetch example:
It's a POST request that sends a JSON in a body with 1 value. Here is a JavaScript fetch example:
```js
// answer (POST http://127.0.0.1:5000/api/docs_check)
@@ -45,7 +45,7 @@ fetch("http://127.0.0.1:5000/api/docs_check", {
.then(console.log.bind(console))
```
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"
@@ -54,17 +54,17 @@ In response you will get a json document like this one:
### /api/combine
Provides json that tells UI which vectors are available and where they are located with a simple get request.
Provides JSON that tells UI which vectors are available and where they are located with a simple get request.
Response will include:
`date`, `description`, `docLink`, `fullName`, `language`, `location` (local or docshub), `model`, `name`, `version`.
Example of json in Docshub and local:
Example of JSON in Docshub and local:
<img width="295" alt="image" src="https://user-images.githubusercontent.com/15183589/224714085-f09f51a4-7a9a-4efb-bd39-798029bb4273.png">
### /api/upload
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 task's progress
HTML example:
```html