Annotating the openai.Omit type so that ModelSettings can be serialized by pydantic #938
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
|
Turns out that while this supports creating the core schema, it doesn't yet actually allow serialization of an |
rm-openai
approved these changes
Jun 27, 2025
| ), | ||
| ) | ||
| Omit = Annotated[_Omit, _OmitTypeAnnotation] | ||
| Headers: TypeAlias = Mapping[str, Union[str, Omit]] |
There was a problem hiding this comment.
@tconley1428 can you confirm that requests to the openAI API still work when headers are set like this?
There was a problem hiding this comment.
I can confirm that our normal requests work, but I don't I know if they actually have additional headers (I think a user agent is added by default?), and I'm pretty sure they don't actually have an instance of Omit
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.
Because
openai.Omitis not a type which can be serialized bypydantic, it produces difficulty in consistently serializing/deserializing types across the agents SDK, many of which arepydantictypes. This adds an annotation to enablepydanticto serializeOmit, in particular in the case ofModelSettingswhich containsOmitin itsextra_headers