rag-web-ui — RAG 知识库工具中文文档
rag-web-ui — RAG 知识库工具中文文档 是 AI Skill Hub 本期精选AI工具之一。已获得 3.0k 颗 GitHub Star，综合评分 8.8 分，整体质量较高。我们强烈推荐将其纳入你的 AI 工具库，帮助提升工作效率。
**为什么要使用开源工具而非商业 SaaS？**
对于个人开发者和有隐私需求的用户，本地部署的开源工具意味着数据不离本机，不受第三方服务商的数据政策约束。同时，开源工具通常没有使用次数限制和月度费用，一次安装即可长期使用，对于高频使用场景的总拥有成本（TCO）远低于订阅制商业工具。
**安装与环境准备**
rag-web-ui — RAG 知识库工具中文文档 依赖 TypeScript 运行环境。建议通过 pyenv（Python）或 nvm（Node.js）管理 TypeScript 版本，避免全局环境污染。对于新手用户，推荐先创建虚拟环境（python -m venv venv && source venv/bin/activate），再安装依赖，这样即使出现问题也可以随时删除虚拟环境重新开始，不影响系统稳定性。
**社区与维护**
GitHub Issue 和 Discussion 是获取帮助的最快渠道。在提问前建议先检查 Closed Issues（已关闭的问题），大多数常见问题都已有解答。遇到 Bug 时，提供 pip list 的输出、完整错误堆栈和最小可复现示例，能显著提高开发者响应速度。AI Skill Hub 将持续追踪 rag-web-ui — RAG 知识库工具中文文档 的版本更新，及时通知重要功能变化。
rag-web-ui — RAG 知识库工具中文文档 是一款基于 TypeScript 开发的开源工具，专注于 ai、deepseek、langchain 等核心功能。作为 GitHub 开源项目，它拥有活跃的社区支持和持续的版本迭代，代码完全透明可审计，支持本地部署以保护数据隐私。无论是个人使用还是集成到企业工作流，都能提供稳定可靠的解决方案。
rag-web-ui — RAG 知识库工具中文文档 是一款基于 TypeScript 开发的开源工具，专注于 ai、deepseek、langchain 等核心功能。作为 GitHub 开源项目，它拥有活跃的社区支持和持续的版本迭代，代码完全透明可审计，支持本地部署以保护数据隐私。无论是个人使用还是集成到企业工作流，都能提供稳定可靠的解决方案。
- 开源免费，支持本地部署，数据完全自主可控
- 活跃的 GitHub 开源社区，持续迭代更新
- 提供详细文档和使用示例，新手友好
- 支持自定义配置，灵活适配不同使用环境
- 可作为基础组件集成进现有技术栈或进行二次开发
- 本地部署运行，保护数据隐私，满足合规要求
- 自定义集成到现有系统，扩展技术栈能力
- 作为开源基础组件进行商业化二次开发
# 方式一：npm 全局安装 npm install -g rag-web-ui # 方式二：npx 直接运行（无需安装） npx rag-web-ui --help # 方式三：项目依赖安装 npm install rag-web-ui # 方式四：从源码运行 git clone https://github.com/rag-web-ui/rag-web-ui cd rag-web-ui npm install npm start
- 访问 GitHub 仓库页面
- 按照 README 文档完成依赖安装
- 根据系统环境完成初始化配置
- 参考官方示例或文档开始使用
- 遇到问题可在 GitHub Issues 中查找解答
# 命令行使用
rag-web-ui --help
# 基本用法
rag-web-ui [options] <input>
# Node.js 代码中使用
const rag_web_ui = require('rag-web-ui');
const result = await rag_web_ui.run(options);
console.log(result);
# rag-web-ui 配置说明 # 查看配置选项 rag-web-ui --config-example > config.yml # 常见配置项 # output_dir: ./output # log_level: info # workers: 4 # 环境变量（覆盖配置文件） export RAG_WEB_UI_CONFIG="/path/to/config.yml"
简介
Knowledge Base Management Based on RAG (Retrieval-Augmented Generation)
<p> <a href="https://github.com/rag-web-ui/rag-web-ui/blob/main/LICENSE"><img src="https://img.shields.io/github/license/rag-web-ui/rag-web-ui" alt="License"></a> <a href="#"><img src="https://img.shields.io/badge/python-3.9+-blue.svg" alt="Python"></a> <a href="#"><img src="https://img.shields.io/badge/node-%3E%3D18-green.svg" alt="Node"></a> <a href="#"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome"></a> <a href="#"><img src="https://github.com/rag-web-ui/rag-web-ui/actions/workflows/test.yml/badge.svg" alt="CI"></a> </p>
<p> <a href="#features">Features</a> • <a href="#quick-start">Quick Start</a> • <a href="#deployment-guide">Deployment</a> • <a href="#architecture">Architecture</a> • <a href="#development">Development</a> • <a href="#contributing">Contributing</a> • <a href="https://deepwiki.com/rag-web-ui/rag-web-ui" target="_blank">DeepWiki</a> </p> </div>
📖 Introduction
RAG Web UI is an intelligent dialogue system based on RAG (Retrieval-Augmented Generation) technology that helps build intelligent Q&A systems based on your own knowledge base. By combining document retrieval and large language models, it achieves accurate and reliable knowledge-based question answering services.
The system supports multiple LLM deployment options, including cloud services like OpenAI, DeepSeek, and MiniMax, as well as local model deployment through Ollama, meeting privacy and cost requirements in different scenarios.
It also provides OpenAPI interfaces for convenient knowledge base access via API calls.
✨ Features
- 📚 Intelligent Document Management
- Support for multiple document formats (PDF, DOCX, Markdown, Text)
- Automatic document chunking and vectorization
- Support for async document processing and incremental updates
- 🤖 Advanced Dialogue Engine
- Precise retrieval and generation based on RAG
- Support for multi-turn contextual dialogue
- Support for reference citations in conversations
- 🎯 Robust Architecture
- Frontend-backend separation design
- Distributed file storage
- High-performance vector database: Support for ChromaDB, Qdrant with easy switching through Factory pattern
Prerequisites
- Docker & Docker Compose v2.0+
- Node.js 18+
- Python 3.9+
- 8GB+ RAM
Installation
1. Clone the repository
git clone https://github.com/rag-web-ui/rag-web-ui.git
cd rag-web-ui- Configure environment variables
You can check the details in the configuration table below.
cp .env.example .env3. Start services(development server)
docker compose up -d --build🚀 Quick Start
📖 Development Guide
docker compose -f docker-compose.dev.yml up -d --buildDevelopment Guidelines
- Follow Python PEP 8 coding standards
- Follow Conventional Commits
🖼️ Screenshots
Knowledge Base Management Dashboard
Document Processing Dashboard
Document List
Intelligent Chat Interface with References
API Key Management
<img src="./docs/images/screenshot6.png" alt="Analytics Dashboard" width="800"> <p><em>API Reference</em></p> </div>
## Project Flowchart
(PDF/MD/TXT/DOCX)"] job_id["Return Job ID"] nfs["NFS"] subgraph async_process["Asynchronous Document Processing"] direction TB preprocess["Document Preprocessing
(Text Extraction/Cleaning)"] split["Text Splitting
(Segmentation/Overlap)"] subgraph embedding_process["Embedding Service"] direction LR embedding_api["Embedding API"] --> embedding_server["Embedding Server"] end store[(Vector Database)] %% Internal Flow of Asynchronous Processing preprocess --> split split --> embedding_api embedding_server --> store end subgraph job_query["Job Status Query"] direction TB job_status["Job Status
(Processing/Completed/Failed)"] end end %% Query Service Flow subgraph query_process["Query Service"] direction LR user_history["User History"] --> query["User Query
(Based on User History)"] query --> query_embed["Query Embedding"] query_embed --> retrieve["Vector Retrieval"] retrieve --> rerank["Re-ranking
(Cross-Encoder)"] rerank --> context["Context Assembly"] context --> llm["LLM Generation"] llm --> response["Final Response"] query -.-> rerank end %% Main Flow Connections client --> |"1.Upload Document"| docs docs --> |"2.Generate"| job_id docs --> |"3a.Trigger"| async_process job_id --> |"3b.Return"| client docs --> nfs nfs --> preprocess %% Open API Retrieval Flow open_api --> |"Retrieve Context"| retrieval_service["Retrieval Service"] retrieval_service --> |"Access"| store retrieval_service --> |"Return Context"| open_api %% Status Query Flow client --> |"4.Poll"| job_status job_status --> |"5.Return Progress"| client %% Database connects to Query Service store --> retrieve %% Style Definitions (Adjusted to match GitHub theme colors) classDef process fill:#d1ecf1,stroke:#0077b6,stroke-width:1px classDef database fill:#e2eafc,stroke:#003566,stroke-width:1px classDef input fill:#caf0f8,stroke:#0077b6,stroke-width:1px classDef output fill:#ffc8dd,stroke:#d00000,stroke-width:1px classDef rerank fill:#cdb4db,stroke:#5a189a,stroke-width:1px classDef async fill:#f8edeb,stroke:#7f5539,stroke-width:1px,stroke-dasharray: 5 5 classDef actor fill:#fefae0,stroke:#606c38,stroke-width:1px classDef jobQuery fill:#ffedd8,stroke:#ca6702,stroke-width:1px classDef queryProcess fill:#d8f3dc,stroke:#40916c,stroke-width:1px classDef embeddingService fill:#ffe5d9,stroke:#9d0208,stroke-width:1px classDef importProcess fill:#e5e5e5,stroke:#495057,stroke-width:1px %% Applying classes to nodes class docs,query,retrieval_service input class preprocess,split,query_embed,retrieve,context,llm process class store,nfs database class response,job_id,job_status output class rerank rerank class async_process async class client,open_api actor class job_query jobQuery style query_process fill:#d8f3dc,stroke:#40916c,stroke-width:1px style embedding_process fill:#ffe5d9,stroke:#9d0208,stroke-width:1px style import_process fill:#e5e5e5,stroke:#495057,stroke-width:1px style job_query fill:#ffedd8,stroke:#ca6702,stroke-width:1px
🔧 Configuration
Core Configuration
| Parameter | Description | Default | Required |
|---|---|---|---|
| MYSQL_SERVER | MySQL Server Address | localhost | ✅ |
| MYSQL_USER | MySQL Username | postgres | ✅ |
| MYSQL_PASSWORD | MySQL Password | postgres | ✅ |
| MYSQL_DATABASE | MySQL Database Name | ragwebui | ✅ |
| SECRET_KEY | JWT Secret Key | - | ✅ |
| ACCESS_TOKEN_EXPIRE_MINUTES | JWT Token Expiry (minutes) | 30 | ✅ |
LLM Configuration
| Parameter | Description | Default | Applicable |
|---|---|---|---|
| CHAT_PROVIDER | LLM Service Provider | openai | ✅ |
| OPENAI_API_KEY | OpenAI API Key | - | Required for OpenAI |
| OPENAI_API_BASE | OpenAI API Base URL | https://api.openai.com/v1 | Optional for OpenAI |
| OPENAI_MODEL | OpenAI Model Name | gpt-4 | Required for OpenAI |
| DEEPSEEK_API_KEY | DeepSeek API Key | - | Required for DeepSeek |
| DEEPSEEK_API_BASE | DeepSeek API Base URL | - | Required for DeepSeek |
| DEEPSEEK_MODEL | DeepSeek Model Name | - | Required for DeepSeek |
| OLLAMA_API_BASE | Ollama API Base URL | http://localhost:11434 | Required for Ollama |
| OLLAMA_MODEL | Ollama Model Name | llama2 | Required for Ollama |
| MINIMAX_API_KEY | MiniMax API Key | - | Required for MiniMax |
| MINIMAX_API_BASE | MiniMax API Base URL | https://api.minimax.io/v1 | Optional for MiniMax |
| MINIMAX_MODEL | MiniMax Model Name | MiniMax-M2.7 | Required for MiniMax |
Embedding Configuration
| Parameter | Description | Default | Applicable |
|---|---|---|---|
| EMBEDDINGS_PROVIDER | Embedding Service Provider | openai | ✅ |
| OPENAI_API_KEY | OpenAI API Key | - | Required for OpenAI Embedding |
| OPENAI_EMBEDDINGS_MODEL | OpenAI Embedding Model | text-embedding-ada-002 | Required for OpenAI Embedding |
| DASH_SCOPE_API_KEY | DashScope API Key | - | Required for DashScope |
| DASH_SCOPE_EMBEDDINGS_MODEL | DashScope Embedding Model | - | Required for DashScope |
| OLLAMA_EMBEDDINGS_MODEL | Ollama Embedding Model | deepseek-r1:7b | Required for Ollama Embedding |
Vector Database Configuration
| Parameter | Description | Default | Applicable |
|---|---|---|---|
| VECTOR_STORE_TYPE | Vector Store Type | chroma | ✅ |
| CHROMA_DB_HOST | ChromaDB Server Address | localhost | Required for ChromaDB |
| CHROMA_DB_PORT | ChromaDB Port | 8000 | Required for ChromaDB |
| QDRANT_URL | Qdrant Vector Store URL | http://localhost:6333 | Required for Qdrant |
| QDRANT_PREFER_GRPC | Prefer gRPC Connection for Qdrant | true | Optional for Qdrant |
Object Storage Configuration
| Parameter | Description | Default | Required |
|---|---|---|---|
| MINIO_ENDPOINT | MinIO Server Address | localhost:9000 | ✅ |
| MINIO_ACCESS_KEY | MinIO Access Key | minioadmin | ✅ |
| MINIO_SECRET_KEY | MinIO Secret Key | minioadmin | ✅ |
| MINIO_BUCKET_NAME | MinIO Bucket Name | documents | ✅ |
Other Configuration
| Parameter | Description | Default | Required |
|---|---|---|---|
| TZ | Timezone Setting | Asia/Shanghai | ❌ |
🔧 Troubleshooting
For common issues and solutions, please refer to our Troubleshooting Guide.
RAG Web UI 是一个基于 RAG (Retrieval-Augmented Generation) 技术的智能对话系统，帮助您基于自己的知识库构建智能问答系统。通过结合文档检索和大规模语言模型，它实现了准确和可靠的知识库问答服务。该系统支持多种 LLM 部署选项，包括云服务等。
RAG Web UI 的功能包括智能文档管理、进阶对话引擎等。智能文档管理支持多种文档格式（PDF、DOCX、Markdown、Text），自动文档切割和向量化，支持异步文档处理和增量更新。进阶对话引擎支持精确检索和生成基于 RAG，支持多轮上下文对话，支持引用引用在对话中。
安装步骤包括：克隆仓库，配置环境变量，启动服务（开发服务器）。
快速启动步骤包括：克隆仓库，配置环境变量，启动服务（开发服务器）。
配置说明包括核心配置和 LLM 配置两部分。核心配置包括 MySQL 服务器地址、用户名、密码等。LLM 配置包括 LLM 服务提供商、OpenAI API 密钥等。
常见问题解答包括：常见问题和解决方案，请参阅我们的[故障排除指南](docs/troubleshooting.md)。
- 构建企业知识库 / RAG 检索应用的团队
- 生产部署优先使用 Docker Compose 隔离依赖，并挂载 volume 持久化数据
- 本地部署优先选 GGUF 量化模型，节省显存并保持响应速度
- 分块大小建议 256-512 tokens，向量库优选 pgvector 或 Qdrant
- API key 直接提交到 git 仓库（请用 .env 并加入 .gitignore）
- 容器内无法访问宿主机 localhost — 使用 host.docker.internal
- embedding 模型与查询模型不一致导致检索失效
- 显存不足直接 OOM — 优先降低 context 或换更小的量化模型
- Docker：rag-web-ui 提供官方镜像，docker compose up 一键启动
- 本地部署：CPU 8GB 起，GPU 推荐 16GB+ 显存
- 云端托管：可放在 Vercel / Railway / Fly.io 等 PaaS 平台
- 开源免费，支持本地部署，数据完全自主可控
- 活跃的 GitHub 开源社区，持续迭代更新
- 提供详细文档和使用示例，新手友好
- 支持自定义配置，灵活适配不同使用环境
- 可作为基础组件集成进现有技术栈或进行二次开发
- 本地部署运行，保护数据隐私，满足合规要求
- 自定义集成到现有系统，扩展技术栈能力
- 作为开源基础组件进行商业化二次开发
- +Apache-2.0 协议，可免费商用
- +AI Skill Hub 精选推荐
- +完全开源免费，无授权费用
- +本地部署，数据完全自主可控
- +开发者社区支持，遇问题可查可问
- −安装和初始配置可能需要一定技术基础
- −功能完整性通常不如成熟商业产品
- −技术支持主要依赖开源社区，响应速度不稳定
AI Skill Hub 为第三方内容聚合平台，本页面信息基于公开数据整理，不对工具功能和质量作任何法律背书。
建议在沙箱或测试环境中充分验证后，再部署至生产环境，并做好必要的安全评估。
✅ Apache 2.0 — 宽松开源协议，可商用，需保留版权声明和 NOTICE 文件，含专利授权条款。
经综合评估，rag-web-ui — RAG 知识库工具中文文档 在AI工具赛道中表现稳健，质量优秀。如果你已有明确的使用需求，可以直接上手体验；如果还在评估阶段，建议对比同类工具后再做决策。
| 原始名称 | rag-web-ui |
| 原始描述 | RAG Web UI is an intelligent dialogue system based on RAG (Retrieval-Augmented Generation) technology. |
| Topics | aideepseeklangchainollamarag |
| GitHub | https://github.com/rag-web-ui/rag-web-ui |
| License | Apache-2.0 |
| 语言 | TypeScript |
收录时间：2026-05-22 · 更新时间：2026-05-22 · License：Apache-2.0 · AI Skill Hub 不对第三方内容的准确性作法律背书。