fix(vertexai): fix "Object of type 'FieldInfo' is not JSON serializable" across all schema generation #1317
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
Fixes "TypeError: Object of type 'FieldInfo' is not JSON serializable" that occurred when using with_structured_output(..., method="json_mode") with Pydantic v2 models containing Field metadata. The issue occurred because model_json_schema() was called without the mode parameter, causing Pydantic v2 to use validation mode which can include non-serializable FieldInfo objects in certain contexts. Adding mode='serialization' tells Pydantic to use its serialization schema generation mode, which properly handles FieldInfo objects. Using mode='serialization' is also semantically correct since the schema describes the model's output format (what Gemini should generate), not input validation rules. Changes: - Add mode='serialization' to model_json_schema() in chat_models.py:2562 - Add unit test for Pydantic v2 FieldInfo serialization - Add unit test for Pydantic v1 backward compatibility - Verify both Pydantic v1 (schema() method) and v2 paths work correctly Backward compatibility: - Pydantic v1 models: Continue using schema() method (line 2560) - Pydantic v2 models: Now use model_json_schema(mode='serialization') - No public API changes, fully backward compatible Signed-off-by: jitokim <[email protected]>
jitokim
force-pushed
the
fix/pydantic-fieldinfo-serialization
branch
from
08399cd to
ff98a8d
Compare
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.
Description
Fixes "TypeError: Object of type 'FieldInfo' is not JSON serializable" that occurred when using with_structured_output(..., method="json_mode") with Pydantic v2 models containing Field metadata.
The issue occurred because model_json_schema() was called without the mode parameter, causing Pydantic v2 to use validation mode which can include non-serializable FieldInfo objects in certain contexts. Adding mode='serialization' tells Pydantic to use its serialization schema generation mode, which properly handles FieldInfo objects.
Using mode='serialization' is also semantically correct since the schema describes the model's output format (what Gemini should generate), not input validation rules.
Changes:
Backward compatibility:
Relevant issues
Type
🆕 New Feature
🐛 Bug Fix
🧹 Refactoring
📖 Documentation
🚄 Infrastructure
✅ Test
Changes(optional)
Testing(optional)
Note(optional)