[aisdk] Updates to openai jsonschema encoding #586
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
loreto
approved these changes
Dec 2, 2025
| // https://platform.openai.com/docs/guides/structured-outputs#root-objects-must-not-be-anyof-and-must-be-an-object | ||
| // NOTE: we could simply encode the input schema, pass it through to OpenAI and let it return an error, but there are | ||
| // other encoding rules we want to enforce later, and limiting the scope here allows us to limit the scope later. | ||
| if schema.Type != "object" { |
Contributor
There was a problem hiding this comment.
I think I would create a helper validateSchema method. Up to you though.
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.
Summary
OpenAI uses jsonschema to define a function tool's input (and other things), but they don't support any arbitrary json schema. Here we implement some (but not all) of the supported subset, and force that schemas always contain
properties, even if empty. These were being omitted when empty because theSchemastruct hasjson:"omitempty")Implementing all the OpenAI restrictions seems like unnecessary eager validation. The API itself will return an error if an invalid schema is passed in.
How was it tested?
Unit tests
Community Contribution License
All community contributions in this pull request are licensed to the project maintainers under the terms of the Apache 2 License.
By creating this pull request I represent that I have the right to license the contributions to the project maintainers under the Apache 2 License as stated in the Community Contribution License.