[PR #12477] [MERGED] fix: more coherent default RAG template #22925

Closed
opened 2026-04-20 04:29:42 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/12477
Author: @Ithanil
Created: 4/5/2025
Status: Merged
Merged: 4/5/2025
Merged by: @tjbck

Base: devHead: improved_rag_template


📝 Commits (1)

  • e0da600 tweak default rag template to be more coherent and improve consistency with citations

📊 Changes

1 file changed (+5 additions, -5 deletions)

View changed files

📝 backend/open_webui/config.py (+5 -5)

📄 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

I think the previous default RAG template was sometimes misleading LLMs due to the following issues:

  1. While the beginning of the template correctly spoke about <source> tags and id attributes, later it talked about <source_id> tags which do not exist. The new template is consistent in that regard
  2. It was instructed to cite like [source_id] although it wasn't exactly clear what source_id is (due to 1)). The new template instructs to cite like [id], which should be unambiguous.
  3. I think in the previous template it wasn't clear enough that the example is actually an example. I've doubled down on labelling it as an example.

Fixed

  • Default RAG template

Breaking changes

  • I think currently the RAG template won't automatically update to a new default, even if it was default.

Additional Information

Discussion https://github.com/open-webui/open-webui/discussions/10456

Screenshots or Videos

image


🔄 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/12477 **Author:** [@Ithanil](https://github.com/Ithanil) **Created:** 4/5/2025 **Status:** ✅ Merged **Merged:** 4/5/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `improved_rag_template` --- ### 📝 Commits (1) - [`e0da600`](https://github.com/open-webui/open-webui/commit/e0da6003f14043a98fe99adbf8961626d0944e9a) tweak default rag template to be more coherent and improve consistency with citations ### 📊 Changes **1 file changed** (+5 additions, -5 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/config.py` (+5 -5) </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. - [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. - [-] **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 I think the previous default RAG template was sometimes misleading LLMs due to the following issues: 1) While the beginning of the template correctly spoke about `<source>` tags and `id` attributes, later it talked about `<source_id>` tags which do not exist. The new template is consistent in that regard 2) It was instructed to cite like `[source_id]` although it wasn't exactly clear what `source_id` is (due to 1)). The new template instructs to cite like `[id]`, which should be unambiguous. 3) I think in the previous template it wasn't clear enough that the example is actually an example. I've doubled down on labelling it as an example. ### Fixed - Default RAG template ### Breaking changes - I **think** currently the RAG template won't automatically update to a new default, even if it was default. --- ### Additional Information Discussion https://github.com/open-webui/open-webui/discussions/10456 ### Screenshots or Videos ![image](https://github.com/user-attachments/assets/643e22ce-a709-447f-a5c3-f3052fc8c6b6) --- <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 04:29:42 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#22925