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 for validating 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 the ability to provide format to the chat/completions endpoint to make use of ollama's newly added structured output functionality
Added
Added pass-through of incoming format property for chat/completions
Changed
Changed type of format field in GenerateChatCompletionForm
🔄 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/7920
**Author:** [@envision3d](https://github.com/envision3d)
**Created:** 12/17/2024
**Status:** ✅ Merged
**Merged:** 12/17/2024
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `ollama-structured-output`
---
### 📝 Commits (1)
- [`16d9002`](https://github.com/open-webui/open-webui/commit/16d900247a4c12e4f916b0c531f37e9dafa095ee) feat: pass structured output format through to ollama
### 📊 Changes
**2 files changed** (+4 additions, -1 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/open_webui/routers/ollama.py` (+1 -1)
📝 `backend/open_webui/utils/payload.py` (+3 -0)
</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?
- [ ] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation?
- [ ] **Testing:** Have you written and run sufficient tests for validating 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 the ability to provide `format` to the chat/completions endpoint to make use of ollama's newly added structured output functionality
### Added
- Added pass-through of incoming `format` property for chat/completions
### Changed
- Changed type of `format` field in `GenerateChatCompletionForm`
### Documentation PR
https://github.com/open-webui/docs/pull/319
---
---
<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/7920
Author: @envision3d
Created: 12/17/2024
Status: ✅ Merged
Merged: 12/17/2024
Merged by: @tjbck
Base:
dev← Head:ollama-structured-output📝 Commits (1)
16d9002feat: pass structured output format through to ollama📊 Changes
2 files changed (+4 additions, -1 deletions)
View changed files
📝
backend/open_webui/routers/ollama.py(+1 -1)📝
backend/open_webui/utils/payload.py(+3 -0)📄 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
formatto the chat/completions endpoint to make use of ollama's newly added structured output functionalityAdded
formatproperty for chat/completionsChanged
formatfield inGenerateChatCompletionFormDocumentation PR
https://github.com/open-webui/docs/pull/319
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.