Python: fix (openai): only propagate usage metadata for final streaming chunk without choices#12977
Merged
Conversation
…ng chunk without choices
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a bug in the OpenAI chat completion streaming logic to prevent incorrect propagation of usage metadata when it appears alongside actual content choices. The change ensures usage metadata is only copied to synthesized choices when the streaming chunk contains no choices, which is the expected pattern for final usage-only chunks from the OpenAI API.
Key Changes
- Modified the condition in
_inner_get_streaming_chat_message_contentsto check for empty choices before propagating usage metadata - Prevents incorrect behavior when streaming chunks contain both choices and usage metadata
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Collaborator
…chat_completion_base.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
moonbox3
approved these changes
Aug 29, 2025
ekzhu
approved these changes
Sep 1, 2025
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.
Motivation and Context
Why is this change required?
What problem does it solve?
What scenario does it contribute to?
If it fixes an open issue, please link to the issue here.
Description
File modified:
Change summary:
replace:
if chunk.usage is not None
with:
if len(chunk.choices) == 0 and chunk.usage is not None
Design notes:
Contribution Checklist
Files changed: