feat(azure): Add stream_options to payload if api_version supports

[tcx4c70]

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.

[tjbck]

Does this work?

[tcx4c70]

I known comparing API version via string comparison is very very ugly, but I think it will work as expected.

Ask question with API version 2024-07-01-preview:

Ask the same question to the same model with API version 2024-09-01-preview:

Do you have any ideas to make it more graceful?

[tjbck]

Seems reasonable for now, will refac a bit from our end. Thanks!