assistants: fallback type in discriminated unions #1615
+413 −31
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
kristapratico commented Aug 8, 2024
Comment on lines -359 to +363
| type_ = field.annotation | ||
| if field.metadata: | ||
| type_ = wrap_in_annotated_type(field) | ||
| else: | ||
| type_ = field.annotation |
There was a problem hiding this comment.
In the case where the response data for a union field doesn't conform to expected (i.e. we fail the validate_type call), we seem to lose the metadata (which has the discriminator info) when constructing the field. This makes the code construct the first type present in the union instead of creating the actual known type. Test case illustrating this here
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.
Changes being requested
Provides a well-defined behavior / fallback type for response data that doesn't fit any known type in a discriminated union. Aims to handle more gracefully the scenario in which a client may be using a version of the library that does not yet know about a tool type / its response.
Additional context & links
#1574