[PR #13072] [MERGED] * fix: Refactor openai handler to support all o-series models universally #46136

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

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/13072
Author: @grandtele
Created: 4/20/2025
Status: Merged
Merged: 4/20/2025
Merged by: @tjbck

Base: devHead: fix/openai_o_series_handler


📝 Commits (1)

  • 5a8e417 * refactor openai handler to support all o-series models universally

📊 Changes

1 file changed (+9 additions, -10 deletions)

View changed files

📝 backend/open_webui/routers/openai.py (+9 -10)

📄 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/13072 **Author:** [@grandtele](https://github.com/grandtele) **Created:** 4/20/2025 **Status:** ✅ Merged **Merged:** 4/20/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `fix/openai_o_series_handler` --- ### 📝 Commits (1) - [`5a8e417`](https://github.com/open-webui/open-webui/commit/5a8e417590aeba5dc3506f29e95d09ec877a41b4) * refactor openai handler to support all o-series models universally ### 📊 Changes **1 file changed** (+9 additions, -10 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/routers/openai.py` (+9 -10) </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-29 20:48:46 -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#46136