align streaming usage chunks with OpenAI spec#4616
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the OpenAI-compatible streaming responses in api_server.py to better match OpenAI’s stream_options.include_usage behavior (emit usage: null on regular chunks and emit a dedicated final chunk containing aggregated usage).
Changes:
- Add a shared
include_usageflag and ensure per-chunkusageis explicitly present asnullwhen requested. - Emit a dedicated final “usage-only” stream chunk (
choices: [],usage: {...}) before[DONE]for both chat completions and completions. - Refactor streaming serialization to use
model_dump(mode='json', exclude_none=True)plus manual injection ofusagewhen needed.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
lvhan028
changed the title
irexyc
approved these changes
May 25, 2026
lvhan028
added a commit
to lvhan028/lmdeploy
that referenced
this pull request
May 27, 2026
* fix(openai): align streaming usage chunks with OpenAI spec * fix according to copilot comment
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.
No description provided.