# dify-ragflow-kb-adapter

**Repository Path**: changkeke/dify-ragflow-kb-adapter

## Basic Information

- **Project Name**: dify-ragflow-kb-adapter
- **Description**: 这是一个将 RagFlow 作为 Dify 外部知识库的 API 适配服务，基于 FastAPI 实现。
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-03-24
- **Last Updated**: 2025-10-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Dify-RagFlow-KB-Adapter

这是一个将 RagFlow 作为 Dify 外部知识库的 API 适配服务，基于 FastAPI 实现。

## 功能特点

- 符合 Dify 外部知识库 API 规范
- 连接 RagFlow 作为后端检索引擎
- 提供标准化的搜索和文档获取接口
- 支持 Docker 容器化部署

## 快速开始

## 配置

1. 复制 `.env.example` 文件并重命名为 `.env`：
   ```bash
   cp .env.example .env
   ```

2. 编辑 `.env` 文件，根据您的环境设置相应的值。

## 配置选项

可以通过以下环境变量配置服务：

- `RAGFLOW_API_ENDPOINT`: RagFlow API 端点地址
- `RAGFLOW_API_KEY`: RagFlow API 密钥
- `API_PORT`: 服务监听端口，默认为 18121
- `DEBUG`: 是否启用调试模式，默认为 False

### 使用 uv 配置环境和依赖

```bash
# 安装 uv (如果尚未安装)
pip install uv -i https://pypi.tuna.tsinghua.edu.cn/simple

# 创建虚拟环境并安装依赖
uv venv
uv pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple

# 激活虚拟环境
# Windows
.venv\Scripts\activate
# Linux/MacOS
source .venv/bin/activate
```

### 运行服务

```bash
# 设置环境变量（可选）
export RAGFLOW_API_ENDPOINT="http://your-ragflow-endpoint"
export RAGFLOW_API_KEY="your-ragflow-api-key"

# 启动服务
uvicorn app.main:app --host 0.0.0.0 --port 18121
```

### 使用 Docker Compose 部署

```bash
docker-compose up -d
```

## API 端点

- `POST /retrieval`: 检索接口，符合 Dify 外部知识库规范。用于根据查询从 RagFlow 获取相关文档。

## 在 Dify 中配置

1. 在 Dify 中，转到知识库设置
2. 选择"添加外部知识库"
3. 输入此适配器服务的 URL（例如 `http://your-server:18121/api`）
4. 完成配置并测试连接

## 许可证

MIT