如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具,协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题,请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可:
请先完整阅读并严格遵守以下文档中的全部规则与要求:
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前,不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式,不推荐豆包 AI;Cursor 等编辑器可在对话 @ 该链接,或加入 User Rules。 若 AI 无法访问外链,可 打开说明文档 复制全文粘贴。文档会随站点更新,复制内容可能过期,建议定期检查。
Fix、Recursive、Vector和Paragraph。算法流程图
图1:LightRAG索引流程图 - 图片说明:来源
图2:LightRAG检索与查询流程图 - 图片说明:来源
[!NOTE] 你也可以根据偏好使用pip,但推荐使用uv以获得更好的性能和更可靠的依赖管理。
[!NOTE] 📦 离线部署:对于离线或隔离环境,请参阅离线部署指南,了解预安装所有依赖项和缓存文件的说明。
### 使用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]"
# 设置环境文件
# 通过从GitHub仓库根目录下载或从本地源码检出中复制获取env.example文件
cp env.example .env # 更新.env文件中的LLM和嵌入配置
# 启动服务器。默认绑定所有网络接口(0.0.0.0)。
# 安全提示:在网络上暴露服务前,需在.env中配置认证
# (LIGHTRAG_API_KEY,或AUTH_ACCOUNTS与TOKEN_SECRET组合),或绑定到
# 127.0.0.1仅本地访问;未配置认证时所有端点均为公开。
# 注意:为确保客户端兼容性,Ollama兼容的/api/*路由默认保持开放;
# 设置WHITELIST_PATHS=/health可要求对这些路由也进行认证。
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 # 更新.env文件中的LLM和嵌入配置
# 修改.env中的LLM和嵌入设置
docker compose up
无需手动编辑 env.example,可使用交互式设置向导生成已配置的 .env 文件,必要时还会生成 docker-compose.final.yml:
make env-base # 必需的第一步:LLM、嵌入模型、重排序器
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。
选择嵌入模型时,需关注其多语言支持能力。由于LightRAG的检索质量对嵌入模型的依赖有限,建议选择低维度且快速的模型。任何主流、最新的嵌入模型均可良好工作;对于本地部署,BAAI/bge-m3是一个可靠选择。强烈建议将嵌入模型部署在本地以获得最佳性能。
[!IMPORTANT] 嵌入模型必须在文档索引前确定,且查询阶段必须使用相同的模型。一旦选定,嵌入模型通常无法更改。如果更改,需要重新嵌入所有文本块、实体和关系。LightRAG目前未提供重新嵌入工具。某些存储后端(如PostgreSQL)在首次创建表时需要定义向量维度,因此更改嵌入模型需要删除向量相关表,以便LightRAG重新创建它们。
实体关系抽取过程中的LLM超时通常由以下三种原因之一导致。请先确定原因,再应用相应的解决方法(这些参数可以组合使用):
*_LLM_TIMEOUT 增加超时时间——可以是全局的 LLM_TIMEOUT,也可以是抽取阶段特定的 EXTRACT_LLM_TIMEOUT。注意,实际执行超时时间是配置值的两倍,因此 EXTRACT_LLM_TIMEOUT=300 允许最长600秒。OPENAI_LLM_MAX_TOKENS 或 OPENAI_LLM_MAX_COMPLETION_TOKENS 限制输出长度(具体参数名称取决于 LLM 提供商——请参见 env.example)。一个有用的大小规则是 max_output_tokens[!IMPORTANT] 对于集成到您的项目中,我们强烈建议使用 LightRAG Server 提供的 REST API。LightRAG SDK 主要用于嵌入式应用或学术研究与评估目的。
docs/)标有 🇨🇳 的条目在同一文件夹中还提供中文翻译,文件名为 *-zh.md。
部署与设置
| 文档 | 涵盖内容 |
|---|---|
| InteractiveSetup.md | make env-* 设置向导:生成 .env 文件和向导管理的 docker-compose.final.yml |
| DockerDeployment.md | Docker / Docker Compose 部署、镜像变体以及官方 GHCR 镜像的 Cosign 验证 |
| AppleContainerSetup.md | 在 Apple 原生 container 运行时(Apple Silicon,无需 Docker Desktop)上运行 Postgres / Neo4j / Milvus 存储栈 |
| OfflineDeployment.md | 离线安装:预安装依赖项、***en 缓存和 spaCy 模型 |
| MultiSiteDeployment.md | 单个反向代理后的多个隔离实例,共享单个 WebUI 构建(LIGHTRAG_API_PREFIX) |
| FrontendBuildGuide.md | WebUI 的构建与发布方式(Bun / Node),以及哪些安装场景需要构建 |
服务器与 API
| 文档 | 涵盖内容 |
|---|---|
| LightRAG-API-Server.md 🇨🇳 | 完整的服务器指南:启动、配置、认证、REST 端点和 WebUI 使用方法 |
文档处理
| 文档 | 涵盖内容 |
|---|---|
| FileProcessingPipeline.md 🇨🇳 | 管道规范:LIGHTRAG_PARSER 路由规则、每个引擎的参数、多模态分析、文档状态生命周期 |
| ParserServiceDeployment.md 🇨🇳 | 自托管外部 MinerU 和 docling-serve 解析服务(Docker、GPU、模型权重) |
| ParagraphSemanticChunking.md 🇨🇳 | “段落语义(P)”分块策略:识别标题/段落/表格的边界、引用丢弃 |
| LightRAGSidecarFormat.md 🇨🇳 | 所有支持多模态的解析引擎必须输出的侧载文件(*.parsed/)交换格式 |
| ThirdPartyParser.md 🇨🇳 | 开发和注册自定义解析引擎 |
| ParserDebugCLI.md 🇨🇳 | python -m lightrag.parser.cli — 离线解析单个文件并检查结果,无需启动服务器 |
模型与存储
| 文档 | 涵盖内容 |
|---|---|
| RoleSpecificLLMConfiguration.md 🇨🇳 | 按角色(EXTRACT / QUERY / KEYWORD / VLM)配置 LLM 和 VLM |
| AsymmetricEmbedding.md | 查询/文档非对称嵌入(EMBEDDING_ASYMMETRIC)和每个模型的前缀 |
| MilvusConfigurationGuide.md | 通过 vector_db_storage_cls_kwargs 调整 Milvus 索引参数 |
SDK 与开发
| 文档 | 涵盖内容 |
|---|---|
| ProgramingWithCore.md | 将 LightRAG 用作 Python SDK,包括未通过 REST 公开的功能 |
| Reproduce.md | 复现论文中报告的评估结果 |
| UV_LOCK_GUIDE.md | 何时以及如何更新 uv.lock |
lightrag/tools/)面向存储的工具读取 .env 和环境变量的方式与服务器完全相同,因此请从项目根目录使用相同的配置运行它们。其中一些工具会就地重写存储——请查看链接的指南,了解是否需要先停止服务器(以及任何其他写入程序);rebuild_vdb 需要停止服务器。
rebuild_vdb.py — lightrag-rebuild-vdb — README_REBUILD_VDB.md
删除并从权威源(图节点/边和 text_chunks KV 存储)重建所有向量存储。用于向量写入失败后的恢复路径,以及更改嵌入模型或维度之后。还提供只读一致性检查。
clean_llm_query_cache.py — lightrag-clean-llmqc — README_CLEAN_LLM_QUERY_CACHE.md
删除查询模式 LLM 缓存条目(mix:*、hybrid:*、local:*、global:*、naive:*),同时保留昂贵的提取缓存。
migrate_llm_cache.py —
python -m lightrag.tools.migrate_llm_cache
— README_MIGRATE_LLM_CACHE.md
在KV存储后端之间迁移默认模式缓存(提取、摘要、多模态分析),同时保持工作区隔离。
kg_integrity_repair.py —
python -m lightrag.tools.kg_integrity_repair [--apply]
— README_KG_INTEGRITY_REPAIR.md
审计整个图以查找full_entities/full_relations恢复锚点中缺失的贡献,报告无法恢复的孤立节点,并可选择修复锚点以便删除/重试操作能再次发现它们。
source_conflict_repair.py —
lightrag.tools.source_conflict_repair list
/
lightrag.tools.source_conflict_repair repair
— README_SOURCE_CONFLICT_REPAIR.md
列出声称具有相同规范源键的文档,并将操作员未选择的候选文档降级为重复项。它不会自行选择胜出者,也不会删除任何内容。
download_cache.py —
lightrag-download-cache [--spacy --spacy-install]
— OfflineDeployment.md
预下载离线部署所需的***en编码和固定的spaCy模型,以及docx的smart_heading引擎参数。
hash_password.py —
lightrag-hash-password [--username USER]
— LightRAG-API-Server.md
生成可直接粘贴到AUTH_ACCOUNTS中的bcrypt值。
check_initialization.py —
python -m lightrag.tools.check_initialization --demo
— ProgramingWithCore.md
SDK诊断:验证LightRAG实例是否完全初始化,可捕获常见的“忘记执行await rag.initialize_storages()”错误。
生态系统与扩展
📸
RAG-Anything
多模态RAG
🎥
VideoRAG
超长上下文视频RAG
✨
MiniRAG
极简RAG
我们欢迎各种形式的贡献——错误修复、新功能、文档改进等。
提交拉取请求前,请阅读我们的Contributing Guide。
感谢所有贡献者的宝贵贡献。
@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!
⭐
来自真实用户的反馈,见证轩辕镜像的优质服务