66 lines
2.7 KiB
Markdown
66 lines
2.7 KiB
Markdown
# Pipes（管道插件）
|
||
|
||
[English](./README.md) | 中文
|
||
|
||
管道插件（Pipes）在 LLM 生成响应后、展示给用户前对响应进行处理和增强。此目录包含可用于扩展 OpenWebUI 功能的各种管道插件。
|
||
|
||
## 📋 管道插件列表
|
||
|
||
| 插件名称 | 描述 | 文档 |
|
||
| :------------- | :------------------------------------------------------- | :-------------------------------------------------------------------------- |
|
||
| **示例管道** | 创建管道插件的模板/示例 | [中文](./example-pipe/README_CN.md) / [English](./example-pipe/README.md) |
|
||
| **AI代理管道** | 将AI响应转换为完整的代理工作流程，包含多轮思考和工具调用 | [中文](./ai-agent-pipe/README_CN.md) / [English](./ai-agent-pipe/README.md) |
|
||
|
||
## 🎯 什么是管道插件？
|
||
|
||
管道插件对 LLM 的输出进行处理，可以：
|
||
|
||
- 格式化响应（转换为 Markdown、JSON、表格等）
|
||
- 用附加信息增强响应
|
||
- 翻译或转换内容
|
||
- 在显示前过滤或修改内容
|
||
- 添加水印或元数据
|
||
- 与外部服务集成
|
||
|
||
管道在 LLM 生成响应之后、用户看到响应之前执行。
|
||
|
||
## 🚀 快速开始
|
||
|
||
### 安装管道插件
|
||
|
||
1. 将插件文件（`.py`）下载到本地
|
||
2. 在 OpenWebUI 管理员设置中，找到"Plugins"部分
|
||
3. 选择"Pipes"类型
|
||
4. 上传下载的文件
|
||
5. 刷新页面并在聊天设置中启用管道
|
||
6. 该管道将应用于所有后续的 LLM 响应
|
||
|
||
## 📖 开发指南
|
||
|
||
添加新管道插件时，请遵循以下步骤：
|
||
|
||
1. **创建插件目录**：在 `plugins/pipes/` 下创建新文件夹（例如 `my_pipe/`）
|
||
2. **编写插件代码**：创建 `.py` 文件，清晰记录功能说明
|
||
3. **编写文档**：
|
||
- 创建 `README.md`（英文版）
|
||
- 创建 `README_CN.md`（中文版）
|
||
- 包含：功能说明、配置方法、使用示例和故障排除
|
||
4. **更新此列表**：在上述表格中添加您的插件
|
||
|
||
## ⚙️ 管道开发最佳实践
|
||
|
||
- **非阻塞操作**：保持管道处理快速以避免 UI 延迟
|
||
- **错误处理**：优雅地处理错误而不破坏响应
|
||
- **配置灵活性**：使管道可配置以适应不同用例
|
||
- **性能优化**：使用大型响应测试以确保效率
|
||
- **文档完整**：提供清晰的示例和故障排除指南
|
||
|
||
---
|
||
|
||
> **贡献者注意**：我们欢迎贡献新的管道插件！请为每个新增插件提供清晰完整的文档，包括功能说明、配置方法、使用示例和故障排除指南。
|
||
|
||
## 作者
|
||
|
||
Fu-Jie
|
||
GitHub: [Fu-Jie/openwebui-extensions](https://github.com/Fu-Jie/openwebui-extensions)
|