fix(responses): include text.format when verbosity set for plain-text responses #2017
Conversation
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
… responses
When model_settings.verbosity was set and no output schema was provided,
the code previously built response_format = {"verbosity": ...} which
is an invalid `text` payload for the Responses API. The Responses API
expects a `text` object to include a `format` field (for plain text use
"format": "text").
This patch ensures a valid payload is sent by using:
{"format": "text", "verbosity": <value>}
Impact:
- Prevents 400/BadRequest errors when callers use verbosity with plain text
responses (no JSON schema).
- Backwards compatible for callers that already use output_schema.
Mypy reported a typing error because the `text.format` TypedDict expects an object
(e.g. {"type": "text"}) not a plain string "text". Previously we set
response_format = {"format": "text", "verbosity": ...} which fails type checks.
This change uses the correct format object:
{"format": {"type": "text"}, "verbosity": <value>}
This resolves the mypy failure and keeps the `text` payload valid for the Responses API.
I don't think so. The current code works without any issues. You can confirm the behavior by modifying |
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.
When model_settings.verbosity was set and no output schema was provided, the code previously built response_format = {"verbosity": ...} which is an invalid
textpayload for the Responses API.The Responses API expects a
textobject to include aformatfield (for plain text use "format": "text").This patch ensures a valid payload is sent by using:
{"format": "text", "verbosity": }
Impact: