Implements a configurable pipeline for transforming document content during the loading process.
Changes:
Added support for document function type in the plugin system Created prioritized processing pipeline for document content Added robust validation and error handling for processor functions Included sample document processor that removes common artifacts from imported documents
Document processors can be created as standard plugins and will be applied to all loaded documents when active. Processing order is determined by the priority valve setting.
Sample document processor:
import re
import logging
from pydantic import BaseModel, Field
from open_webui.env import SRC_LOG_LEVELS
log = logging.getLogger(__name__)
log.setLevel(SRC_LOG_LEVELS["MAIN"])
class Document:
"""
Document cleaner that removes common artifacts from imported documents.
This processor cleans up document text by removing:
- Document banners (CONFIDENTIAL, INTERNAL, DRAFT)
- Page numbers and footers
- Excessive whitespace and line breaks
"""
class Valves(BaseModel):
priority: int = Field(default=0, description="Processing priority (lower numbers run first)")
def __init__(self):
self.valves = self.Valves()
def process(self, text: str) -> str:
"""
Clean document text by removing common artifacts.
Args:
text: Original document text
Returns:
Cleaned document text
"""
if not text or not isinstance(text, str):
return text
# Remove banners like "## INTERNAL ##", "**CONFIDENTIAL**", etc.
text = re.sub(
r"^\s*[#*\-]*\s*(internal|confidential|draft)\s*[#*\-]*\s*$",
"",
text,
flags=re.IGNORECASE | re.MULTILINE,
)
# Remove footers like "page 3 of 10"
text = re.sub(r"page\s*\d+\s*of\s*\d+", "", text, flags=re.IGNORECASE)
# Collapse excessive empty lines
text = re.sub(r"\n\s*\n+", "\n\n", text)
return text.strip()
Pull Request Checklist
Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
Target branch: Please verify that the pull request targets the dev branch.
Description: Provide a concise description of the changes made in this pull request.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Have you updated relevant documentation Open WebUI Docs, or other documentation sources?
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Have you written and run sufficient tests to validate the changes?
Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Prefix: To clearly categorize this pull request, prefix the pull request title using one of the following:
BREAKING CHANGE: Significant changes that may affect compatibility
build: Changes that affect the build system or external dependencies
ci: Changes to our continuous integration processes or workflows
chore: Refactor, cleanup, or other non-functional code changes
docs: Documentation update or addition
feat: Introduces a new feature or enhancement to the codebase
fix: Bug fix or error correction
i18n: Internationalization or localization changes
perf: Performance improvement
refactor: Code restructuring for better maintainability, readability, or scalability
style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
test: Adding missing tests or correcting existing tests
WIP: Work in progress, a temporary label for incomplete or ongoing work
Changelog Entry
Description
Implements a configurable pipeline for transforming document content during the loading process.
Added
Added support for document function type in the plugin system Created prioritized processing pipeline for document content Added robust validation and error handling for processor functions Included sample document processor that removes common artifacts from imported documents
Document processors can be created as standard plugins and will be applied to all loaded documents when active. Processing order is determined by the priority valve setting.
Breaking Changes
BREAKING CHANGE: NONE
Additional Information
I will update docs soon and provide the PR to docs as well.
Sample document processor:
import re
import logging
from pydantic import BaseModel, Field
from open_webui.env import SRC_LOG_LEVELS
log = logging.getLogger(__name__)
log.setLevel(SRC_LOG_LEVELS["MAIN"])
class Document:
"""
Document cleaner that removes common artifacts from imported documents.
This processor cleans up document text by removing:
- Document banners (CONFIDENTIAL, INTERNAL, DRAFT)
- Page numbers and footers
- Excessive whitespace and line breaks
"""
class Valves(BaseModel):
priority: int = Field(default=0, description="Processing priority (lower numbers run first)")
def __init__(self):
self.valves = self.Valves()
def process(self, text: str) -> str:
"""
Clean document text by removing common artifacts.
Args:
text: Original document text
Returns:
Cleaned document text
"""
if not text or not isinstance(text, str):
return text
# Remove banners like "## INTERNAL ##", "**CONFIDENTIAL**", etc.
text = re.sub(
r"^\s*[#*\-]*\s*(internal|confidential|draft)\s*[#*\-]*\s*$",
"",
text,
flags=re.IGNORECASE | re.MULTILINE,
)
# Remove footers like "page 3 of 10"
text = re.sub(r"page\s*\d+\s*of\s*\d+", "", text, flags=re.IGNORECASE)
# Collapse excessive empty lines
text = re.sub(r"\n\s*\n+", "\n\n", text)
return text.strip()
Screenshots or Videos
Contributor License Agreement
By submitting this pull request, I confirm that I have read and fully agree to the CONTRIBUTOR_LICENSE_AGREEMENT, and I am providing my contributions under its terms.
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.
## 📋 Pull Request Information
**Original PR:** https://github.com/open-webui/open-webui/pull/13479
**Author:** [@athoik](https://github.com/athoik)
**Created:** 5/4/2025
**Status:** ❌ Closed
**Base:** `dev` ← **Head:** `dev`
---
### 📝 Commits (2)
- [`fecd2db`](https://github.com/open-webui/open-webui/commit/fecd2dba4a5be8350978d1624fa4987a2b7fda18) feat: Add Document Processing System
- [`35a5d68`](https://github.com/open-webui/open-webui/commit/35a5d6834be31600d9fae869611deed2ea21cbaf) feat: support context-aware document processors with full file metadata
### 📊 Changes
**2 files changed** (+102 additions, -0 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/open_webui/retrieval/loaders/main.py` (+100 -0)
📝 `backend/open_webui/utils/plugin.py` (+2 -0)
</details>
### 📄 Description
Implements a configurable pipeline for transforming document content during the loading process.
Changes:
Added support for document function type in the plugin system Created prioritized processing pipeline for document content Added robust validation and error handling for processor functions Included sample document processor that removes common artifacts from imported documents
Document processors can be created as standard plugins and will be applied to all loaded documents when active. Processing order is determined by the priority valve setting.
Sample document processor:
```
import re
import logging
from pydantic import BaseModel, Field
from open_webui.env import SRC_LOG_LEVELS
log = logging.getLogger(__name__)
log.setLevel(SRC_LOG_LEVELS["MAIN"])
class Document:
"""
Document cleaner that removes common artifacts from imported documents.
This processor cleans up document text by removing:
- Document banners (CONFIDENTIAL, INTERNAL, DRAFT)
- Page numbers and footers
- Excessive whitespace and line breaks
"""
class Valves(BaseModel):
priority: int = Field(default=0, description="Processing priority (lower numbers run first)")
def __init__(self):
self.valves = self.Valves()
def process(self, text: str) -> str:
"""
Clean document text by removing common artifacts.
Args:
text: Original document text
Returns:
Cleaned document text
"""
if not text or not isinstance(text, str):
return text
# Remove banners like "## INTERNAL ##", "**CONFIDENTIAL**", etc.
text = re.sub(
r"^\s*[#*\-]*\s*(internal|confidential|draft)\s*[#*\-]*\s*$",
"",
text,
flags=re.IGNORECASE | re.MULTILINE,
)
# Remove footers like "page 3 of 10"
text = re.sub(r"page\s*\d+\s*of\s*\d+", "", text, flags=re.IGNORECASE)
# Collapse excessive empty lines
text = re.sub(r"\n\s*\n+", "\n\n", text)
return text.strip()
```
# Pull Request Checklist
### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) and describe your changes before submitting a pull request.
**Before submitting, make sure you've checked the following:**
- [x] **Target branch:** Please verify that the pull request targets the `dev` branch.
- [x] **Description:** Provide a concise description of the changes made in this pull request.
- [x] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description.
- [x] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources?
- [x] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation?
- [x] **Testing:** Have you written and run sufficient tests to validate the changes?
- [x] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
- [x] **Prefix:** To clearly categorize this pull request, prefix the pull request title using one of the following:
- **BREAKING CHANGE**: Significant changes that may affect compatibility
- **build**: Changes that affect the build system or external dependencies
- **ci**: Changes to our continuous integration processes or workflows
- **chore**: Refactor, cleanup, or other non-functional code changes
- **docs**: Documentation update or addition
- **feat**: Introduces a new feature or enhancement to the codebase
- **fix**: Bug fix or error correction
- **i18n**: Internationalization or localization changes
- **perf**: Performance improvement
- **refactor**: Code restructuring for better maintainability, readability, or scalability
- **style**: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
- **test**: Adding missing tests or correcting existing tests
- **WIP**: Work in progress, a temporary label for incomplete or ongoing work
# Changelog Entry
### Description
Implements a configurable pipeline for transforming document content during the loading process.
### Added
Added support for document function type in the plugin system Created prioritized processing pipeline for document content Added robust validation and error handling for processor functions Included sample document processor that removes common artifacts from imported documents
Document processors can be created as standard plugins and will be applied to all loaded documents when active. Processing order is determined by the priority valve setting.
### Breaking Changes
- **BREAKING CHANGE**: NONE
---
### Additional Information
I will update docs soon and provide the PR to docs as well.
Sample document processor:
```
import re
import logging
from pydantic import BaseModel, Field
from open_webui.env import SRC_LOG_LEVELS
log = logging.getLogger(__name__)
log.setLevel(SRC_LOG_LEVELS["MAIN"])
class Document:
"""
Document cleaner that removes common artifacts from imported documents.
This processor cleans up document text by removing:
- Document banners (CONFIDENTIAL, INTERNAL, DRAFT)
- Page numbers and footers
- Excessive whitespace and line breaks
"""
class Valves(BaseModel):
priority: int = Field(default=0, description="Processing priority (lower numbers run first)")
def __init__(self):
self.valves = self.Valves()
def process(self, text: str) -> str:
"""
Clean document text by removing common artifacts.
Args:
text: Original document text
Returns:
Cleaned document text
"""
if not text or not isinstance(text, str):
return text
# Remove banners like "## INTERNAL ##", "**CONFIDENTIAL**", etc.
text = re.sub(
r"^\s*[#*\-]*\s*(internal|confidential|draft)\s*[#*\-]*\s*$",
"",
text,
flags=re.IGNORECASE | re.MULTILINE,
)
# Remove footers like "page 3 of 10"
text = re.sub(r"page\s*\d+\s*of\s*\d+", "", text, flags=re.IGNORECASE)
# Collapse excessive empty lines
text = re.sub(r"\n\s*\n+", "\n\n", text)
return text.strip()
```
### Screenshots or Videos
### Contributor License Agreement
By submitting this pull request, I confirm that I have read and fully agree to the [CONTRIBUTOR_LICENSE_AGREEMENT](CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms.
---
<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
📋 Pull Request Information
Original PR: https://github.com/open-webui/open-webui/pull/13479
Author: @athoik
Created: 5/4/2025
Status: ❌ Closed
Base:
dev← Head:dev📝 Commits (2)
fecd2dbfeat: Add Document Processing System35a5d68feat: support context-aware document processors with full file metadata📊 Changes
2 files changed (+102 additions, -0 deletions)
View changed files
📝
backend/open_webui/retrieval/loaders/main.py(+100 -0)📝
backend/open_webui/utils/plugin.py(+2 -0)📄 Description
Implements a configurable pipeline for transforming document content during the loading process.
Changes:
Added support for document function type in the plugin system Created prioritized processing pipeline for document content Added robust validation and error handling for processor functions Included sample document processor that removes common artifacts from imported documents
Document processors can be created as standard plugins and will be applied to all loaded documents when active. Processing order is determined by the priority valve setting.
Sample document processor:
Pull Request Checklist
Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
devbranch.Changelog Entry
Description
Implements a configurable pipeline for transforming document content during the loading process.
Added
Added support for document function type in the plugin system Created prioritized processing pipeline for document content Added robust validation and error handling for processor functions Included sample document processor that removes common artifacts from imported documents
Document processors can be created as standard plugins and will be applied to all loaded documents when active. Processing order is determined by the priority valve setting.
Breaking Changes
Additional Information
I will update docs soon and provide the PR to docs as well.
Sample document processor:
Screenshots or Videos
Contributor License Agreement
By submitting this pull request, I confirm that I have read and fully agree to the CONTRIBUTOR_LICENSE_AGREEMENT, and I am providing my contributions under its terms.
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.