【RAGFlow代码详解-26】Python SDK

原创

已于 2025-08-26 17:34:16 修改 · 1.2k 阅读

20 ·

CC 4.0 BY-SA版权

文章标签：

#python #开发语言

于 2025-08-26 16:42:32 首次发布

目的和范围

RAGFlow Python SDK 提供了一个编程接口，用于与 RAGFlow 的 HTTP API 端点进行交互。它提供了一个方便的 Python 客户端库，抽象了底层 REST API 调用，使开发人员能够将 RAGFlow 的知识库管理、文档处理和对话式 AI 功能集成到他们的 Python 应用程序中。

有关详细的 HTTP 端点规范，请参阅 HTTP API。有关前端 API 集成模式，请参阅前端 API 集成。

安装和分发

Python SDK 作为 Python 包分发，可以构建并发布到 PyPI。构建过程使用现代 Python 打包工具：

uv build
uv pip install twine
export TWINE_USERNAME="__token__"
export TWINE_PASSWORD=$YOUR_PYPI_API_TOKEN
twine upload dist/*.whl

SDK 架构

Python SDK 架构镜像了 RAGFlow HTTP API 结构，提供与主要服务端点相对应的客户端类：
在这里插入图片描述

核心客户端类

最低0.47元/天解锁文章

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

df007df

关注关注

11
点赞
踩
20

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
打赏
打赏
打赏举报

举报

专栏目录

RAGFlow智能体开发：发布的版本

王国平的博客

10-10

962

每个 RAGFlow 版本都提供两种版本：精简版 (Slim edition)：不包含内置的 embedding 模型，版本名称后带有 -slim 后缀，例如：infiniflow/ragflow:v0.19.1-slim。完整版 (Full edition)：包含内置的 embedding 模型，版本名称后没有后缀，例如：infiniflow/ragflow:v0.19.1。

ragflow通过python实现

yilvyangguang520的博客

02-20

546

ragflow通过python实现

参与评论您还未登录，请先登录后发表或查看评论

RAGFlow API开发：构建自定义RAG应用的完整指南

热门推荐

兴趣使然的创作者

03-09

1万+

Ragflow是目前团队化部署大模型+RAG的优质方案，不过其仍不适合直接部署使用，本文将从实际使用的角度，对其进行二次开发

简单易懂的利用python 调用ragflow api 教程及示例（内含源代码）

qq_70110230的博客

04-15

5509

参考官方ragflow文档以及官方文档中给出了一些示例，但是是以crul的方式运行的，这里结合具体的示例和界面演示，利用python进行实现。

【RAGFlow代码详解-25】HTTP 接口

df007df的博客

08-26

1113

本文介绍了基于Flask构建的HTTP API系统架构和功能模块。该系统采用API密钥进行身份验证，通过模块化蓝图组织功能，主要包含数据集管理、文档处理、块管理、聊天助手和会话管理五大核心模块。数据集模块支持知识图谱操作，文档模块处理文件上传解析，块模块提供细粒度内容控制，聊天和会话模块实现对话式AI功能。系统采用标准化错误处理机制，提供Python SDK封装API调用，并兼容OpenAI接口格式。所有端点遵循RESTful设计，返回统一JSON响应结构，支持流式传输和非流式请求处理。

【RAGFlow代码详解-24】API 参考

df007df的博客

08-26

1483

RAGFlow API架构采用分层设计，包含认证授权、核心API和数据处理层。系统提供基于API密钥的认证机制，并划分数据集管理、文档处理、聊天会话等六大功能模块。采用标准化请求响应流程，支持OpenAI兼容接口，便于集成。Python SDK封装了底层API调用，提供面向对象接口。错误处理系统定义规范状态码，涵盖参数校验、权限控制等场景，确保一致性的错误反馈。整个架构强调模块化设计，兼顾功能完整性与开发便利性。

【RAGFlow代码详解-30】构建系统和 CI/CD

df007df的博客

08-26

907

RAGFlow采用多阶段Docker构建系统，支持完整版和精简版两种镜像变体，并通过优化缓存策略提升构建效率。项目使用Python脚本管理外部依赖下载，包括ML模型和系统库等。持续集成工作流涵盖静态分析、多后端测试和分级测试策略。发布自动化系统支持版本发布和每日构建，同步推送Docker镜像和PyPI包。灵活的版本管理系统结合Git标签和构建文件，确保开发和生产环境的一致性。构建系统还针对不同CPU架构进行了优化，支持x86和ARM平台。

Ragflow详解

04-23

- 提供RESTful API和Python SDK两种接入方式 - 单节点QPS可达$1.2 \times 10^3$（配备NVIDIA T4 GPU） ## 三、使用指南 ### 3.1 快速启动 ```python from ragflow import RAGPipeline # 初始化处理管道 pipeline...

RAGFlow 详解

AngelCryToo的专栏

09-25

4497

RAGFlow 提供了一种强大的方式，将信息检索与文本生成结合起来，适用于需要动态内容生成的各种场景。虽然它在使用上可能有一定的学习曲线，但其灵活性和能力使其在现代自然语言处理任务中占据了重要地位。相比之下，其他框架如 Discord、Gradio、LangChain 等则各具特点，适用于不同的使用场景和需求。在选择框架时，可以根据具体的项目需求和资源情况来进行权衡。

Python脚本调用 RAGflow 的 “GMP知识库“ API 接口进行问答

xuukai的博客

03-19

1221

在 API 请求中添加了状态码检查和异常处理，确保程序在遇到错误时能够友好地提示用户。提供了一个简单的命令行界面，用户可以连续输入问题，直到输入 'exit' 退出程序。如果你的知识库 ID 或 API 密钥不正确，请求将失败，请确保它们的正确性。将 API 地址、授权信息和知识库名称等配置集中到代码顶部，方便修改和维护。根据实际需求，可以对代码进行扩展，例如添加会话管理、错误重试等功能。将功能分解为多个函数，提高代码的可读性和可维护性。使用有意义的函数名和变量名，使代码逻辑更清晰。

【RAGFlow】Ubuntu系统下实现源码启动RAGFlow

kewaqi618的博客

07-15

1万+

RAGFlow 可以为各种规模的企业及个人提供一套精简的 RAG 工作流程，结合大语言模型（LLM）针对用户各类不同的复杂格式数据提供可靠的问答以及有理有据的引用。因为官方提供了快速搭建平台使用docker容器技术，但我们不想使用docker容器搭建，所以就尝试直接在Ubuntu系统环境下直接启动源码的方式实现。

十分钟吃透 RAGFlow：从入门到精通，手把手教你搭建 RAG 知识库”

python12345_的博客

07-08

4018

十分钟吃透 RAGFlow：从入门到精通，手把手教你搭建 RAG 知识库”

RAGFlow

AI工程化、开源分享、文档翻译、代码笔记

04-30

3891

RAGFlow 可以为各种规模的企业及个人提供一套精简的 RAG 工作流程，结合大语言模型（LLM）针对用户各类不同的复杂格式数据提供可靠的问答以及有理有据的引用。上面这个例子中，您只需输入 http://IP_OF_YOUR_MACHINE 即可：未改动过配置则无需输入端口（默认的 HTTP 服务端口 80）。5、在你的浏览器中输入你的服务器对应的 IP 地址并登录 RAGFlow。你的改动会在下次系统重启时被重置。栏填写和你选择的大模型相对应的 API key。文件当中列出来的环境变量的值与。

【Ragflow】5.看完Python API文档，竟然成为了官方仓库的Contributor

兴趣使然的创作者

03-27

3364

本文将对Ragflow pythonAPI文档进行中文化梳理，主要根据原文档对主要功能模块的example进行梳理，对于详细参数，可根据英文标识进一步参考原文档。

RAGFlow: 一个完整的RAG使用解决方案（附教程）

瓦罗兰特顶级C位的博客

03-12

2957

RAGFlow 是一款基于深度文档理解构建的开源 RAG（Retrieval-Augmented Generation）引擎。RAGFlow 可以为各种规模的企业及个人提供一套精简的 RAG 工作流程，结合大语言模型（LLM）针对用户各类不同的复杂格式数据提供可靠的问答以及有理有据的引用。

深入讲解一下 RAGFlow 这个开源项目

u011091936的博客

07-24

1397

RAGFlow 不仅仅是一个简单的代码库，而是一个精心设计的、产品化的 RAG 平台。它的最大亮点在于将学术界先进的文档版面分析技术（deepdoc）工程化，并与一个完整的、易于部署的 RAG 工作流相结合，从根本上解决了传统 RAG 在处理非结构化和半结构化文档时的质量瓶颈。如果你需要为一个企业构建一个处理复杂报告、合同、手册等文档的 RAG 应用，RAGFlow 绝对是一个值得深入研究和使用的优秀开源项目。