RAGFlow开发文档：架构设计、模块划分、接口定义

RAGFlow开发文档：架构设计、模块划分、接口定义

【免费下载链接】ragflow RAGFlow是一个基于深度文档理解的开源RAG（检索增强生成）引擎。 项目地址: https://gitcode.com/GitHub_Trending/ra/ragflow

一、系统架构概述

RAGFlow是一个基于深度文档理解的开源RAG（检索增强生成）引擎，其核心架构围绕检索增强生成技术构建，融合了深度文档理解、智能文本切片、多源数据融合等关键技术。系统采用模块化设计，确保各组件间低耦合高内聚，支持从个人应用到企业级部署的全场景需求。

1.1 整体架构图

THE 0TH POSITION OF THE ORIGINAL IMAGE

1.2 核心技术特点

• 深度文档理解：基于deepdoc模块实现对复杂格式文档的解析与理解
• 无限上下文支持：真正在无限上下文（token）场景下实现高效检索
• 多模态处理：支持文本、图像等多种数据类型的解析与处理
• 插件化设计：通过plugin模块实现功能扩展与第三方集成

二、模块划分

2.1 核心模块结构

RAGFlow系统主要包含以下核心模块：

模块名称	功能描述	核心文件/路径
admin	系统管理功能	admin/
agent	智能代理功能	agent/
api	API服务实现	api/
deepdoc	深度文档理解	deepdoc/
rag	RAG核心功能	rag/
graphrag	知识图谱相关功能	graphrag/
sdk	软件开发工具包	sdk/

2.2 关键模块详解

2.2.1 RAG核心模块 (rag/)

该模块实现了RAGFlow的核心功能，包括检索、生成、提示词管理等。

核心子模块：

• llm: 大语言模型接口封装，支持多种LLM集成
  • chat_model.py
  • embedding_model.py
• flow: 文档处理流程管理
  • pipeline.py
  • file.py
• prompts: 提示词模板管理
  • generator.py
  • analyze_task_system.md

2.2.2 深度文档理解模块 (deepdoc/)

实现对复杂格式文档的解析与理解，支持PDF、DOCX、PPT等多种格式。

核心功能：

• 文档布局分析
• 表格识别与提取
• 图片内容解析
• OCR文字识别

核心文件：

• parser/：文档解析器集合
• vision/：视觉相关功能实现
• layout_recognizer.py：文档布局识别

2.2.3 智能代理模块 (agent/)

提供基于智能代理的高级功能，支持工具调用、工作流自动化等。

核心功能：

• 多工具集成：tools/
• 工作流模板：templates/
• 组件化设计：component/

工具示例：

• 网络搜索：duckduckgo.py
• 代码执行：code_exec.py
• 数据库查询：exesql.py

三、接口定义

3.1 API接口设计

RAGFlow提供RESTful API接口，方便第三方系统集成。API服务实现位于api/ragflow_server.py。

核心API端点：

• 数据集管理：创建、查询、更新、删除数据集
• 文档处理：上传、解析、删除文档
• 检索服务：向量检索、关键词检索
• 对话服务：创建对话、生成回答

3.2 核心接口示例

3.2.1 数据集管理接口

# 创建数据集
def create_dataset(auth, payload=None, *, headers=HEADERS, data=None)

# 列出数据集
def list_datasets(auth, params=None, *, headers=HEADERS)

# 更新数据集
def update_dataset(auth, dataset_id, payload=None, *, headers=HEADERS, data=None)

# 删除数据集
def delete_datasets(auth, payload=None, *, headers=HEADERS, data=None)

代码来源：test/common.py

3.2.2 文档处理接口

# 上传文档
def upload_documents(auth, dataset_id, files_path=None)

# 解析文档
def parse_documents(auth, dataset_id, payload=None)

# 列出文档
def list_documents(auth, dataset_id, params=None)

# 删除文档
def delete_documents(auth, dataset_id, payload=None)

代码来源：test/common.py

3.2.3 RAG检索接口

# 检索相关块
def retrieval_chunks(auth, payload=None, *, headers=HEADERS)

# 添加块
def add_chunk(auth, dataset_id, document_id, payload=None)

# 列出块
def list_chunks(auth, dataset_id, document_id, params=None)

代码来源：test/common.py

四、配置与部署

4.1 配置文件

RAGFlow系统配置涉及以下关键文件：

• docker/.env：环境变量配置
• docker/service_conf.yaml.template：服务配置
• docker/docker-compose.yml：容器编排配置

4.2 启动流程

# 克隆仓库
git clone https://gitcode.com/GitHub_Trending/ra/ragflow

# 进入docker目录
cd ragflow/docker

# 启动服务
docker compose -f docker-compose.yml up -d

4.3 系统要求

• CPU >= 4核
• RAM >= 16 GB
• Disk >= 50 GB
• Docker >= 24.0.0 & Docker Compose >= v2.26.1

五、开发指南

5.1 源码启动

# 安装依赖
uv sync --python 3.10 --all-extras
uv run download_deps.py

# 启动依赖服务
docker compose -f docker/docker-compose-base.yml up -d

# 启动后端服务
source .venv/bin/activate
export PYTHONPATH=$(pwd)
bash docker/launch_backend_service.sh

# 启动前端服务
cd web
npm install
npm run dev

5.2 开发规范

• 代码风格遵循PEP 8规范
• 使用pre-commit进行代码检查
• 提交PR前确保所有测试通过

详细开发指南请参考开发文档。

六、技术文档与资源

• 官方文档：docs/
• API参考：docs/references/http_api_reference.md
• 常见问题：docs/faq.mdx
• 贡献指南：docs/contribution/contributing.md

【免费下载链接】ragflow RAGFlow是一个基于深度文档理解的开源RAG（检索增强生成）引擎。 项目地址: https://gitcode.com/GitHub_Trending/ra/ragflow