# KnowFlow

**Repository Path**: XimoKB/KnowFlow

## Basic Information

- **Project Name**: KnowFlow
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: feature_knowledge_managment
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-31
- **Last Updated**: 2025-07-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">
  <img src="assets/logo.png" width="108" height="124" alt="KnowFlow 企业知识库">
</div>

## 项目介绍

KnowFlow 是一个基于 RAGFlow 的开源项目，持续兼容 RAGFlow 官方版本，同时会将社区里做的比较好的最佳实践整合进来。
KnowFlow 可以理解成 RAGFlow 官方开源产品真正落地企业场景的最后一公里服务。

## 功能介绍

### 一. 用户后台管理系统 

参考 [ragflow-plus](https://github.com/zstar1003/ragflow-plus/)

<div align="center">
  <img src="assets/user-setting.png"  alt="用户后台管理系统">
</div>

移除原登陆页用户注册的通道，搭建用户后台管理系统，可对用户进行管理，包括用户管理、团队管理、用户模型配置管理等功能。

特点：新建用户时，新用户会自动加入创建时间最早用户的团队，并默认采取和最早用户相同的模型配置。

### 二. 支持回答结果图文混排 

1. 能够回答结果图文混排，可将回答结果中的图片和文本进行混排，以增强回答的可读性。后续将持续支持表格、图标等格式，增强其结构化输出能力。
2. 支持自定义 chunk 以及分块坐标溯源
3. 支持 RAGFlow 添加的文档在 KnowFlow 进行一键解析

<div align="center">
  <img src="assets/mulcontent.png"  alt="图文混排">
</div>


### 三. 支持对接企业微信应用 

支持企业微信应用，可将企业微信应用作为聊天机器人，使用企业微信应用进行聊天。具体使用方式参照  `server/services/knowflow/README.md` 中的说明。

<div align="center">
  <img src="assets/wecom.jpg" style="height: 400px;" alt="企业微信应用">
</div>


## 使用方式

### 用户后台管理系统

#### 1. 使用Docker Compose运行

和运行 ragflow 原始项目一样，项目根目录下执行

```bash
docker compose -f docker/docker-compose.yml up -d
```
访问地址：`服务器ip:80`，进入到ragflow原始界面

访问地址：`服务器ip:8888`，进入到管理界面


#### 2. 源码运行

也可以通过下面的方式单独运行管理系统

启动后端：

1.打开后端程序`management/server`，安装依赖

```bash
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```

2.启动后端

```bash
python app.py
```

启动前端：

1.打开前端程序`management\web`，安装依赖
```bash
pnpm i
```

2.启动前端程序
```bash
pnpm dev
```

浏览器访问启动后的地址，即可进入系统。


---

### 二. 支持回答结果图文混排 

> [!注意]  
> 1. 需要提前安装好 MinerU 以及下载模型  https://github.com/opendatalab/mineru?tab=readme-ov-file#1-install-magic-pdf
> 2. 项目根目录下新建 `.env` 文件，添加如下内容
> ```bash
> RAGFLOW_API_KEY=  从 RAGFlow 后台获取
> RAGFLOW_SERVER_IP= 从 RAGFlow 后台获取
> ```
> 3. 如 MySQL、MINIO、ELASTIC 需要配置，也统一在上述  `.env` 进行配置


1. 在前端上传 PDF 文档，点击解析，等待解析完成。

<div align="center">
  <img src="assets/pdf_helper.png"  alt="文档解析">
</div>

2. 解析完成后，在 RAGFlow 知识库页面检查文档解析状态

3. 新建聊天助手，引用知识库，添加提示词，注意提示词很重要，配置不正确会无法显示图片。模板如下

>   请参考{knowledge}内容回答用户问题。
>   如果知识库内容包含图片，请在回答中包含图片URL。
>   注意这个 html 格式的 URL 是来自知识库本身，URL 不能做任何改动。
>   示例如下：<img src="http://172.21.4.35:8000/images/filename.png" alt="图片" width="300">。
>   请确保回答简洁、专业，将图片自然地融入回答内容中。

<div align="center">
  <img src="assets/pdf_chat.png"  alt="聊天">
</div>



## TODO
- [ ] 支持更多格式的混排，如表格、图标等，同时支持可视化界面上传文档 [doing]
- [ ] RAGFlow UI 重构：重构 RAGFlow UI，提供更友好的交互体验。[done]


## 交流群
如果有其它需求或问题建议，可加入交流群进行讨论。

如需加群，加我微信 skycode007，备注"加群"即可。


## 鸣谢

本项目基于以下开源项目开发：

- [ragflow](https://github.com/infiniflow/ragflow)

- [v3-admin-vite](https://github.com/un-pany/v3-admin-vite)

- [ragflow-plus](https://github.com/zstar1003/ragflow-plus/)

## 更新信息获取

目前该项目仍在持续更新中，更新日志会在我的微信公众号[KnowFlow 企业知识库]上发布，欢迎关注。