github-starred/open-webui
2
0
Fork 0
mirror of https://github.com/open-webui/open-webui.git synced 2026-07-16 23:21:44 -05:00
Code Issues 2.4k Packages Projects Releases 129 Wiki Activity

[PR #12562] [MERGED] fix: Correct Citations for knowledge base models #9767

New Issue
Closed
opened 2025-11-11 18:30:54 -06:00 by GiteaMirror · 0 comments
GiteaMirror commented 2025-11-11 18:30:54 -06:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/12562
Author: @almajo
Created: 4/7/2025
Status: ✅ Merged
Merged: 4/10/2025
Merged by: @tjbck

Base: dev ← Head: fix/agrimm/correct_knowledge_base_citations

📝 Commits (2)

  • d8a7e9c fix: correct document citation
  • 1e7a364 ~ update to latest change

📊 Changes

1 file changed (+7 additions, -3 deletions)

View changed files

📝 backend/open_webui/utils/middleware.py (+7 -3)

📄 Description

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

The RAG-pipeline was not citing correctly when using a model equipped with one or more knowledge bases. This small change corrects the citations by giving the model the actual document id of the chunk-context-source (instead of the knowledge base id). This works all the way through frontend citation parsing due to the consistent order of the source objects.

Cases citation might break: When the metadata.name is not unique within the sources (e.g. multiple files with the same ' name'). Then the deduplication step in citation rendering takes some sources out and the numbers are not aligned any more.

Fixed

  • Using the deduplicated document id when creating context for the LLM

Manual tests:

  • Using model with knowledge base
  • Using model with > 1 knowledge bases
  • Uploading 1 file directly in chat
  • Uploading >1 files directly in chat

All manual tests used correct citations of the relevant source.

Breaking Changes

  • BREAKING CHANGE: None

Additional Information

This has been topic of this discussion https://github.com/open-webui/open-webui/discussions/11599 but was not furtherly taken care of.

Additional discussion: https://github.com/open-webui/open-webui/discussions/10595

🔄 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/12562 **Author:** [@almajo](https://github.com/almajo) **Created:** 4/7/2025 **Status:** ✅ Merged **Merged:** 4/10/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `fix/agrimm/correct_knowledge_base_citations` --- ### 📝 Commits (2) - [`d8a7e9c`](https://github.com/open-webui/open-webui/commit/d8a7e9c660a0c5115c578fd092aee70b8f2bccaf) fix: correct document citation - [`1e7a364`](https://github.com/open-webui/open-webui/commit/1e7a36478bc4cf36caa85f4944740fbfeef3d7e7) ~ update to latest change ### 📊 Changes **1 file changed** (+7 additions, -3 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/utils/middleware.py` (+7 -3) </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) 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. - [ ] **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](https://keepachangelog.com/) is added at the bottom of the PR description. - [ ] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/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? - [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? - [ ] **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 The RAG-pipeline was not citing correctly when using a model equipped with one or more knowledge bases. This small change corrects the citations by giving the model the actual document id of the chunk-context-source (instead of the knowledge base id). This works all the way through frontend citation parsing due to the consistent order of the source objects. Cases citation might break: When the metadata.name is not unique within the sources (e.g. multiple files with the same ' name'). Then the deduplication step in citation rendering takes some sources out and the numbers are not aligned any more. ### Fixed - Using the deduplicated document id when creating context for the LLM ### Manual tests: - Using model with knowledge base - Using model with > 1 knowledge bases - Uploading 1 file directly in chat - Uploading >1 files directly in chat All manual tests used correct citations of the relevant source. ### Breaking Changes - **BREAKING CHANGE**: None --- ### Additional Information This has been topic of this discussion https://github.com/open-webui/open-webui/discussions/11599 but was not furtherly taken care of. Additional discussion: https://github.com/open-webui/open-webui/discussions/10595 --- <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 2025-11-11 18:30:54 -06: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#9767
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?