ba92649a98
- Rename plugin from `folder-rule-collector` to `folder-memory` for better clarity. - Refactor code to focus on "Project Rules" collection, removing "Knowledge" collection for V1. - Add `PRIORITY` valve (default: 20) to ensure execution after context compression. - Update all parameter names to uppercase for consistency. - Update documentation (README, global docs) with GitHub raw URL for demo image. - Remove `STATUS` valve as it's redundant with OpenWebUI's built-in function toggle. - Add `ROADMAP.md` to track future "Project Knowledge" features. - Update `.github/copilot-instructions.md` with detailed commit message guidelines.
Filters
English | 中文
Filters process and modify user input before it is sent to the LLM. This directory contains various filters that can be used to extend OpenWebUI functionality.
📋 Filter List
| Filter Name | Description | Documentation |
|---|---|---|
| Async Context Compression | Reduces token consumption in long conversations through intelligent summarization and message compression while maintaining conversational coherence. | English / 中文 |
🚀 Quick Start
Installing a Filter
- Navigate to the desired filter directory
- Download the corresponding
.pyfile to your local machine - Open OpenWebUI Admin Settings and find the "Filters" section
- Upload the Python file
- Configure the filter parameters according to its documentation
- Refresh the page and enable the filter in your chat settings
📖 Development Guide
When adding a new filter, please follow these steps:
- Create Filter Directory: Create a new folder in the current directory (e.g.,
my_filter/) - Write Filter Code: Create a
.pyfile with clear documentation of functionality and configuration in comments - Write Documentation:
- Create
filter_name.md(English version) - Create
filter_name_cn.md(Chinese version) - Documentation should include: feature description, configuration parameters, usage examples, and troubleshooting
- Create
- Update This List: Add your new filter to the table above
⚙️ Configuration Best Practices
- Priority Management: Set appropriate filter priority to ensure correct execution order
- Parameter Tuning: Adjust filter parameters based on your specific needs
- Debug Logging: Enable debug mode during development, disable in production
- Performance Testing: Test filter performance under high load
Contributor Note: To ensure project maintainability and user experience, please provide clear and complete documentation for each new filter, including feature description, parameter configuration, usage examples, and troubleshooting guide.
Author
Fu-Jie GitHub: Fu-Jie/awesome-openwebui