fix: emit integer output_index in Chat Completions streaming events#3113
Closed
Quratulain-bilal wants to merge 2 commits intoopenai:mainfrom
Closed
fix: emit integer output_index in Chat Completions streaming events#3113Quratulain-bilal wants to merge 2 commits intoopenai:mainfrom
Quratulain-bilal wants to merge 2 commits intoopenai:mainfrom
Conversation
The Chat Completions streaming handler was computing output_index as `state.reasoning_content_index_and_output is not None`, which evaluates to a `bool` (True/False). Downstream consumers and the response event schema expect an `int` (0 or 1). Although Python's `bool` is a subclass of `int`, this leaks `True`/`False` through to JSON serialization and to consumers that compare or index by the integer value, causing subtle mismatches with the Responses API contract used elsewhere in the SDK. Replace each occurrence with the explicit conditional already used at one site in the same file: `1 if state.reasoning_content_index_and_output else 0`. Fixes openai#3109.
Member
|
#3108 covers more scenarios, so let us close this one. |
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.
Fixes #3109. The Chat Completions streaming handler computed output_index as
state.reasoning_content_index_and_output is not None, yielding bool instead of int across 7 event sites.
Replaced each with 1 if state.reasoning_content_index_and_output else 0 (the existing correct pattern
at line 426). All 396 model tests pass; ruff + format clean.