[PR #14069] [MERGED] feat: Configurable weight for BM25Retriever during hybrid search #62233

New Issue

GiteaMirror · 2026-05-06T06:14:49-05:00

GiteaMirror commented

2026-05-06 06:14:49 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/14069
Author: @Ithanil
Created: 5/20/2025
Status: ✅ Merged
Merged: 5/23/2025
Merged by: @tjbck

Base: dev ← Head: bm25_weight

📝 Commits (4)

b5ddaf6 make weight for bm25 retriever in hybrid search ui-configurable
308d8ac make bm25_weight a regular parameter of query_doc.. / get_sources_from_files functions
e70dd33 rename BM25_WEIGHT -> HYBRID_BM25_WEIGHT
a90d3f3 add missing locale string

📊 Changes

7 files changed (+67 additions, -5 deletions)

View changed files

📝 backend/open_webui/config.py (+5 -0)
📝 backend/open_webui/main.py (+4 -2)
📝 backend/open_webui/retrieval/utils.py (+19 -3)
📝 backend/open_webui/routers/retrieval.py (+18 -0)
📝 backend/open_webui/utils/middleware.py (+1 -0)
📝 src/lib/components/admin/Settings/Documents.svelte (+18 -0)
📝 src/lib/i18n/locales/en-US/translation.json (+2 -0)

📄 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

Adds a PersistentConfig RAG_BM25_WEIGHT to control the weight given to BM25Retriever within the EnsembleRetriever used for hybrid search. The default is 0.5, as was hardcoded previously. 0 will completely disable BM25Retriever, 1 will only use BM25Retriever.

Added

PersistentConfig RAG_BM25_WEIGHT, including UI. Generally treated equal to TOP_K, TOP_K_RERANKER etc.

Additional Information

This allows for even more control and fine-tuning of the RAG process.

Doc PR: https://github.com/open-webui/docs/pull/554

Screenshots or Videos

Obviously, the form field isn't aligned with the other parameters. I'm struggling to achieve this, happy to get a hint or get it refactored afterwards.

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.

_{🔄 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/14069 **Author:** [@Ithanil](https://github.com/Ithanil) **Created:** 5/20/2025 **Status:** ✅ Merged **Merged:** 5/23/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `bm25_weight` --- ### 📝 Commits (4) - [`b5ddaf6`](https://github.com/open-webui/open-webui/commit/b5ddaf6417349e6bb6cd1ed041b4a332911551ba) make weight for bm25 retriever in hybrid search ui-configurable - [`308d8ac`](https://github.com/open-webui/open-webui/commit/308d8ac04a8e71485c4c89bc0da1acaab804b38d) make bm25_weight a regular parameter of query_doc.. / get_sources_from_files functions - [`e70dd33`](https://github.com/open-webui/open-webui/commit/e70dd3323390c9da5c9197efbbc50a07db7d79d2) rename BM25_WEIGHT -> HYBRID_BM25_WEIGHT - [`a90d3f3`](https://github.com/open-webui/open-webui/commit/a90d3f326809dc4d51161607f9c88fd8b92f0a31) add missing locale string ### 📊 Changes **7 files changed** (+67 additions, -5 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/config.py` (+5 -0) 📝 `backend/open_webui/main.py` (+4 -2) 📝 `backend/open_webui/retrieval/utils.py` (+19 -3) 📝 `backend/open_webui/routers/retrieval.py` (+18 -0) 📝 `backend/open_webui/utils/middleware.py` (+1 -0) 📝 `src/lib/components/admin/Settings/Documents.svelte` (+18 -0) 📝 `src/lib/i18n/locales/en-US/translation.json` (+2 -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) 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 Adds a PersistentConfig RAG_BM25_WEIGHT to control the weight given to BM25Retriever within the EnsembleRetriever used for hybrid search. The default is 0.5, as was hardcoded previously. 0 will completely disable BM25Retriever, 1 will only use BM25Retriever. ### Added - PersistentConfig RAG_BM25_WEIGHT, including UI. Generally treated equal to TOP_K, TOP_K_RERANKER etc. --- ### Additional Information This allows for even more control and fine-tuning of the RAG process. Doc PR: https://github.com/open-webui/docs/pull/554 ### Screenshots or Videos ![Screenshot From 2025-05-20 10-38-44](https://github.com/user-attachments/assets/91dcde5a-dee5-4711-92f9-59dbf74e54e7) Obviously, the form field isn't aligned with the other parameters. I'm struggling to achieve this, happy to get a hint or get it refactored afterwards. ### Contributor License Agreement By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](/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>

GiteaMirror added the pull-request label 2026-05-06 06:14:49 -05:00

GiteaMirror closed this issue

2026-05-06 06:14:52 -05:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/open-webui#62233