docs: add OpenAI provider options documentation to scheduleSchema#815
Merged
Conversation
When using `scheduleSchema` with OpenAI models via the AI SDK, users must now pass `providerOptions: { openai: { strictJsonSchema: false } }` to `generateObject`. This is documented in the JSDoc for `scheduleSchema`.
This is required because `@ai-sdk/openai` now defaults `strictJsonSchema` to `true`, which requires all schema properties to be in the `required` array. The `scheduleSchema` uses optional fields which are not compatible with this strict mode.
🦋 Changeset detectedLatest commit: 2673ade The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Claude Code ReviewIssue: Missing providerOptions in eval file The eval file at packages/agents/evals/scheduling.eval.ts:330-340 uses scheduleSchema with OpenAI but does not include the required providerOptions: { openai: { strictJsonSchema: false } }. This will cause the eval to fail with strict JSON schema validation errors. The PR correctly updates the playground example but misses the eval file that also uses scheduleSchema with OpenAI. |
commit: |
whoiskatrin
self-requested a review
January 30, 2026 11:20
whoiskatrin
approved these changes
Jan 30, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
When using
scheduleSchemawith OpenAI models via the AI SDK, users must now passproviderOptions: { openai: { strictJsonSchema: false } }togenerateObject. This is documented in the JSDoc forscheduleSchema.This is required because
@ai-sdk/openainow defaultsstrictJsonSchematotrue, which requires all schema properties to be in therequiredarray. ThescheduleSchemauses optional fields which are not compatible with this strict mode.