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 a new setting to enable title generation by CoT models.
Added fallback logic for title generation by CoT models (when the setting is off).
Added
Title generation fallback behavior when using a CoT model
Interface setting "Title generation model uses chain of thought"
Changed
Refactored max_tokens/max_completion_tokens while adding the new behavior
Truncate titles to 50 characters immediately before title update
Refactored title fallback logic
Moved reasoning tags names to a constant
Deprecated
None
Removed
None
Fixed
Fixed titles being updated with CoT e.g. <think>...
Security
None
Breaking Changes
None
Additional Information
Currently, running chain-of-thought (CoT) models will generate unhelpful titles in the sidebar unless a different model is selected for title generation in the interface settings. For example:
This PR lets CoT models generate helpful titles by 1) adding a default behavior to fall back to the original assistant message if a CoT is detected and 2) through a new setting, letting a CoT model fully generate a message before extracting just the generated title.
Screenshots or Videos
Example new default behavior running a CoT model:
New interface setting "Title generation model uses chain of thought"
After enabling the setting:
🔄 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/9088
**Author:** [@joshuawu](https://github.com/joshuawu)
**Created:** 1/29/2025
**Status:** ❌ Closed
**Base:** `dev` ← **Head:** `title-generation-cot`
---
### 📝 Commits (1)
- [`666398f`](https://github.com/open-webui/open-webui/commit/666398f3952fe8e1555e9e10223bc2a595ae110c) Support CoT models for title generation.
### 📊 Changes
**6 files changed** (+62 additions, -24 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/open_webui/config.py` (+6 -0)
📝 `backend/open_webui/main.py` (+2 -0)
📝 `backend/open_webui/models/chats.py` (+3 -1)
📝 `backend/open_webui/routers/tasks.py` (+14 -7)
📝 `backend/open_webui/utils/middleware.py` (+29 -16)
📝 `src/lib/components/admin/Settings/Interface.svelte` (+8 -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.
- [ ] **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?
- [ ] **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 a new setting to enable title generation by CoT models.
- Added fallback logic for title generation by CoT models (when the setting is off).
### Added
- Title generation fallback behavior when using a CoT model
- Interface setting "Title generation model uses chain of thought"
### Changed
- Refactored `max_tokens`/`max_completion_tokens` while adding the new behavior
- Truncate titles to 50 characters immediately before title update
- Refactored title fallback logic
- Moved reasoning tags names to a constant
### Deprecated
- None
### Removed
- None
### Fixed
- Fixed titles being updated with CoT e.g. `<think>...`
### Security
- None
### Breaking Changes
- None
---
### Additional Information
Currently, running chain-of-thought (CoT) models will generate unhelpful titles in the sidebar unless a different model is selected for title generation in the interface settings. For example:
This PR lets CoT models generate helpful titles by 1) adding a default behavior to fall back to the original assistant message if a CoT is detected and 2) through a new setting, letting a CoT model fully generate a message before extracting just the generated title.
### Screenshots or Videos
## Example new default behavior running a CoT model:
## New interface setting "Title generation model uses chain of thought"
## After enabling the setting:
---
<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/9088
Author: @joshuawu
Created: 1/29/2025
Status: ❌ Closed
Base:
dev← Head:title-generation-cot📝 Commits (1)
666398fSupport CoT models for title generation.📊 Changes
6 files changed (+62 additions, -24 deletions)
View changed files
📝
backend/open_webui/config.py(+6 -0)📝
backend/open_webui/main.py(+2 -0)📝
backend/open_webui/models/chats.py(+3 -1)📝
backend/open_webui/routers/tasks.py(+14 -7)📝
backend/open_webui/utils/middleware.py(+29 -16)📝
src/lib/components/admin/Settings/Interface.svelte(+8 -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
Added
Changed
max_tokens/max_completion_tokenswhile adding the new behaviorDeprecated
Removed
Fixed
<think>...Security
Breaking Changes
Additional Information
Currently, running chain-of-thought (CoT) models will generate unhelpful titles in the sidebar unless a different model is selected for title generation in the interface settings. For example:
This PR lets CoT models generate helpful titles by 1) adding a default behavior to fall back to the original assistant message if a CoT is detected and 2) through a new setting, letting a CoT model fully generate a message before extracting just the generated title.
Screenshots or Videos
Example new default behavior running a CoT model:
New interface setting "Title generation model uses chain of thought"
After enabling the setting:
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.