yangdx commited on
Commit
6b95319
·
1 Parent(s): ba76171

docs: improve organization and clarity of API documentation

Browse files
Files changed (1) hide show
  1. lightrag/api/README.md +14 -13
lightrag/api/README.md CHANGED
@@ -130,7 +130,9 @@ python lightrag.py --port 8080
130
  PORT=7000 python lightrag.py
131
  ```
132
 
133
- #### Storage Types Supported
 
 
134
 
135
  LightRAG uses 4 types of storage for difference purposes:
136
 
@@ -186,12 +188,11 @@ PGDocStatusStorage Postgres
186
  MongoDocStatusStorage MongoDB
187
  ```
188
 
189
- #### How Select Storage Type
190
 
191
- * Bye enviroment variables
192
- * By command line arguments
193
 
194
- #### LightRag Server Options
195
 
196
  | Parameter | Default | Description |
197
  |-----------|---------|-------------|
@@ -365,6 +366,14 @@ curl -X POST "http://localhost:9621/documents/scan" --max-time 1800
365
 
366
  > Ajust max-time according to the estimated index time for all new files.
367
 
 
 
 
 
 
 
 
 
368
  ### Ollama Emulation Endpoints
369
 
370
  #### GET /api/version
@@ -394,14 +403,6 @@ curl -N -X POST http://localhost:9621/api/chat -H "Content-Type: application/jso
394
 
395
  > For more information about Ollama API pls. visit : [Ollama API documentation](https://github.com/ollama/ollama/blob/main/docs/api.md)
396
 
397
- #### DELETE /documents
398
-
399
- Clear all documents from the RAG system.
400
-
401
- ```bash
402
- curl -X DELETE "http://localhost:9621/documents"
403
- ```
404
-
405
  ### Utility Endpoints
406
 
407
  #### GET /health
 
130
  PORT=7000 python lightrag.py
131
  ```
132
 
133
+ > Best practices: you can set your database setting in Config.ini while testing, and you use .env for production.
134
+
135
+ ### Storage Types Supported
136
 
137
  LightRAG uses 4 types of storage for difference purposes:
138
 
 
188
  MongoDocStatusStorage MongoDB
189
  ```
190
 
191
+ ### How Select Storage Implementation
192
 
193
+ You can select storage implementation by enviroment variables or command line arguments. You can not change storage implementation selection after you add documents to LightRAG. Data migration from one storage implementation to anthor is not supported yet. For further information please read the sample env file or config.ini file.
 
194
 
195
+ ### LightRag API Server Comand Line Options
196
 
197
  | Parameter | Default | Description |
198
  |-----------|---------|-------------|
 
366
 
367
  > Ajust max-time according to the estimated index time for all new files.
368
 
369
+ #### DELETE /documents
370
+
371
+ Clear all documents from the RAG system.
372
+
373
+ ```bash
374
+ curl -X DELETE "http://localhost:9621/documents"
375
+ ```
376
+
377
  ### Ollama Emulation Endpoints
378
 
379
  #### GET /api/version
 
403
 
404
  > For more information about Ollama API pls. visit : [Ollama API documentation](https://github.com/ollama/ollama/blob/main/docs/api.md)
405
 
 
 
 
 
 
 
 
 
406
  ### Utility Endpoints
407
 
408
  #### GET /health