# RAGFlow-test

**Repository Path**: mingmingnamejiu/ragflow-test

## Basic Information

- **Project Name**: RAGFlow-test
- **Description**: ragflow 0.25.0 测试程序简易版
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-23
- **Last Updated**: 2026-04-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# RAGFlow 测试程序

一个基于 Flask 的 RAGFlow API 可视化测试工具，提供知识库管理、文档解析、内容检索和对话问答的全流程测试界面。

> **RAGFlow 版本：0.25.0**  
> 对话测试中 `session_id` 在代码中写死，仅用于测试目的（见 [ragflow_client.py:273](ragflow_client.py#L273)）。

## 功能特性

- **知识库管理** - 创建、查看、删除知识库
- **文档上传与解析** - 支持多格式上传，实时显示解析进度
- **内容检索** - 自定义 top_k 和相似度阈值，返回带分数的文档片段
- **对话问答** - 与知识库对话，支持会话重置
- **实时日志** - SSE 流式推送，所有操作自动记录并可导出汇总报告
- **可视化界面** - Web UI，无需命令行即可完成测试

## 项目结构

```
ragflow-test/
├── app.py              # Flask Web 服务，API 路由定义
├── ragflow_client.py   # RAGFlow SDK 封装类
├── logger.py           # 日志追踪模块，支持 SSE 流
├── config.py           # 配置管理（读取 .env）
├── requirements.txt    # Python 依赖
├── .env.example        # 环境变量模板
├── templates/
│   └── index.html      # Web 前端页面
├── uploads/            # 上传文件临时目录
├── results/            # 测试结果 JSON 输出
└── docs/
    ├── design.md       # 完整设计文档
    └── logging_design.md # 日志追踪设计文档
```

## 快速开始

### 1. 安装依赖

```bash
pip install -r requirements.txt
```

### 2. 配置环境变量

```bash
cp .env.example .env
```

编辑 `.env`，填入以下必填项：

```env
RAGFLOW_API_KEY=your_api_key_here
RAGFLOW_BASE_URL=http://localhost/api/v1
RAGFLOW_CHAT_ID=your_chat_assistant_id
```

### 3. 启动服务

```bash
python app.py
```

访问 `http://localhost:5000`

## 配置说明

| 变量 | 默认值 | 说明 |
|------|--------|------|
| `RAGFLOW_API_KEY` | — | RAGFlow API 密钥（必填） |
| `RAGFLOW_BASE_URL` | `http://localhost/api/v1` | RAGFlow 服务地址 |
| `RAGFLOW_CHAT_ID` | — | 对话助手 ID（对话测试必填） |
| `DEFAULT_TOP_K` | `5` | 检索返回条数 |
| `DEFAULT_SIMILARITY_THRESHOLD` | `0.2` | 相似度阈值 |
| `PARSE_TIMEOUT` | `120` | 文档解析超时（秒） |
| `MAX_UPLOAD_SIZE_MB` | `50` | 最大上传文件大小 |
| `FLASK_PORT` | `5000` | Web 服务端口 |

支持的文件格式：`pdf` `docx` `txt` `md` `xlsx` `pptx`

## API 端点

| 端点 | 方法 | 说明 |
|------|------|------|
| `/api/status` | GET | 检查 RAGFlow 连接状态 |
| `/api/dataset/list` | GET | 获取知识库列表 |
| `/api/dataset/create` | POST | 创建知识库 |
| `/api/dataset/<id>` | DELETE | 删除知识库 |
| `/api/document/upload` | POST | 上传文档 |
| `/api/document/list/<dataset_id>` | GET | 获取文档列表 |
| `/api/document/status/<dataset_id>/<doc_id>` | GET | 查询解析状态 |
| `/api/test/retrieval` | POST | 执行检索测试 |
| `/api/test/chat` | POST | 执行对话测试 |
| `/api/test/chat/reset` | POST | 重置对话会话 |
| `/api/logs/stream` | GET | SSE 实时日志流 |
| `/api/results/summary` | POST | 导出测试摘要 |
| `/api/results/download` | GET | 下载结果 JSON |
| `/api/config` | GET | 查看当前配置 |

## License

见 [LICENSE](LICENSE)