Fix、Recursive、Vector和Paragraph。图1:LightRAG索引流程图 - 图片说明:来源
图2:LightRAG检索与查询流程图 - 图片说明:来源
[!NOTE] 您也可以使用pip(如果偏好),但推荐使用uv以获得更好的性能和更可靠的依赖管理。
📦 离线部署:对于离线或隔离环境,请参阅离线部署指南以获取预安装所有依赖项和缓存文件的说明。
LightRAG服务器旨在提供Web界面和API支持。Web界面便于文档索引、知识图谱探索和简单的RAG查询界面。LightRAG服务器还提供Ollama兼容接口,旨在将LightRAG模拟为Ollama聊天模型。这使得AI聊天机器人(如Open WebUI)可以轻松访问LightRAG。
### 使用uv安装LightRAG Server作为工具(推荐)
uv tool install "lightrag-hku[api]"
### 或使用pip
# python -m venv .venv
# source .venv/bin/activate # Windows:.venv\Scripts\activate
# pip install "lightrag-hku[api]"
### 构建前端资源
cd lightrag_webui
bun install --frozen-lockfile
bun run build
cd ..
# 设置环境文件
# 通过从GitHub仓库根目录下载或从本地源码副本复制获取env.example文件。
cp env.example .env # 使用您的LLM和嵌入配置更新.env文件
# 启动服务器
lightrag-server
git clone https://github.com/HKUDS/LightRAG.git
cd LightRAG
# 引导开发环境(推荐)
make dev
source .venv/bin/activate # 激活虚拟环境(Linux/macOS)
# Windows系统:.venv\Scripts\activate
# make dev会安装测试工具链以及完整的离线栈(API、存储后端和提供商集成),然后构建前端。
# 启动服务器前运行make env-base或复制env.example到.env。
# 使用uv的等效手动步骤
# 注意:uv sync会在.venv/中自动创建虚拟环境
uv sync --extra test --extra offline
source .venv/bin/activate # 激活虚拟环境(Linux/macOS)
# Windows系统:.venv\Scripts\activate
### 或使用pip与虚拟环境
# python -m venv .venv
# source .venv/bin/activate # Windows:.venv\Scripts\activate
# pip install -e ".[test,offline]"
# 构建前端资源
cd lightrag_webui
bun install --frozen-lockfile
bun run build
cd ..
# 设置环境文件
make env-base # 或:cp env.example .env并手动更新
# 启动API-WebUI服务器
lightrag-server
git clone https://github.com/HKUDS/LightRAG.git
cd LightRAG
cp env.example .env # 使用您的LLM和嵌入配置更新.env文件
# 在.env中修改LLM和嵌入设置
docker compose up
无需手动编辑 env.example,可使用交互式设置向导生成已配置的 .env 文件,必要时还会生成 docker-compose.final.yml:
make env-base # 必要的第一步:LLM、embedding、reranker
make env-storage # 可选:存储后端和数据库服务
make env-server # 可选:服务器端口、认证和 SSL
make env-base-rewrite # 可选:强制重新生成向导管理的 compose 服务
make env-storage-rewrite # 可选:强制重新生成向导管理的 compose 服务
make env-security-check # 可选:审计当前 .env 的安全风险
有关每个目标的完整说明,请参见 docs/InteractiveSetup.md。设置向导仅更新配置;部署前需单独运行 make env-security-check 以审计当前 .env 文件的安全风险。默认情况下,重新运行设置会保留未更改的向导管理的 compose 服务块;仅当需要从捆绑模板重新构建这些管理块时,才使用 *-rewrite 目标。
cd LightRAG
# 注意:uv sync 会在 .venv/ 中自动创建虚拟环境
uv sync
source .venv/bin/activate # 激活虚拟环境(Linux/macOS)
# Windows 系统:.venv\Scripts\activate
# 或者:pip install -e .
uv pip install lightrag-hku
# 或者:pip install lightrag-hku
LightRAG 对大型语言模型(LLM)能力的要求显著高于传统 RAG,因为它需要 LLM 从文档中执行实体关系提取任务。配置合适的 Embedding 和 Reranker 模型对于提升查询性能也至关重要。
BAAI/bge-m3 和 text-embedding-3-large。[!IMPORTANT] Embedding 模型必须在文档索引前确定,且文档查询阶段必须使用相同模型。对于某些存储解决方案(如 PostgreSQL),向量维度必须在初始表创建时定义。因此,更换 Embedding 模型时,需删除现有向量相关表,让 LightRAG 使用新维度重新创建。
BAAI/bge-reranker-v2-m3 或 Jina 等服务提供的模型。LightRAG Server 旨在提供 Web UI 和 API 支持。它具备全面的知识图谱可视化功能,支持多种引力布局、节点查询、子图过滤等。有关 LightRAG Server 的更多信息,请参见 LightRAG Server。
要开始使用 LightRAG core,请参考 examples 文件夹中的示例代码。此外,还提供了 视频演示 指导本地设置过程。如果您已有 OpenAI API 密钥,可立即运行演示:
### 需在项目文件夹中运行演示代码
cd LightRAG
### 提供您的 OpenAI API 密钥
export OPENAI_API_KEY="sk-...your_opeai_key..."
### 下载查尔斯·狄更斯的《圣诞颂歌》演示文档
curl https://raw.githubusercontent.com/gusye1234/nano-graphrag/main/tests/mock_data.txt
> ./book.txt
### 运行演示代码
python examples/lightrag_openai_demo.py
有关流式响应实现示例,请参见 examples/lightrag_openai_compatible_demo.py。执行前,请确保相应修改示例代码中的 LLM 和 Embedding 配置。
[!NOTE] 注意 1:运行演示程序时,请注意不同测试脚本可能使用不同的 Embedding 模型。如果切换到不同的 Embedding 模型,必须清除数据目录(
./dickens);否则程序可能会出错。如果希望保留 LLM 缓存,可在清除数据目录时保留kv_store_llm_response_cache.json文件。
[!NOTE] 注意 2:仅
lightrag_openai_demo.py和lightrag_openai_compatible_demo.py是官方支持的示例代码。其他示例文件为社区贡献,未经全面测试和优化。
完整的 Core API 参考(包括初始化参数、QueryParam、LLM/Embedding 提供商示例(OpenAI、Ollama、Azure、Gemini、HuggingFace、LlamaIndex)、Reranker 注入、插入操作、实体/关系管理以及删除/合并),请参见 docs/ProgramingWithCore.md。
[!IMPORTANT] 如果您想将 LightRAG 集成到项目中,建议使用 LightRAG Server 提供的 REST API。LightRAG Core 通常用于嵌入式应用或希望进行研究和评估的研究人员。
LightRAG 提供额外功能,包括令牌使用跟踪、知识图谱数据导出、LLM 缓存管理、Langfuse 可观测性集成以及基于 RAGAS 的评估。详见 docs/AdvancedFeatures.md。
LightRAG Server 包含多模态文档处理流水线,支持 PDF、Office 文档、图像、表格和公式。解析通过外部 MinerU 或 Docling 服务处理,而多模态索引在 LightRAG 流水线中运行。设置详情请参见 docs/AdvancedFeatures.md。
LightRAG在农业、计算机科学、***和混合领域中始终优于NaiveRAG、RQ-RAG、HyDE和GraphRAG。有关完整的评估方法、提示词和复现步骤,请参见 docs/Reproduce.md。
整体性能表
| 农业 | 计算机科学 | ******* | 混合 | |||||
|---|---|---|---|---|---|---|---|---|
| NaiveRAG | LightRAG | NaiveRAG | LightRAG | NaiveRAG | LightRAG | NaiveRAG | LightRAG | |
| 全面性 | 32.4% | 67.6% | 38.4% | 61.6% | 16.4% | 83.6% | 38.8% | 61.2% |
| 多样性 | 23.6% | 76.4% | 38.0% | 62.0% | 13.6% | 86.4% | 32.4% | 67.6% |
| 赋能性 | 32.4% | 67.6% | 38.8% | 61.2% | 16.4% | 83.6% | 42.8% | 57.2% |
| 总体 | 32.4% | 67.6% | 38.8% | 61.2% | 15.2% | 84.8% | 40.0% | 60.0% |
| RQ-RAG | LightRAG | RQ-RAG | LightRAG | RQ-RAG | LightRAG | RQ-RAG | LightRAG | |
| 全面性 | 31.6% | 68.4% | 38.8% | 61.2% | 15.2% | 84.8% | 39.2% | 60.8% |
| 多样性 | 29.2% | 70.8% | 39.2% | 60.8% | 11.6% | 88.4% | 30.8% | 69.2% |
| 赋能性 | 31.6% | 68.4% | 36.4% | 63.6% | 15.2% | 84.8% | 42.4% | 57.6% |
| 总体 | 32.4% | 67.6% | 38.0% | 62.0% | 14.4% | 85.6% | 40.0% | 60.0% |
| HyDE | LightRAG | HyDE | LightRAG | HyDE | LightRAG | HyDE | LightRAG | |
| 全面性 | 26.0% | 74.0% | 41.6% | 58.4% | 26.8% | 73.2% | 40.4% | 59.6% |
| 多样性 | 24.0% | 76.0% | 38.8% | 61.2% | 20.0% | 80.0% | 32.4% | 67.6% |
| 赋能性 | 25.2% | 74.8% | 40.8% | 59.2% | 26.0% | 74.0% | 46.0% | 54.0% |
| 总体 | 24.8% | 75.2% | 41.6% | 58.4% | 26.4% | 73.6% | 42.4% | 57.6% |
| GraphRAG | LightRAG | GraphRAG | LightRAG | GraphRAG | LightRAG | GraphRAG | LightRAG | |
| 全面性 | 45.6% | 54.4% | 48.4% | 51.6% | 48.4% | 51.6% | 50.4% | 49.6% |
| 多样性 | 22.8% | 77.2% | 40.8% | 59.2% | 26.4% | 73.6% | 36.0% | 64.0% |
| 赋能性 | 41.2% | 58.8% | 45.2% | 54.8% | 43.6% | 56.4% | 50.8% | 49.2% |
| 总体 | 45.2% | 54.8% | 48.0% | 52.0% | 47.2% | 52.8% | 50.4% | 49.6% |
生态系统与扩展
📸
RAG-Anything
多模态RAG
🎥
VideoRAG
超长上下文视频RAG
✨
MiniRAG
极简RAG
我们欢迎各种形式的贡献——错误修复、新功能、文档改进等。提交拉取请求前,请阅读我们的《贡献指南》。
感谢所有贡献者的宝贵贡献。
@article{guo2024lightrag,
title={LightRAG: Simple and Fast Retrieval-Augmented Generation},
author={Zirui Guo and Lianghao Xia and Yanhua Yu and Tu Ao and Chao Huang},
year={2024},
eprint={2410.05779},
archivePrefix={arXiv},
primaryClass={cs.IR}
}
⭐
感谢您关注LightRAG!
⭐
探索更多轩辕镜像的使用方法,找到最适合您系统的配置方式
通过 Docker 登录认证访问私有仓库
无需登录使用专属域名
Kubernetes 集群配置 Containerd
K3s 轻量级 Kubernetes 镜像加速
VS Code Dev Containers 配置
Podman 容器引擎配置
HPC 科学计算容器配置
ghcr、Quay、nvcr 等镜像仓库
Harbor Proxy Repository 对接专属域名
Portainer Registries 加速拉取
Nexus3 Docker Proxy 内网缓存
需要其他帮助?请查看我们的 常见问题Docker 镜像访问常见问题解答 或 提交工单
docker search 限制
站内搜不到镜像
离线 save/load
插件要用 plugin install
WSL 拉取慢
安全与 digest
新手拉取配置
镜像合规机制
不支持 push
manifest unknown
no matching manifest(架构)
invalid tar header(解压)
TLS 证书失败
DNS 超时
域名连通性排查
410 Gone 排查
402 与流量用尽
401 认证失败
429 限流
D-Bus 凭证提示
413 与超大单层
来自真实用户的反馈,见证轩辕镜像的优质服务