Ragflow API Client

Ragflow 的通用客户端 —— 自托管的 RAG（检索增强生成）平台。

功能

• 知识库管理 —— 创建、列出、删除知识库
• 文档上传 —— 上传文件或文本内容
• 聊天查询 —— 对知识库执行 RAG 查询
• 分块管理 —— 触发解析、列出分块

使用方法

# 列出知识库
node {baseDir}/scripts/ragflow.js datasets

# 创建知识库
node {baseDir}/scripts/ragflow.js create-dataset --name "我的知识库"

# 上传文档
node {baseDir}/scripts/ragflow.js upload --dataset DATASET_ID --file article.md

# 聊天查询
node {baseDir}/scripts/ragflow.js chat --dataset DATASET_ID --query "什么是中风？"

# 列出知识库中的文档
node {baseDir}/scripts/ragflow.js documents --dataset DATASET_ID

配置

在 .env 文件中设置环境变量：

RAGFLOW_URL=https://your-ragflow-instance.com
RAGFLOW_API_KEY=your-api-key

API 接口

本技能封装了 Ragflow 的 REST API：

• GET /api/v1/datasets —— 获取知识库列表
• POST /api/v1/datasets —— 创建知识库
• DELETE /api/v1/datasets/{id} —— 删除知识库
• POST /api/v1/datasets/{id}/documents —— 上传文档
• POST /api/v1/datasets/{id}/chunks —— 触发文档解析
• POST /api/v1/datasets/{id}/retrieval —— 执行 RAG 查询

完整 API 文档：https://ragflow.io/docs

示例

// 程序化使用示例
const ragflow = require('{baseDir}/lib/api.js');

// 上传并解析文档
await ragflow.uploadDocument(datasetId, './article.md', { filename: 'article.md' });
await ragflow.triggerParsing(datasetId, [documentId]);

// 执行查询
const answer = await ragflow.chat(datasetId, '中风的指南有哪些？');