github-starred/open-webui
2
0
Fork 0
mirror of https://github.com/open-webui/open-webui.git synced 2026-05-06 10:58:17 -05:00
Code Issues 1.2k Packages Projects Releases 126 Wiki Activity

[PR #20447] [CLOSED] feat: docling page numbering #25626

New Issue
Closed
opened 2026-04-20 06:02:27 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-20 06:02:27 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/20447
Author: @NikolasTh90
Created: 1/7/2026
Status: ❌ Closed

Base: dev ← Head: feature/docling-page-numbering

📝 Commits (10+)

📊 Changes

5 files changed (+1010 additions, -8 deletions)

View changed files

📝 backend/open_webui/config.py (+6 -0)
📝 backend/open_webui/retrieval/loaders/main.py (+146 -8)
➕ backend/tests/test_docling_page_extraction.py (+274 -0)
➕ docs/docling-page-extraction.md (+316 -0)
➕ test_docling_integration.py (+268 -0)

📄 Description

Pull Request Checklist

Note to first-time contributors: Please open a discussion post in Discussions to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request.

This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR.

Before submitting, make sure you've checked the following:

  • Target branch: Verify that the pull request targets the dev branch. Not targeting the dev branch will lead to immediate closure of the PR.
  • Description: Provide a concise description of the changes made in this pull request down below.
  • Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
  • Documentation: If necessary, update relevant documentation Open WebUI Docs like environment variables, the tutorials, or other documentation sources.
  • Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation? (No new dependencies)
  • Testing: Perform manual tests to verify the implemented fix/feature works as intended AND does not break any other functionality. Take this as an opportunity to make screenshots of the feature/fix and include it in the PR description.
  • Agentic AI Code: Confirm this Pull Request is not written by any AI Agent or has at least gone through additional human review AND manual testing. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR.
  • 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?
  • Title 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

Enhanced Docling OCR integration to support page-level citations, improving user experience by providing specific page references in document citations. This feature brings Docling OCR in line with other OCR engines like Mistral OCR, enabling consistent citation behavior across different document processing engines.

Added

  • Page-level document extraction from Docling JSON response for OCR integration
  • DOCLING_EXTRACT_PAGES environment variable to enable/disable page extraction (default: true)
  • Comprehensive page metadata including page number, page label, total pages, and file information
  • Graceful fallback mechanism to markdown processing when JSON extraction fails
  • Complete test suite with 9 unit tests covering all functionality and edge cases
  • Documentation page explaining configuration, usage, and troubleshooting
  • Integration tests for end-to-end workflow verification

Changed

  • Enhanced DoclingLoader class in backend/open_webui/retrieval/loaders/main.py to parse structured JSON responses
  • Updated backend/open_webui/config.py to include new DOCLING_EXTRACT_PAGES configuration option
  • Modified document processing workflow to create separate Document objects per page when enabled

Deprecated

  • No deprecated functionality

Removed

  • No removed features

Fixed

  • Enhanced error handling for Docling API failures
  • Improved document metadata consistency across different OCR engines

Security

  • No security changes

Breaking Changes

  • No breaking changes - fully backwards compatible with existing deployments

Additional Information

This enhancement addresses the community need for page-specific citations when using Docling OCR. Previously, Docling-processed documents appeared as single text blocks without page references, making it difficult for users to locate specific content. With this change:

  • Each page becomes a separate document chunk with rich metadata
  • Citations display "Page X of Y" information for better navigation
  • Configuration allows users to disable page extraction if needed
  • Performance impact is minimal (~10-20% additional processing time)

Related Discussion: https://github.com/open-webui/open-webui/discussions/20446

Screenshots or Videos

Screenshot of page-numbered citations:
Citations showing page numbers
(Add screenshot after testing the feature - show chat interface with citations displaying "Page 3 of 10" etc.)

Contributor License Agreement

By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), and I am providing my contributions under its terms.

Note

Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in.

🔄 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/20447 **Author:** [@NikolasTh90](https://github.com/NikolasTh90) **Created:** 1/7/2026 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `feature/docling-page-numbering` --- ### 📝 Commits (10+) - [`fe6783c`](https://github.com/open-webui/open-webui/commit/fe6783c16699911c7be17392596d579333fb110c) Merge pull request #19030 from open-webui/dev - [`fc05e0a`](https://github.com/open-webui/open-webui/commit/fc05e0a6c5d39da60b603b4d520f800d6e36f748) Merge pull request #19405 from open-webui/dev - [`e3faec6`](https://github.com/open-webui/open-webui/commit/e3faec62c58e3a83d89aa3df539feacefa125e0c) Merge pull request #19416 from open-webui/dev - [`9899293`](https://github.com/open-webui/open-webui/commit/9899293f050ad50ae12024cbebee7e018acd851e) Merge pull request #19448 from open-webui/dev - [`140605e`](https://github.com/open-webui/open-webui/commit/140605e660b8186a7d5c79fb3be6ffb147a2f498) Merge pull request #19462 from open-webui/dev - [`6f1486f`](https://github.com/open-webui/open-webui/commit/6f1486ffd0cb288d0e21f41845361924e0d742b3) Merge pull request #19466 from open-webui/dev - [`d95f533`](https://github.com/open-webui/open-webui/commit/d95f533214e3fe5beb5e41ec1f349940bc4c7043) Merge pull request #19729 from open-webui/dev - [`a727153`](https://github.com/open-webui/open-webui/commit/a7271532f8a38da46785afcaa7e65f9a45e7d753) 0.6.43 (#20093) - [`0fd71c7`](https://github.com/open-webui/open-webui/commit/0fd71c7c7032328ef6858d2576b475ab7ed35bef) feat: Add page numbering for Docling OCR citations - [`3c90f74`](https://github.com/open-webui/open-webui/commit/3c90f741ad74fb707d48d86bf2d7ecfd4c85eb1b) style: Apply black code formatting to Python files ### 📊 Changes **5 files changed** (+1010 additions, -8 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/config.py` (+6 -0) 📝 `backend/open_webui/retrieval/loaders/main.py` (+146 -8) ➕ `backend/tests/test_docling_page_extraction.py` (+274 -0) ➕ `docs/docling-page-extraction.md` (+316 -0) ➕ `test_docling_integration.py` (+268 -0) </details> ### 📄 Description # Pull Request Checklist ### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request. This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR. **Before submitting, make sure you've checked the following:** - [x] **Target branch:** Verify that the pull request targets the `dev` branch. **Not targeting the `dev` branch will lead to immediate closure of the PR.** - [x] **Description:** Provide a concise description of the changes made in this pull request down below. - [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:** If necessary, update relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs) like environment variables, the tutorials, or other documentation sources. - [x] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? (No new dependencies) - [x] **Testing:** Perform manual tests to **verify the implemented fix/feature works as intended AND does not break any other functionality**. Take this as an opportunity to **make screenshots of the feature/fix and include it in the PR description**. - [x] **Agentic AI Code:** Confirm this Pull Request is **not written by any AI Agent** or has at least **gone through additional human review AND manual testing**. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR. - [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] **Title 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 Enhanced Docling OCR integration to support page-level citations, improving user experience by providing specific page references in document citations. This feature brings Docling OCR in line with other OCR engines like Mistral OCR, enabling consistent citation behavior across different document processing engines. ### Added - Page-level document extraction from Docling JSON response for OCR integration - `DOCLING_EXTRACT_PAGES` environment variable to enable/disable page extraction (default: true) - Comprehensive page metadata including page number, page label, total pages, and file information - Graceful fallback mechanism to markdown processing when JSON extraction fails - Complete test suite with 9 unit tests covering all functionality and edge cases - Documentation page explaining configuration, usage, and troubleshooting - Integration tests for end-to-end workflow verification ### Changed - Enhanced `DoclingLoader` class in `backend/open_webui/retrieval/loaders/main.py` to parse structured JSON responses - Updated `backend/open_webui/config.py` to include new `DOCLING_EXTRACT_PAGES` configuration option - Modified document processing workflow to create separate Document objects per page when enabled ### Deprecated - No deprecated functionality ### Removed - No removed features ### Fixed - Enhanced error handling for Docling API failures - Improved document metadata consistency across different OCR engines ### Security - No security changes ### Breaking Changes - No breaking changes - fully backwards compatible with existing deployments --- ### Additional Information This enhancement addresses the community need for page-specific citations when using Docling OCR. Previously, Docling-processed documents appeared as single text blocks without page references, making it difficult for users to locate specific content. With this change: - Each page becomes a separate document chunk with rich metadata - Citations display "Page X of Y" information for better navigation - Configuration allows users to disable page extraction if needed - Performance impact is minimal (~10-20% additional processing time) Related Discussion: https://github.com/open-webui/open-webui/discussions/20446 ### Screenshots or Videos Screenshot of page-numbered citations: ![Citations showing page numbers](https://example.com/screenshot-url) *(Add screenshot after testing the feature - show chat interface with citations displaying "Page 3 of 10" etc.)* ### Contributor License Agreement By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](https://github.com/open-webui/open-webui/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms. > [!NOTE] > Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-20 06:02:27 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
confirmed
confirmed issue
core
documentation
enhancement
good first issue
help wanted
non-core
pull-request
Mirrored from GitHub Pull Request
 python
question
testing wanted
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#25626
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?