docs(readme): clarify response_format vs text for structured outputs#413
Merged
nezhyborets merged 1 commit intomainfrom Apr 30, 2026
Merged
Conversation
The Structured Outputs section implied both ChatQuery and CreateModelResponseQuery share a single response-format parameter, but they don't: ChatQuery uses responseFormat:, while CreateModelResponseQuery uses text:. The naming mirrors the OpenAI API's own response_format / text fields, so this is intentional — the README just didn't say so. Add a note at the top of the section explaining both spellings, and fix the bullet under JSONSchemaDefinition.derivedJsonSchema that only mentioned responseFormat. Closes #392 Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
nezhyborets
approved these changes
Apr 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #392.
A user reported confusion about why the Structured Outputs section seemed to claim both
ChatQueryandCreateModelResponseQueryshare aresponseFormatparameter, when in practiceCreateModelResponseQueryusestext:. The naming mirrors the OpenAI API's own field names (response_formatfor Chat Completions,textfor Responses), so this is intentional — the README just didn't make it explicit.This PR:
JSONSchemaDefinitionvalue works for either query type.No code changes; docs only.
Test plan
README.mdon GitHub and confirm the[!NOTE]block displays as a styled callout, and the second bullet under derivedJsonSchema reads naturally.🤖 Generated with Claude Code