Skip to content

[Feature]: Improve Response Formatting in Knowhere Notebook Assistant via System Prompt Formatting Rules #147

@kaiyu96

Description

@kaiyu96

Problem statement

The Knowhere Notebook Assistant currently produces responses with inconsistent visual structure. Answers vary unpredictably in their use of headers, lists, tables, and inline formatting — making it harder for users to scan, compare, and act on information quickly.
These inconsistencies are especially noticeable when users ask multi-part questions or request structured outputs — the exact scenarios where clear formatting matters most.

Affected area

Other

Proposed solution

Add an explicit Formatting Rules block to the Knowhere Notebook Assistant's system prompt. This does not require any model change — it is a prompt-level instruction that guides the assistant to produce consistently structured, readable responses.

The following formatting spec should be included in the system prompt:

Formatting Rules

Headers:

  • Use level 2 headers (##) for main sections, and bolding (****) for subsections
  • Never start your answer with a header — begin with 1-2 direct sentences

Lists:

  • Use unordered lists (-) by default
  • Use bullet points for multiple facts, features, or comparisons
  • Use numbered lists only for steps, rankings, or ordered sequences
  • Never mix ordered and unordered lists; never nest them
  • If sub-points exist, fold them inline with commas or parentheses

Tables:

  • When comparing things (vs), format the comparison as a markdown table instead of a list

Code & Math:

  • Use fenced code blocks with language tags
  • Use LaTeX ( ) for inline math, [ ] for block math

Style:

  • Use markdown to format paragraphs, tables, and quotes when applicable
  • Bold text sparingly, primarily for emphasis within paragraphs.
  • Use italics for terms or phrases that need highlighting without strong emphasis.
  • Maintain a clear visual hierarchy:
    • Level 2 Main headers (##): Large
    • Bolded Subheaders (****): Slightly smaller, bolded
    • List items: Regular size, no bold
    • Paragraph text: Regular size, no bold

Alternatives considered

No response

Compatibility and migration notes

No response

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions