ragflow api

### 关于 RAGFlow API 的使用 #### 安装与基础概念 RAGFlow 是一个基于深度文档理解的开源 RAG（检索增强生成）引擎，旨在通过高效的文档处理能力提供高质量的数据服务[^1]。为了更好地利用其功能，开发者可以通过 RESTful API 接口实现对知识库和文档的操作。 --- #### 更新指定文档的配置接口 对于更新已有文档的具体操作，可以调用以下 API： - **请求方法**: `PUT` - **URL**: `/api/v1/datasets/{dataset_id}/documents/{document_id}` - `{dataset_id}`: 知识库（数据集）的唯一 ID。 - `{document_id}`: 需要更新的目标文档的唯一 ID。 ##### 请求头部 (Headers) ```json { "Content-Type": "application/json", "Authorization": "Bearer <YOUR_API_KEY>" } ``` - `"Content-Type"` 设置为 `application/json` 表明发送的是 JSON 数据。 - `"Authorization"` 字段需填写有效的 API 密钥 `<YOUR_API_KEY>` 进行身份认证[^2]。 ##### 请求体 (Body) 以下是请求体的结构： ```json { "name": "新文档名称", "chunk_method": "split_by_paragraph", "parser_config": "pdf_parser" } ``` - `"name"`: 新的文档名称字符串。 - `"chunk_method"`: 切分方式，例如按段落分割 (`split_by_paragraph`) 或其他自定义逻辑。 - `"parser_config"`: 解析器配置枚举值，具体取决于文件类型和支持的解析器。 --- #### 文件上传至知识库 除了更新现有文档外，还可以通过 API 将新的文件上传到知识库中。这一步骤允许用户将多种格式的文件转换成可用于问答的数据集。支持的文件类型包括但不限于 PDF、DOCX、TXT 和 CSV 等常见格式[^3]。 ##### 创建知识库 在正式上传前，需要先创建一个新的知识库。此过程可通过 UI 页面完成：切换到“知识库”标签页后点击“创建知识库”。随后，在该知识库的详情页面下进入“配置”选项卡设置具体的文档解析规则以及切分策略[^4]。 --- #### 示例代码片段 下面展示如何通过 Python 脚本调用上述 API 来更新文档配置： ```python import requests import json url = f"/api/v1/datasets/{dataset_id}/documents/{document_id}" headers = { "Content-Type": "application/json", "Authorization": "Bearer YOUR_API_KEY" } payload = { "name": "Updated Document Name", "chunk_method": "custom_splitter", "parser_config": "docx_parser" } response = requests.put(url, headers=headers, data=json.dumps(payload)) if response.status_code == 200: print("Document updated successfully.") else: print(f"Error updating document: {response.text}") ``` --- #### 总结 以上内容涵盖了 RAGFlow 中关于文档管理的核心 API 功能及其基本使用流程。无论是更新现有的文档属性还是新增资源，都可以借助这些标准化接口高效地集成到业务场景之中。

### 如何调用 RAGFlow API 为了成功调用RAGFlow API并将其集成到应用程序中，开发者需遵循特定的设置流程和API交互方法。通常情况下，这涉及到初始化客户端、准备请求数据以及解析响应结果。 #### 初始化客户端 在使用Python环境中，可以通过`requests`库来发起HTTP请求至RAGFlow服务器端口。确保已安装该库；如果尚未安装，则可通过pip命令完成安装： ```bash pip install requests ``` 接着，在脚本里导入必要的模块，并定义目标URL地址作为API入口点[^2]。 ```python import requests api_url = "http://localhost:8000/api/v1/query" ``` #### 准备请求体 对于大多数情况而言，向RAGFlow发送POST请求时需要提供JSON格式的数据负载。此负载应至少包含待处理文本字段以及其他可选参数配置项。下面是一个简单的例子说明如何构建这样的请求体结构。 ```json { "query": "What is the capital of France?", "params": { "top_k_retrieval": 5, "top_k_reader": 3 } } ``` 上述JSON对象中的`query`键对应于用户输入的问题字符串；而`params`部分则用于指定检索阶段(`top_k_retrieval`)及阅读理解阶段(`top_k_reader`)返回的结果数量上限。 #### 发送请求与接收响应 准备好所有必需组件之后就可以执行实际的网络通信操作了——即通过`post()`函数传递之前创建好的URL路径连同payload一起给远程服务端实例。一旦接收到回复消息，便可以从其主体内提取有用信息供后续逻辑处理之用。 ```python response = requests.post(api_url, json=query_payload) if response.status_code == 200: result = response.json() else: print(f"Error occurred with status code {response.status_code}") ``` 当状态码为200时表示请求成功，此时可以直接访问`.json()`属性获取标准化后的字典形式的回答内容；反之则表明出现了某些异常状况，应当适当地记录错误日志以便排查问题所在。