Do not throw error for unknown event types #165
Merged
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
…d future event types.
jamesrochabrun
approved these changes
Aug 12, 2025
|
make sense to me! |
|
@longseespace sorry the delay, are you interested to merge this change? (asking because is a Draft still) |
|
Ah sorry. I've marked it as ready. |
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.
Overview
Currently, SwiftOpenAI throws a
DecodingError.dataCorruptedErrorfor an unknown response stream event. This is not a good behavior IMO. For example, currently there are new events from OpenAI that are not handled in the library. It's harmless (citation related) but it would break the happy path flow at the app-level.I think the better solution is to return a
unknownEventTyperesponse instead and let the app decide how to handle it.