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
Added Azure OpenAI as an embedding option. Azure OpenAI appears in the Embedding section of the Documents settings panel.
Backend embedding utilities gain a new generate_azure_openai_batch_embeddings method with automatic retry on rate limiting and prefix support. The main generate_embeddings dispatcher now handles an 'azure_openai' engine type and passes the deployment and version parameters when selected
The retrieval router exposes Azure OpenAI settings in the /embedding API, and the update form accepts an azure_openai_config object. When embedding configuration is updated, the router rebuilds the embedding function using the chosen engine and credentials, returning the updated settings including Azure-specific fields
Frontend API typings now include AzureOpenAIConfigForm and allow sending this info when updating embedding settings. In the documents settings UI, Azure OpenAI is available in the engine dropdown, with input fields for base URL, key, deployment, and version, and a validation check that all four values are provided before updating the model
I left the embedding model field even though it is not needed for the Azure API because the value is still used to keep track of which model was used to generate the embeddings.
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/14370
**Author:** [@daw](https://github.com/daw)
**Created:** 5/27/2025
**Status:** ✅ Merged
**Merged:** 5/29/2025
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `feat/add-azure-openai-embeddings-option`
---
### 📝 Commits (1)
- [`42be1f9`](https://github.com/open-webui/open-webui/commit/42be1f956ac04d1166996e36eae48c38a52bfcfc) Add Azure OpenAI embedding support
### 📊 Changes
**6 files changed** (+315 additions, -51 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/open_webui/config.py` (+21 -0)
📝 `backend/open_webui/main.py` (+29 -2)
📝 `backend/open_webui/retrieval/utils.py` (+87 -1)
📝 `backend/open_webui/routers/retrieval.py` (+75 -5)
📝 `src/lib/apis/retrieval/index.ts` (+14 -6)
📝 `src/lib/components/admin/Settings/Documents.svelte` (+89 -37)
</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.
- [ ] **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
Added Azure OpenAI as an embedding option. Azure OpenAI appears in the Embedding section of the Documents settings panel.
Backend embedding utilities gain a new generate_azure_openai_batch_embeddings method with automatic retry on rate limiting and prefix support. The main generate_embeddings dispatcher now handles an 'azure_openai' engine type and passes the deployment and version parameters when selected
The retrieval router exposes Azure OpenAI settings in the /embedding API, and the update form accepts an azure_openai_config object. When embedding configuration is updated, the router rebuilds the embedding function using the chosen engine and credentials, returning the updated settings including Azure-specific fields
Frontend API typings now include AzureOpenAIConfigForm and allow sending this info when updating embedding settings. In the documents settings UI, Azure OpenAI is available in the engine dropdown, with input fields for base URL, key, deployment, and version, and a validation check that all four values are provided before updating the model
I left the embedding model field even though it is not needed for the Azure API because the value is still used to keep track of which model was used to generate the embeddings.
### Added
Added Azure OpenAI as an embedding option.
### Changed
backend/open_webui/config.py
backend/open_webui/main.py
backend/open_webui/retrieval/utils.py
backend/open_webui/routers/retrieval.py
src/lib/apis/retrieval/index.ts
src/lib/components/admin/Settings/Documents.svelte
### Deprecated
- none
### Removed
- none
### Fixed
- none
### Security
- none
### Breaking Changes
- none
---
### Additional Information
-
### Screenshots or Videos
### 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>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
📋 Pull Request Information
Original PR: https://github.com/open-webui/open-webui/pull/14370
Author: @daw
Created: 5/27/2025
Status: ✅ Merged
Merged: 5/29/2025
Merged by: @tjbck
Base:
dev← Head:feat/add-azure-openai-embeddings-option📝 Commits (1)
42be1f9Add Azure OpenAI embedding support📊 Changes
6 files changed (+315 additions, -51 deletions)
View changed files
📝
backend/open_webui/config.py(+21 -0)📝
backend/open_webui/main.py(+29 -2)📝
backend/open_webui/retrieval/utils.py(+87 -1)📝
backend/open_webui/routers/retrieval.py(+75 -5)📝
src/lib/apis/retrieval/index.ts(+14 -6)📝
src/lib/components/admin/Settings/Documents.svelte(+89 -37)📄 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:
devbranch.Changelog Entry
Description
Added Azure OpenAI as an embedding option. Azure OpenAI appears in the Embedding section of the Documents settings panel.
Backend embedding utilities gain a new generate_azure_openai_batch_embeddings method with automatic retry on rate limiting and prefix support. The main generate_embeddings dispatcher now handles an 'azure_openai' engine type and passes the deployment and version parameters when selected
The retrieval router exposes Azure OpenAI settings in the /embedding API, and the update form accepts an azure_openai_config object. When embedding configuration is updated, the router rebuilds the embedding function using the chosen engine and credentials, returning the updated settings including Azure-specific fields
Frontend API typings now include AzureOpenAIConfigForm and allow sending this info when updating embedding settings. In the documents settings UI, Azure OpenAI is available in the engine dropdown, with input fields for base URL, key, deployment, and version, and a validation check that all four values are provided before updating the model
I left the embedding model field even though it is not needed for the Azure API because the value is still used to keep track of which model was used to generate the embeddings.
Added
Added Azure OpenAI as an embedding option.
Changed
backend/open_webui/config.py
backend/open_webui/main.py
backend/open_webui/retrieval/utils.py
backend/open_webui/routers/retrieval.py
src/lib/apis/retrieval/index.ts
src/lib/components/admin/Settings/Documents.svelte
Deprecated
Removed
Fixed
Security
Breaking Changes
Additional Information
Screenshots or Videos
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.