[PR #15122] [MERGED] feat(azure): Add stream_options to payload if api_version supports #62581

New Issue

GiteaMirror · 2026-05-06T06:47:43-05:00

GiteaMirror commented

2026-05-06 06:47:43 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/15122
Author: @tcx4c70
Created: 6/18/2025
Status: ✅ Merged
Merged: 6/20/2025
Merged by: @tjbck

Base: dev ← Head: feat/add_stream_options_to_azure

📝 Commits (1)

baafdb7 feat(openai): Add stream_options to payload if api_version supports

📊 Changes

1 file changed (+21 additions, -14 deletions)

View changed files

📝 backend/open_webui/routers/openai.py (+21 -14)

📄 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

Although it's not documented in MS Azure doc, Azure OpenAI supports stream_options since API version 2024-09-01-preview.

This PR adds stream_options to the payload if the API version supports it. To avoid break changes, it will check the API version before adding stream_options to payload.

Added

Add stream_options to payload if api_version supports

Changed

Extract allowed Azure parameters into a separate get_azure_allowed_params function that adjusts based on api_version
Add api_version parameter to convert_to_azure_payload for dynamic parameter filtering
Update calling code to pass and use api_version consistently for better compatibility
Improve code structure and maintainability

Breaking Changes

I don't think it will introduce any break changes since it has already check the API version in the code. For the user who use old API version, it will change nothing.

Screenshots or Videos

After the change, Open WebUI will retrieve and display the token usage for ChageGPT models from Azure AI:

(For other models from Azure AI, like DeepSeek and Grok, it seems that they will response token usage even if we don't add stream_options to request)

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/15122 **Author:** [@tcx4c70](https://github.com/tcx4c70) **Created:** 6/18/2025 **Status:** ✅ Merged **Merged:** 6/20/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `feat/add_stream_options_to_azure` --- ### 📝 Commits (1) - [`baafdb7`](https://github.com/open-webui/open-webui/commit/baafdb752c30fe519329ebd733cd2f6e015ca9e8) feat(openai): Add stream_options to payload if api_version supports ### 📊 Changes **1 file changed** (+21 additions, -14 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/routers/openai.py` (+21 -14) </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 Although it's not documented in [MS Azure doc](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference), Azure OpenAI supports `stream_options` since API version [2024-09-01-preview](https://github.com/Azure/azure-rest-api-specs/pull/30821). This PR adds `stream_options` to the payload if the API version supports it. To avoid break changes, it will check the API version before adding `stream_options` to payload. ### Added - Add stream_options to payload if api_version supports ### Changed - Extract allowed Azure parameters into a separate `get_azure_allowed_params` function that adjusts based on `api_version` - Add `api_version` parameter to `convert_to_azure_payload` for dynamic parameter filtering - Update calling code to pass and use `api_version` consistently for better compatibility - Improve code structure and maintainability ### Breaking Changes I don't think it will introduce any break changes since it has already check the API version in the code. For the user who use old API version, it will change nothing. --- ### Screenshots or Videos After the change, Open WebUI will retrieve and display the token usage for ChageGPT models from Azure AI: <img width="1032" alt="截屏2025-06-18 21 12 23" src="https://github.com/user-attachments/assets/5734c9a3-257a-45bb-a5d9-24da072bbbc0" /> (For other models from Azure AI, like DeepSeek and Grok, it seems that they will response token usage even if we don't add `stream_options` to request) ### 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:47:43 -05:00

GiteaMirror closed this issue

2026-05-06 06:47:46 -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#62581