updated docs
This commit is contained in:
parent
3b37448d5f
commit
9a75b0c6dc
3 changed files with 47 additions and 2 deletions
43
README.md
43
README.md
|
|
@ -278,7 +278,7 @@ A full list of LightRAG init parameters:
|
||||||
| **workspace** | str | Workspace name for data isolation between different LightRAG Instances | |
|
| **workspace** | str | Workspace name for data isolation between different LightRAG Instances | |
|
||||||
| **kv_storage** | `str` | Storage type for documents and text chunks. Supported types: `JsonKVStorage`,`PGKVStorage`,`RedisKVStorage`,`MongoKVStorage` | `JsonKVStorage` |
|
| **kv_storage** | `str` | Storage type for documents and text chunks. Supported types: `JsonKVStorage`,`PGKVStorage`,`RedisKVStorage`,`MongoKVStorage` | `JsonKVStorage` |
|
||||||
| **vector_storage** | `str` | Storage type for embedding vectors. Supported types: `NanoVectorDBStorage`,`PGVectorStorage`,`MilvusVectorDBStorage`,`ChromaVectorDBStorage`,`FaissVectorDBStorage`,`MongoVectorDBStorage`,`QdrantVectorDBStorage` | `NanoVectorDBStorage` |
|
| **vector_storage** | `str` | Storage type for embedding vectors. Supported types: `NanoVectorDBStorage`,`PGVectorStorage`,`MilvusVectorDBStorage`,`ChromaVectorDBStorage`,`FaissVectorDBStorage`,`MongoVectorDBStorage`,`QdrantVectorDBStorage` | `NanoVectorDBStorage` |
|
||||||
| **graph_storage** | `str` | Storage type for graph edges and nodes. Supported types: `NetworkXStorage`,`Neo4JStorage`,`PGGraphStorage`,`AGEStorage` | `NetworkXStorage` |
|
| **graph_storage** | `str` | Storage type for graph edges and nodes. Supported types: `NetworkXStorage`,`Neo4JStorage`,`PGGraphStorage`,`MemgraphStorage`,`TigerGraphStorage` | `NetworkXStorage` |
|
||||||
| **doc_status_storage** | `str` | Storage type for documents process status. Supported types: `JsonDocStatusStorage`,`PGDocStatusStorage`,`MongoDocStatusStorage` | `JsonDocStatusStorage` |
|
| **doc_status_storage** | `str` | Storage type for documents process status. Supported types: `JsonDocStatusStorage`,`PGDocStatusStorage`,`MongoDocStatusStorage` | `JsonDocStatusStorage` |
|
||||||
| **chunk_token_size** | `int` | Maximum token size per chunk when splitting documents | `1200` |
|
| **chunk_token_size** | `int` | Maximum token size per chunk when splitting documents | `1200` |
|
||||||
| **chunk_overlap_token_size** | `int` | Overlap token size between two chunks when splitting documents | `100` |
|
| **chunk_overlap_token_size** | `int` | Overlap token size between two chunks when splitting documents | `100` |
|
||||||
|
|
@ -767,7 +767,8 @@ MongoKVStorage MongoDB
|
||||||
NetworkXStorage NetworkX (default)
|
NetworkXStorage NetworkX (default)
|
||||||
Neo4JStorage Neo4J
|
Neo4JStorage Neo4J
|
||||||
PGGraphStorage PostgreSQL with AGE plugin
|
PGGraphStorage PostgreSQL with AGE plugin
|
||||||
MemgraphStorage. Memgraph
|
MemgraphStorage Memgraph
|
||||||
|
TigerGraphStorage TigerGraph
|
||||||
```
|
```
|
||||||
|
|
||||||
> Testing has shown that Neo4J delivers superior performance in production environments compared to PostgreSQL with AGE plugin.
|
> Testing has shown that Neo4J delivers superior performance in production environments compared to PostgreSQL with AGE plugin.
|
||||||
|
|
@ -916,6 +917,44 @@ async def initialize_rag():
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary> <b>Using TigerGraph for Storage</b> </summary>
|
||||||
|
|
||||||
|
* TigerGraph is a high-performance, distributed graph database with native GSQL query language.
|
||||||
|
* You can run TigerGraph locally using Docker for easy testing:
|
||||||
|
* See: https://www.tigergraph.com/developer/
|
||||||
|
|
||||||
|
```python
|
||||||
|
export TIGERGRAPH_URI="http://localhost:9000"
|
||||||
|
export TIGERGRAPH_USERNAME="tigergraph"
|
||||||
|
export TIGERGRAPH_PASSWORD="tigergraph"
|
||||||
|
export TIGERGRAPH_GRAPH_NAME="lightrag_graph"
|
||||||
|
|
||||||
|
# Setup logger for LightRAG
|
||||||
|
setup_logger("lightrag", level="INFO")
|
||||||
|
|
||||||
|
# When you launch the project, override the default KG: NetworkX
|
||||||
|
# by specifying graph_storage="TigerGraphStorage".
|
||||||
|
|
||||||
|
# Note: Default settings use NetworkX
|
||||||
|
# Initialize LightRAG with TigerGraph implementation.
|
||||||
|
async def initialize_rag():
|
||||||
|
rag = LightRAG(
|
||||||
|
working_dir=WORKING_DIR,
|
||||||
|
llm_model_func=gpt_4o_mini_complete, # Use gpt_4o_mini_complete LLM model
|
||||||
|
graph_storage="TigerGraphStorage", #<-----------override KG default
|
||||||
|
)
|
||||||
|
|
||||||
|
# Initialize database connections
|
||||||
|
await rag.initialize_storages()
|
||||||
|
# Initialize pipeline status for document processing
|
||||||
|
await initialize_pipeline_status()
|
||||||
|
|
||||||
|
return rag
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary> <b>Using MongoDB Storage</b> </summary>
|
<summary> <b>Using MongoDB Storage</b> </summary>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -370,6 +370,11 @@ NEO4J_LIVENESS_CHECK_TIMEOUT=30
|
||||||
NEO4J_KEEP_ALIVE=true
|
NEO4J_KEEP_ALIVE=true
|
||||||
# NEO4J_WORKSPACE=forced_workspace_name
|
# NEO4J_WORKSPACE=forced_workspace_name
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
TIGERGRAPH_URI=https://localhost:9000
|
||||||
|
TIGERGRAPH_USERNAME=tigergraph
|
||||||
|
TIGERGRAPH_PASSWORD=tigergraph
|
||||||
|
|
||||||
### MongoDB Configuration
|
### MongoDB Configuration
|
||||||
MONGO_URI=mongodb://root:root@localhost:27017/
|
MONGO_URI=mongodb://root:root@localhost:27017/
|
||||||
#MONGO_URI=mongodb+srv://xxxx
|
#MONGO_URI=mongodb+srv://xxxx
|
||||||
|
|
|
||||||
|
|
@ -11,6 +11,7 @@ Supported graph storage types include:
|
||||||
- MongoDBStorage
|
- MongoDBStorage
|
||||||
- PGGraphStorage
|
- PGGraphStorage
|
||||||
- MemgraphStorage
|
- MemgraphStorage
|
||||||
|
- TigerGraphStorage
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue