-
Notifications
You must be signed in to change notification settings - Fork 4.7k
fix(openai): strip pattern keyword from Responses API schemas (zod v4 compat) #16521
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
FrancoKaddour
wants to merge
3
commits into
vercel:main
Choose a base branch
from
FrancoKaddour:fix/openai-responses-strip-pattern-keyword
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+61
−2
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
939b38c
fix(openai): strip pattern keyword from Responses API schemas to avoi…
FrancoKaddour ce27c4a
fix(openai): scope removePatternKeyword to JSON Schema structural keys
FrancoKaddour 799beb0
fix(openai): make removePatternKeyword generic to preserve call-site …
FrancoKaddour File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@ai-sdk/openai": patch | ||
| --- | ||
|
|
||
| Fix `server_error` in OpenAI Responses API when schemas generated by zod v4 contain `pattern` keywords with unsupported regex features (e.g. lookaheads from `z.email()`, `z.uuid()`). The `pattern` keyword is now stripped from response format schemas and tool parameters before they are sent to the API. |
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
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
52 changes: 52 additions & 0 deletions
52
packages/openai/src/responses/openai-responses-sanitize-schema.ts
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| // OpenAI structured outputs rejects JSON Schema `pattern` values that contain | ||
| // regex features it does not support (e.g. lookaheads). zod v4's toJSONSchema() | ||
| // emits `pattern` for string validators like z.email(), z.uuid(), z.iso.date(). | ||
| // Strip the keyword recursively before sending schemas to the Responses API. | ||
| // | ||
| // Only standard JSON Schema structural keys are recursed into, so that tool or | ||
| // response parameters whose name happens to be "pattern" are never touched. | ||
| export function removePatternKeyword<T>(schema: T): T { | ||
| if (!schema || typeof schema !== 'object') return schema; | ||
| if (Array.isArray(schema)) return schema.map(removePatternKeyword) as unknown as T; | ||
|
|
||
| const result = { ...(schema as Record<string, unknown>) }; | ||
|
|
||
| // Remove the JSON Schema string-validator keyword at this level. | ||
| delete result['pattern']; | ||
|
|
||
| // Keys whose values are { name → schema } maps. Recurse into the schema | ||
| // values but preserve the keys — a key named "pattern" here is a user- | ||
| // defined property name, not the JSON Schema keyword. | ||
| for (const mapKey of ['properties', 'patternProperties', '$defs', 'definitions']) { | ||
| if ( | ||
| result[mapKey] && | ||
| typeof result[mapKey] === 'object' && | ||
| !Array.isArray(result[mapKey]) | ||
| ) { | ||
| result[mapKey] = Object.fromEntries( | ||
| Object.entries(result[mapKey] as Record<string, unknown>).map( | ||
| ([k, v]) => [k, removePatternKeyword(v)], | ||
| ), | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| // Keys whose values are sub-schemas or arrays of sub-schemas. | ||
| for (const schemaKey of [ | ||
| 'items', | ||
| 'allOf', | ||
| 'anyOf', | ||
| 'oneOf', | ||
| 'not', | ||
| 'additionalProperties', | ||
| 'if', | ||
| 'then', | ||
| 'else', | ||
| ]) { | ||
| if (result[schemaKey] !== undefined) { | ||
| result[schemaKey] = removePatternKeyword(result[schemaKey]); | ||
| } | ||
| } | ||
|
|
||
| return result as unknown as T; | ||
| } | ||
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.
Uh oh!
There was an error while loading. Please reload this page.