Skip to content

Clarify usage and examples for qualityGuidelines within getSummaryAndTags #46

@monsieurBoutte

Description

@monsieurBoutte

Context

We should expand the documentation around qualityGuidelines to more clearly communicate:

  • What it is intended for
  • When users should reach for it
  • How it influences model behavior in practice

Right now, its purpose might not be as obvious to users encountering it for the first time.

Problem

qualityGuidelines is currently underspecified in our docs. Users may:

  • Misinterpret it as a strict validation mechanism
  • Underuse it due to lack of concrete examples
  • Be unsure how it differs from prompts or config options

Goal

Clarify that qualityGuidelines is a steering lever that allows users to shape the model toward their own qualitative expectations.

Proposed Updates

  • Add a short conceptual definition:
    • High-level guidance for subjective quality preferences
    • Not a hard validation rule set
  • Add 2 to 3 practical examples, such as:
    • Tone and style control
    • Safety or brand alignment or content specific preferences
    • Output formatting expectations

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions