diff --git a/README.md b/README.md index 126eb9e..4a5bfd0 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ ## 🚀 快速开始 ### 1. 准备工作 + - **Ollama**: 确保 Ollama 服务已启动,并已拉取以下模型: - LLM: `deepseek-v3.2:cloud` (或自定义) - Embedding: `bge-m3` @@ -13,6 +14,7 @@ ### 2. 本地运行 #### 方式 A: 使用标准 pip (推荐) + ```bash # 1. 创建并激活虚拟环境 python3 -m venv .venv @@ -26,6 +28,7 @@ python3 -m uvicorn app.main:app --host 0.0.0.0 --port 9600 --reload ``` #### 方式 B: 使用 uv (极速) + ```bash # 1. 初始化项目 uv venv @@ -37,10 +40,12 @@ uv pip install -r requirements.txt # 3. 启动服务 python3 -m uvicorn app.main:app --host 0.0.0.0 --port 9600 --reload ``` -服务地址: http://localhost:9600 -API 文档: http://localhost:9600/docs + +服务地址: +API 文档: ### 3. Docker 运行 + ```bash docker build -t lightrag-api . docker run -p 9600:9600 --env-file .env lightrag-api @@ -56,11 +61,19 @@ docker run -p 9600:9600 --env-file .env lightrag-api | `/docs/{id}` | DELETE | 删除文档 | 根据 ID 删除文档及关联图谱数据 | **检索模式 (Mode) 说明**: + - `hybrid` (推荐): 混合检索,同时利用向量相似度(事实)和知识图谱(关系)。 - `naive`: 纯向量检索,速度快但缺乏深度关联。 - `local`: 侧重于实体细节的图谱检索。 - `global`: 侧重于宏观关系的图谱总结。 +**租户管理**: + +```bash +curl -H "X-Tenant-ID: " http://localhost:9600/xxx +# 租户ID 默认值: default +``` + ## 🛠️ 项目结构 ```text @@ -81,7 +94,7 @@ docker run -p 9600:9600 --env-file .env lightrag-api ## ⚠️ 注意事项 -1. **中文优化**: 已内置针对中文优化的 Prompt,移除了原版对 `{language}` 变量的强依赖,支持中英混合查询自动识别。 -2. **写锁机制**: 当前底层使用文件存储 (NanoVectorDB + NetworkX),**不支持多进程并发写入**。 -3. **编辑逻辑**: RAG 的“编辑”操作本质是“删除旧文档 -> 重新摄入新文档”。直接修改文本块会导致图谱关系错乱。 -4. **初始化**: 首次启动或摄入大量数据时,需要构建图谱索引,CPU 占用较高,请耐心等待。 +1. **中文优化**: 已内置针对中文优化的 Prompt,移除了原版对 `{language}` 变量的强依赖,支持中英混合查询自动识别。 +2. **写锁机制**: 当前底层使用文件存储 (NanoVectorDB + NetworkX),**不支持多进程并发写入**。 +3. **编辑逻辑**: RAG 的“编辑”操作本质是“删除旧文档 -> 重新摄入新文档”。直接修改文本块会导致图谱关系错乱。 +4. **初始化**: 首次启动或摄入大量数据时,需要构建图谱索引,CPU 占用较高,请耐心等待。