Improve Server OAI Responses API streaming compatibility#24957
Open
boondocklabs wants to merge 5 commits into
Open
Improve Server OAI Responses API streaming compatibility#24957boondocklabs wants to merge 5 commits into
boondocklabs wants to merge 5 commits into
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.
Overview
Improve OpenAI Responses API streaming compatibility by aligning emitted SSE events with the documented OpenAI event schema.
This change refactors sequence number handling to use a shared counter stored in task_result_state, ensuring monotonic sequence_number values across both partial and final response events. It also adds and corrects required event fields that were previously missing or incomplete.
Specifically, this change:
Additional information
While testing OpenAI Responses API streaming, some clients failed to deserialize events correctly because emitted events did not fully match the documented schema and expected event ordering.
In addition to fixing sequence number generation, this PR updates event payloads to include required fields and metadata expected by OpenAI-compatible clients. The goal is to improve interoperability with SDKs and consumers that rely on strict adherence to the Responses API event definitions.
This work was validated against the OpenAI Responses API documentation and tested with the Rig streaming client, which was previously unable to successfully consume the generated event stream due to schema and event sequencing incompatibilities.
Requirements