feat: add refusal field to streaming chat completion delta#408
Open
mvanhorn wants to merge 1 commit intoMacPaw:mainfrom
Open
feat: add refusal field to streaming chat completion delta#408mvanhorn wants to merge 1 commit intoMacPaw:mainfrom
mvanhorn wants to merge 1 commit intoMacPaw:mainfrom
Conversation
Adds the `refusal` field to the streaming chat completion delta and logprobs, matching the existing field in ChatResult.Choice.Message. This completes Structured Outputs support for streaming responses per the OpenAI API specification. Closes MacPaw#249
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the streaming chat completion model types to support Structured Outputs refusals, aligning the streaming response structures with the existing non-streaming ChatResult equivalents.
Changes:
- Add
refusal: String?toChatStreamResult.Choice.ChoiceDeltaand include it inCodingKeysso it decodes fromchoices.delta.refusal. - Add
refusal: [ChatCompletionTokenLogprob]?toChatStreamResult.Choice.ChoiceLogprobsto match non-streaming logprobs support.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
refusal: String?toChatStreamResult.Choice.ChoiceDelta, matching the existing field inChatResult.Choice.Messagerefusal: [ChatCompletionTokenLogprob]?toChatStreamResult.Choice.ChoiceLogprobs, matching the non-streaming logprobsrefusalto theCodingKeysenum for correct JSON deserializationswift buildpasses cleanlyPer the OpenAI API reference,
choices.delta.refusalis returned when the model refuses to generate a response in the requested Structured Output format.Closes #249
Test plan
swift buildsucceedsrefusalfield