[PR #13071] [CLOSED] fix: Unify Handler Logic for o-Series Models (o1, o3, o4) #23087

Closed
opened 2026-04-20 04:37:21 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/13071
Author: @grandtele
Created: 4/20/2025
Status: Closed

Base: mainHead: fix/openai_o_series_handler


📝 Commits (10+)

  • 0a2747b Merge branch 'dev' of github.com:taylorwilsdon/open-webui into dev
  • 66bf6d8 Merge branch 'dev' of github.com:taylorwilsdon/open-webui into dev
  • b446598 Environment variable to redirect on logout
  • 708fcdc Merge branch 'dev' of github.com:taylorwilsdon/open-webui into dev
  • a8bbaa6 Merge branch 'dev' into main
  • 839ba22 feat: Backend for Self-Hosted/External Web Search/Loader Engines
  • 22f0365 format
  • 008fec8 fix: Update external search/loader method to POST
  • 85f8e91 feat: Allow admin editing external search/loader settings
  • dcb3f18 refac: styling

📊 Changes

58 files changed (+2182 additions, -1496 deletions)

View changed files

📝 .github/pull_request_template.md (+1 -1)
📝 LICENSE (+7 -1)
📝 README.md (+1 -2)
📝 backend/open_webui/__init__.py (+1 -1)
📝 backend/open_webui/config.py (+42 -0)
📝 backend/open_webui/env.py (+14 -0)
📝 backend/open_webui/main.py (+25 -2)
backend/open_webui/retrieval/loaders/external.py (+53 -0)
📝 backend/open_webui/retrieval/vector/dbs/qdrant.py (+34 -7)
backend/open_webui/retrieval/web/external.py (+47 -0)
📝 backend/open_webui/retrieval/web/utils.py (+8 -0)
📝 backend/open_webui/routers/auths.py (+7 -0)
📝 backend/open_webui/routers/files.py (+4 -2)
📝 backend/open_webui/routers/knowledge.py (+9 -8)
📝 backend/open_webui/routers/ollama.py (+7 -1)
📝 backend/open_webui/routers/openai.py (+15 -10)
📝 backend/open_webui/routers/retrieval.py (+38 -2)
📝 backend/open_webui/routers/users.py (+31 -0)
📝 backend/open_webui/utils/middleware.py (+10 -6)
📝 backend/open_webui/utils/oauth.py (+41 -1)

...and 38 more files

📄 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

  • Refactored handler logic for OpenAI "o"-series models (o1, o1-mini, o1-preview, o3, o3-mini, o4-mini) to use a universal handler function.
  • Improved code maintainability and ensured compatibility with new and future o-series models.

Added

  • Introduced a new function: openai_o_series_handler to handle all o-series specific parameter and role transformations.

Changed

  • Unified logic for converting max_tokens to max_completion_tokens for o-series models.
  • Updated role transformation logic: "system" is mapped to "user" for legacy models (o1-mini, o1-preview), and to "developer" for current/future o-series models.

Deprecated

  • N/A

Removed

  • Removed model-specific handling from scattered code sections.

Fixed

  • Ensured proper parameter mapping and role conversion for all supported o-series models.

Security

  • N/A

Breaking Changes

  • None

Additional Information

  • Addresses internal technical debt by consolidating model handler logic.
  • Prepares codebase for smoother support of additional o-series models in the future.

Screenshots or Videos

  • N/A

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/13071 **Author:** [@grandtele](https://github.com/grandtele) **Created:** 4/20/2025 **Status:** ❌ Closed **Base:** `main` ← **Head:** `fix/openai_o_series_handler` --- ### 📝 Commits (10+) - [`0a2747b`](https://github.com/open-webui/open-webui/commit/0a2747bc6a97f7dd14e2e08c5b5be4c11ab2f66a) Merge branch 'dev' of github.com:taylorwilsdon/open-webui into dev - [`66bf6d8`](https://github.com/open-webui/open-webui/commit/66bf6d88bc298e1547f22f8baaf951a7c96b14bc) Merge branch 'dev' of github.com:taylorwilsdon/open-webui into dev - [`b446598`](https://github.com/open-webui/open-webui/commit/b4465987f95fe062ef1df3c510ccd9631f58db0e) Environment variable to redirect on logout - [`708fcdc`](https://github.com/open-webui/open-webui/commit/708fcdc6b786e8790d2ec30d72b7d3dc854f26dd) Merge branch 'dev' of github.com:taylorwilsdon/open-webui into dev - [`a8bbaa6`](https://github.com/open-webui/open-webui/commit/a8bbaa61bd048a5d30273ad15840138a7ca479d2) Merge branch 'dev' into main - [`839ba22`](https://github.com/open-webui/open-webui/commit/839ba22c90991dc4d72810aa6f6a527664db80c2) feat: Backend for Self-Hosted/External Web Search/Loader Engines - [`22f0365`](https://github.com/open-webui/open-webui/commit/22f0365cef0d366632be48e20b25fbf09330f9ec) format - [`008fec8`](https://github.com/open-webui/open-webui/commit/008fec80c10b911068205a1782ea28507e3dea6b) fix: Update external search/loader method to POST - [`85f8e91`](https://github.com/open-webui/open-webui/commit/85f8e91288c201d68cece8f3ec3d08968a6d5fb1) feat: Allow admin editing external search/loader settings - [`dcb3f18`](https://github.com/open-webui/open-webui/commit/dcb3f18e1e4e342c736dc1c86f337467883bc1bb) refac: styling ### 📊 Changes **58 files changed** (+2182 additions, -1496 deletions) <details> <summary>View changed files</summary> 📝 `.github/pull_request_template.md` (+1 -1) 📝 `LICENSE` (+7 -1) 📝 `README.md` (+1 -2) 📝 `backend/open_webui/__init__.py` (+1 -1) 📝 `backend/open_webui/config.py` (+42 -0) 📝 `backend/open_webui/env.py` (+14 -0) 📝 `backend/open_webui/main.py` (+25 -2) ➕ `backend/open_webui/retrieval/loaders/external.py` (+53 -0) 📝 `backend/open_webui/retrieval/vector/dbs/qdrant.py` (+34 -7) ➕ `backend/open_webui/retrieval/web/external.py` (+47 -0) 📝 `backend/open_webui/retrieval/web/utils.py` (+8 -0) 📝 `backend/open_webui/routers/auths.py` (+7 -0) 📝 `backend/open_webui/routers/files.py` (+4 -2) 📝 `backend/open_webui/routers/knowledge.py` (+9 -8) 📝 `backend/open_webui/routers/ollama.py` (+7 -1) 📝 `backend/open_webui/routers/openai.py` (+15 -10) 📝 `backend/open_webui/routers/retrieval.py` (+38 -2) 📝 `backend/open_webui/routers/users.py` (+31 -0) 📝 `backend/open_webui/utils/middleware.py` (+10 -6) 📝 `backend/open_webui/utils/oauth.py` (+41 -1) _...and 38 more files_ </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? - [ ] **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 - Refactored handler logic for OpenAI "o"-series models (`o1`, `o1-mini`, `o1-preview`, `o3`, `o3-mini`, `o4-mini`) to use a universal handler function. - Improved code maintainability and ensured compatibility with new and future o-series models. ### Added - Introduced a new function: `openai_o_series_handler` to handle all o-series specific parameter and role transformations. ### Changed - Unified logic for converting `max_tokens` to `max_completion_tokens` for o-series models. - Updated role transformation logic: "system" is mapped to "user" for legacy models (`o1-mini`, `o1-preview`), and to "developer" for current/future o-series models. ### Deprecated - N/A ### Removed - Removed model-specific handling from scattered code sections. ### Fixed - Ensured proper parameter mapping and role conversion for all supported o-series models. ### Security - N/A ### Breaking Changes - None --- ### Additional Information - Addresses internal technical debt by consolidating model handler logic. - Prepares codebase for smoother support of additional o-series models in the future. ### Screenshots or Videos - N/A ### 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>
GiteaMirror added the pull-request label 2026-04-20 04:37:21 -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#23087