[PR #13677] [MERGED] refactor: Improve Default Title Generation Prompt Template for robust JSON output #62118

New Issue

GiteaMirror · 2026-05-06T06:04:06-05:00

GiteaMirror commented

2026-05-06 06:04:06 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/13677
Author: @silentoplayz
Created: 5/8/2025
Status: ✅ Merged
Merged: 5/8/2025
Merged by: @tjbck

Base: dev ← Head: dev

📝 Commits (1)

994f17b Update config.py

📊 Changes

1 file changed (+3 additions, -0 deletions)

View changed files

📝 backend/open_webui/config.py (+3 -0)

📄 Description

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

Enhanced the DEFAULT_TITLE_GENERATION_PROMPT_TEMPLATE to improve the reliability and robustness of JSON output for tool calling. This change aims to minimize parsing failures by providing clearer and stricter instructions to the language model regarding the expected output format.

Added

N/A

Changed

Modified DEFAULT_TITLE_GENERATION_PROMPT_TEMPLATE guidelines to include three new clauses emphasizing strict JSON-only output:
- "Your entire response must consist solely of the JSON object, without any introductory or concluding text."
- "The output must be a single, raw JSON object, without any markdown code fences or other encapsulating text."
- "Ensure no conversational text, affirmations, or explanations precede or follow the raw JSON output, as this will cause direct parsing failure."

Deprecated

N/A

Removed

N/A

Fixed

N/A (Though this change aims to prevent future fixing related to output parsing)

Security

N/A

Breaking Changes

N/A

Additional Information

These changes are intended to directly address common issues where LLMs wrap JSON responses in markdown, or include conversational preambles/postambles, which can break automated parsing pipelines.
- This refinement should lead to a higher success rate for features relying on this prompt, such as automated title generation.
- This PR is inspired by https://github.com/open-webui/open-webui/pull/13604.

Screenshots or Videos

N/A (Change is to a text-based prompt template)

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/13677 **Author:** [@silentoplayz](https://github.com/silentoplayz) **Created:** 5/8/2025 **Status:** ✅ Merged **Merged:** 5/8/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `dev` --- ### 📝 Commits (1) - [`994f17b`](https://github.com/open-webui/open-webui/commit/994f17b430f6ce8b068370a851e973f4f5f4e0d0) Update config.py ### 📊 Changes **1 file changed** (+3 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/config.py` (+3 -0) </details> ### 📄 Description - [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? - [x] **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 - Enhanced the `DEFAULT_TITLE_GENERATION_PROMPT_TEMPLATE` to improve the reliability and robustness of JSON output for tool calling. This change aims to minimize parsing failures by providing clearer and stricter instructions to the language model regarding the expected output format. ### Added - N/A ### Changed - Modified `DEFAULT_TITLE_GENERATION_PROMPT_TEMPLATE` guidelines to include three new clauses emphasizing strict JSON-only output: - "Your entire response must consist solely of the JSON object, without any introductory or concluding text." - "The output must be a single, raw JSON object, without any markdown code fences or other encapsulating text." - "Ensure no conversational text, affirmations, or explanations precede or follow the raw JSON output, as this will cause direct parsing failure." ### Deprecated - N/A ### Removed - N/A ### Fixed - N/A (Though this change aims to prevent future fixing related to output parsing) ### Security - N/A ### Breaking Changes - N/A --- ### Additional Information - These changes are intended to directly address common issues where LLMs wrap JSON responses in markdown, or include conversational preambles/postambles, which can break automated parsing pipelines. - This refinement should lead to a higher success rate for features relying on this prompt, such as automated title generation. - This PR is inspired by https://github.com/open-webui/open-webui/pull/13604. ### Screenshots or Videos - N/A (Change is to a text-based prompt template) ### 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>

GiteaMirror added the pull-request label 2026-05-06 06:04:06 -05:00

GiteaMirror closed this issue

2026-05-06 06:04:08 -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#62118