fix: CreateChatCompletion field stream=false is necessary #1099
+88
−34
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
Change Stream field from bool to *bool in ChatCompletionRequest and CompletionRequest to allow explicit stream=false in JSON serialization. Previously, the Stream field used `json:"stream,omitempty"` which caused stream=false to be omitted from JSON since false is the zero value for bool. Some API implementations require stream=false to be explicitly present. With this change: - Stream: nil → field omitted (user doesn't care) - Stream: FalsePtr() → "stream": false explicitly in JSON - Stream: TruePtr() → "stream": true explicitly in JSON Also adds TruePtr() and FalsePtr() helper functions for convenience. Fixes sashabaranov#1073 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]> Signed-off-by: majiayu000 <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1099 +/- ##
==========================================
+ Coverage 99.59% 99.62% +0.02%
==========================================
Files 34 34
Lines 2209 1847 -362
==========================================
- Hits 2200 1840 -360
+ Misses 6 4 -2
Partials 3 3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes an issue where the stream=false field was being omitted from JSON serialization due to Go's omitempty behavior with boolean zero values. The PR changes the Stream field from bool to *bool in both ChatCompletionRequest and CompletionRequest, allowing explicit control over whether the field is included in the JSON output.
Changes:
- Changed
Streamfield type fromboolto*boolinChatCompletionRequestandCompletionRequeststructures - Added
TruePtr()andFalsePtr()helper functions for convenient stream value assignment - Updated all internal usages and tests to use pointer-based stream handling
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| chat.go | Added helper functions TruePtr() and FalsePtr(), changed Stream field to *bool, updated nil check in CreateChatCompletion |
| completion.go | Changed Stream field to *bool, updated nil check in CreateCompletion |
| chat_stream.go | Updated to use TruePtr() when setting Stream in CreateChatCompletionStream |
| stream.go | Updated to use TruePtr() when setting Stream in CreateCompletionStream |
| chat_test.go | Added comprehensive tests for stream field JSON marshaling behavior, updated existing test to use pointer |
| chat_stream_test.go | Updated all test usages to use TruePtr() |
| stream_test.go | Updated all test usages to use TruePtr() |
| completion_test.go | Updated test to use pointer-based stream value |
| example_test.go | Updated examples to use TruePtr() |
| api_integration_test.go | Updated integration test to use TruePtr() |
| README.md | Updated documentation examples to use TruePtr() |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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 #1073
Changes
Streamfield fromboolto*boolinChatCompletionRequestandCompletionRequestTruePtr()andFalsePtr()helper functions for setting stream valuesThis allows users to explicitly set
stream=falsein JSON serialization, which was previously omitted due toomitemptybehavior on boolean zero values.🤖 Generated with Claude Code