Retain schema field ordering for google gemini and vertex #9828
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.
Title
Retain schema field ordering for google gemini and vertex by specifying
propertyOrdering
Relevant issues
fixes #9783
Pre-Submission checklist
Please complete all items before asking a LiteLLM maintainer to review your PR
tests/litellm/
directory, Adding at least 1 test is a hard requirement - see detailsmake test-unit
)[https://docs.litellm.ai/docs/extras/contributing_code]Type
🐛 Bug Fix
Changes
This change adds the
propertyOrdering
field to vertex/gemini schemas, in order to retain pydantic and dictionary ordering of fields, otherwise the google APIs will alphabetize the fields.I'd previously discovered this strange behavior in ~December 2024. At that time, the ai studio version of the API didin't support the
propertyOrdering
field, only vertex. Since then, they seem to have added it: https://ai.google.dev/gemini-api/docs/structured-output?lang=python. I verified with some basic scripts against the actual vertex and ai studio gemini APIs that this works without error.