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

Fix spelling

Browse Source
This commit is contained in:
John Bampton
2023-10-02 01:25:23 +10:00
parent 2fea294b13
commit 2c6ab18e41
7 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/pages/Deploying/Quickstart.md
View File

@@ -1,7 +1,7 @@
## Launching Web App
Note: Make sure you have docker installed
1. Open dowload this repository with `git clone https://github.com/arc53/DocsGPT.git`
1. Open download this repository with `git clone https://github.com/arc53/DocsGPT.git`
2. Create .env file in your root directory and set your `OPENAI_API_KEY` with your openai api key
3. Run `docker-compose build && docker-compose up`
4. Navigate to `http://localhost:5173/`

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

@@ -2,7 +2,7 @@ App currently has two main api endpoints:
### /api/answer
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 receive an answer for a user provided question
```js
// answer (POST http://127.0.0.1:5000/api/answer)
@@ -29,7 +29,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 everytime user is switching between libraries (documentations)
It will make sure documentation is loaded on a server (just run it every time 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
```js
@@ -104,7 +104,7 @@ fetch("http://localhost:5001/api/task_status?task_id=b2d2a0f4-387c-44fd-a443-e4f
```
Responses:
There are two types of repsonses:
There are two types of responses:
1. while task it still running, where "current" will show progress from 0 - 100
```json
{

4
docs/pages/Guides/How-to-use-different-LLM.md
View File

@@ -24,9 +24,9 @@ Options:
LLM_NAME (openai, manifest, cohere, Arc53/docsgpt-14b, Arc53/docsgpt-7b-falcon)
EMBEDDINGS_NAME (openai_text-embedding-ada-002, huggingface_sentence-transformers/all-mpnet-base-v2, huggingface_hkunlp/instructor-large, cohere_medium)
Thats it!
That's it!
### Hosting everything locally and privately (for using our optimised open-source models)
If you are working with important data and dont want anything to leave your premises.
Make sure you set SELF_HOSTED_MODEL as true in you .env variable and for your LLM_NAME you can use anything thats on Huggingface
Make sure you set SELF_HOSTED_MODEL as true in you .env variable and for your LLM_NAME you can use anything that's on Huggingface