[PR #18905] [CLOSED] feat: Enhance Mistral OCR integration with configurable endpoint and … #40648

New Issue

GiteaMirror · 2026-04-25T13:06:44-05:00

GiteaMirror commented

2026-04-25 13:06:44 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/18905
Author: @paddy313
Created: 11/3/2025
Status: ❌ Closed

Base: dev ← Head: feature/custom_mistral_ocr_endpoints

📝 Commits (2)

0f2d59c feat: Enhance Mistral OCR integration with configurable endpoint and parameters
08b5df5 Merge branch 'dev' into feature/custom_mistral_ocr_endpoints

📊 Changes

6 files changed (+709 additions, -147 deletions)

View changed files

📝 backend/open_webui/config.py (+18 -0)
📝 backend/open_webui/main.py (+4 -0)
📝 backend/open_webui/retrieval/loaders/main.py (+6 -1)
📝 backend/open_webui/retrieval/loaders/mistral.py (+583 -140)
📝 backend/open_webui/routers/retrieval.py (+18 -0)
📝 src/lib/components/admin/Settings/Documents.svelte (+80 -6)

📄 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: Verify that the pull request targets the dev branch. Not targeting the dev branch may lead to immediate closure of the PR.
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: If necessary, update relevant documentation Open WebUI Docs like environment variables, the tutorials, or other documentation sources.
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Perform manual tests to verify the implemented fix/feature works as intended AND does not break any other functionality. Take this as an opportunity to make screenshots of the feature/fix and include it in the PR description.
Agentic AI Code:: Confirm this Pull Request is not written by any AI Agent or has at least gone through additional human review and manual testing. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR.
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?
Title 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

Updated the Mistral OCR loader to allow for defining additional endpoints and models, and to support two different methods (upload/base64) to use with the API.
Previously, defining different endpoints was not possible. However, given that the Mistral OCR API can be used with LiteLLM or in Azure AI Foundry, it was necessary to enhance the Mistral loader to use diverse endpoints and model names.
LiteLLM and Azure AI Foundry do not support document upload with a signed URL; they only permit sending PDFs as base64 encoded strings. The official Mistral OCR API supports both methods. The upload method is faster for larger files. Consequently, I have provided the option in the UI, allowing users to choose between the two methods based on endpoint support.

Added

Environment variables for Mistral OCR configuration:
- MISTRAL_OCR_ENDPOINT: Custom endpoint support
- MISTRAL_OCR_PARAMS: Additional Parameters for Mistral OCR, currently model & PDF transfer method.
UI fields in Documents.svelte for endpoint, model, and upload method configuration

Changed

backend/open_webui:
- config.py and main.py: Added environment variable handling
- retrieval/loaders/main.py: Updated Mistral loader constructor with new parameters
- retrieval/loaders/mistral.py: Implemented base64 encoding support for API compatibility
- routers/retrieval.py: Added configuration variable management
Frontend:
- Documents.svelte: Added input fields for endpoint and model selection

Fixed

Mistral OCR loader compatibility with LiteLLM and Azure AI Foundry platforms

Additional Information

Related discussion: #14200
Documentation PR: https://github.com/open-webui/docs/pull/791

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.}

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/open-webui/pull/18905 **Author:** [@paddy313](https://github.com/paddy313) **Created:** 11/3/2025 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `feature/custom_mistral_ocr_endpoints` --- ### 📝 Commits (2) - [`0f2d59c`](https://github.com/open-webui/open-webui/commit/0f2d59c0a59f97ece6c27c35641f550aa68ab168) feat: Enhance Mistral OCR integration with configurable endpoint and parameters - [`08b5df5`](https://github.com/open-webui/open-webui/commit/08b5df5eb185531d3555e19515ef735fd1f75a4b) Merge branch 'dev' into feature/custom_mistral_ocr_endpoints ### 📊 Changes **6 files changed** (+709 additions, -147 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/config.py` (+18 -0) 📝 `backend/open_webui/main.py` (+4 -0) 📝 `backend/open_webui/retrieval/loaders/main.py` (+6 -1) 📝 `backend/open_webui/retrieval/loaders/mistral.py` (+583 -140) 📝 `backend/open_webui/routers/retrieval.py` (+18 -0) 📝 `src/lib/components/admin/Settings/Documents.svelte` (+80 -6) </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:** Verify that the pull request targets the `dev` branch. Not targeting the `dev` branch may lead to immediate closure of the PR. - [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:** If necessary, update relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs) like environment variables, the tutorials, or other documentation sources. - [x] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? - [x] **Testing:** Perform manual tests to verify the implemented fix/feature works as intended AND does not break any other functionality. Take this as an opportunity to make screenshots of the feature/fix and include it in the PR description. - [x] **Agentic AI Code:**: Confirm this Pull Request is **not written by any AI Agent** or has at least gone through additional human review **and** manual testing. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR. - [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] **Title 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 Updated the Mistral OCR loader to allow for defining additional endpoints and models, and to support two different methods (upload/base64) to use with the API. Previously, defining different endpoints was not possible. However, given that the Mistral OCR API can be used with LiteLLM or in Azure AI Foundry, it was necessary to enhance the Mistral loader to use diverse endpoints and model names. LiteLLM and Azure AI Foundry do not support document upload with a signed URL; they only permit sending PDFs as base64 encoded strings. The official Mistral OCR API supports both methods. The upload method is faster for larger files. Consequently, I have provided the option in the UI, allowing users to choose between the two methods based on endpoint support. ### Added - Environment variables for Mistral OCR configuration: - `MISTRAL_OCR_ENDPOINT`: Custom endpoint support - `MISTRAL_OCR_PARAMS`: Additional Parameters for Mistral OCR, currently model & PDF transfer method. - UI fields in Documents.svelte for endpoint, model, and upload method configuration ### Changed - **backend/open_webui:** - `config.py` and `main.py`: Added environment variable handling - `retrieval/loaders/main.py`: Updated Mistral loader constructor with new parameters - `retrieval/loaders/mistral.py`: Implemented base64 encoding support for API compatibility - `routers/retrieval.py`: Added configuration variable management - **Frontend:** - `Documents.svelte`: Added input fields for endpoint and model selection ### Fixed - Mistral OCR loader compatibility with LiteLLM and Azure AI Foundry platforms --- ### Additional Information - Related discussion: #14200 - Documentation PR: [https://github.com/open-webui/docs/pull/791](https://github.com/open-webui/docs/pull/791) ### Screenshots or Videos <img width="404" height="228" alt="image" src="https://github.com/user-attachments/assets/f96a7c51-1af0-4a33-9203-43d3c7d2394e" /> ### Contributor License Agreement By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](https://github.com/open-webui/open-webui/blob/main/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-25 13:06:44 -05:00

GiteaMirror closed this issue

2026-04-25 13:06:44 -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#40648