Add typed structured-output round-trip helpers#196
Open
SalimELMARDI wants to merge 2 commits into
Open
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This PR adds first-class typed structured-output round-tripping across the Python SDK’s core schema-enabled surfaces.
Today, the SDK already accepts structured schemas in several places, but callers still need to manually parse or validate the returned payloads themselves. This PR makes that flow consistent and ergonomic: when a user passes a schema, the SDK now exposes the validated typed object directly on the response.
What’s Included
New typed response fields
AnswerResponse.parsed_outputResult.parsed_summaryDeepSearchOutput.parsed_contentSupported round-trip flows
answer(..., output_schema=MyModel)get_contents(..., summary={"schema": MyModel})search(..., contents={"summary": {"schema": MyModel}})search(..., type="deep" | "deep-reasoning", output_schema=MyModel)Additional improvements
output_schema, not just raw dict schemascontents={"summary": {"schema": ...}}preserve field names correctly during request serializationWhy This Matters
This improves a very common research / eval / agent workflow:
Before:
dict/strjson.loads(...),model_validate(...), ormodel_validate_json(...)After:
parsed_output,parsed_summary, orparsed_contentThat makes the SDK more useful for:
Before / After
Measured locally with the smoke scripts in
personal/structured_output_roundtrip_smoke/:Before
303After
330Tested surfaces:
answersummarydeep_searchThis PR is about improving structured-output ergonomics and consistency, not backend latency or model quality.
Backwards Compatibility
This change is fully additive:
answer,summary, andoutput.contentare unchangedValidation
Example