fix(streaming): catch parse errors for incomplete responses#3268
Open
xodn348 wants to merge 1 commit into
Open
fix(streaming): catch parse errors for incomplete responses#3268xodn348 wants to merge 1 commit into
xodn348 wants to merge 1 commit into
Conversation
) When using structured output with streaming (text_format=PydanticModel), the SDK parses output text on the response.output_text.done event. If the response is incomplete (e.g. truncated by max_output_tokens), this raises a Pydantic ValidationError on the incomplete JSON, masking the subsequent response.incomplete event from the caller. Catch pydantic.ValidationError and json.JSONDecodeError during parsing and set parsed=None instead. This is type-safe since ResponseTextDoneEvent already declares parsed as Optional[TextFormatT]. Fixes openai#3263 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
1 participant
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.
Fixes #3263
What
When using
client.responses.stream()withtext_format=PydanticModel, the SDK eagerly parses output text on theresponse.output_text.doneevent. If the response is truncated (e.g. bymax_output_tokens), this raises apydantic.ValidationErroron the incomplete JSON, preventing the subsequentresponse.incompleteevent from reaching the caller.This PR catches
pydantic.ValidationErrorandjson.JSONDecodeErrorduring structured output parsing in the streaming handler and setsparsed=Noneinstead. This is type-safe sinceResponseTextDoneEvent.parsedis alreadyOptional[TextFormatT].Verification