2025-12-20 12:34:49 +08:00
|
|
|
# Example Pipe Plugin
|
|
|
|
|
|
2026-01-03 12:25:04 +08:00
|
|
|
**Author:** OpenWebUI Community | **Version:** 1.26.0 | **License:** MIT
|
2025-12-20 12:34:49 +08:00
|
|
|
|
|
|
|
|
This is a template/example for creating Pipe plugins in OpenWebUI.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
|
|
|
|
|
Pipes are plugins that process and enhance LLM responses after they are generated and before they are displayed to the user.
|
|
|
|
|
|
|
|
|
|
## Core Features
|
|
|
|
|
|
|
|
|
|
- ✅ **Response Processing**: Modify or enhance LLM output
|
|
|
|
|
- ✅ **Format Conversion**: Convert responses to different formats
|
|
|
|
|
- ✅ **Content Filtering**: Filter or sanitize content
|
|
|
|
|
- ✅ **Integration**: Connect with external services
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
1. Download the `.py` file from this directory
|
|
|
|
|
2. Open OpenWebUI Admin Settings → Plugins
|
|
|
|
|
3. Select "Pipes" type
|
|
|
|
|
4. Upload the file
|
|
|
|
|
5. Refresh the page
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
|
|
|
|
|
|
Configure the pipe parameters in your chat settings as needed.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
Once enabled, this pipe will automatically process all LLM responses.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Troubleshooting
|
|
|
|
|
|
|
|
|
|
- Check the logs for any errors during pipe execution
|
|
|
|
|
- Ensure the pipe is properly configured
|
|
|
|
|
- Verify the pipe is enabled in chat settings
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
Feel free to create your own pipe plugins! Follow the structure and documentation guidelines in this template.
|
