Skip to content

feat: add warning for .optional() usage in OpenAI API schemas #1214

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.

Sign up for GitHub

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

Closed
wants to merge 2 commits into from
Closed

feat: add warning for .optional() usage in OpenAI API schemas #1214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ace9e4
feat: add warning for .optional() usage in OpenAI API schemas
devin-ai-integration[bot] Dec 9, 2024
5fac779
formatting
devin-ai-integration[bot] Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/_vendor/zod-to-json-schema/parsers/optional.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,15 @@ import { JsonSchema7Type, parseDef } from '../parseDef';
import { Refs } from '../Refs';

export const parseOptionalDef = (def: ZodOptionalDef, refs: Refs): JsonSchema7Type | undefined => {
if (refs.openaiStrictMode) {
const fieldName = refs.propertyPath?.slice(-1)[0] || 'unknown';
Copy link

@PoornakumarRasiraju PoornakumarRasiraju Feb 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since refs.propertyPath is an array, can we replace .slice(-1)[0] with .at(-1) here? Using .at(-1) improves readability and performance by directly accessing the last element without creating a new array.
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/at

console.warn(
`Warning: Field "${fieldName}" uses .optional() which is not supported by OpenAI API Structured Outputs. ` +
`Please use .nullable() instead. ` +
`See: https://platform.openai.com/docs/guides/structured-outputs#all-fields-must-be-required`,
);
}

Copy link

@PoornakumarRasiraju PoornakumarRasiraju Feb 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unnecessary use of string concatenation (+) since we are already using template literals.

if (refs.currentPath.toString() === refs.propertyPath?.toString()) {
return parseDef(def.innerType._def, refs);
}
Expand Down
18 changes: 18 additions & 0 deletions tests/helpers/zod.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,24 @@ describe('zodResponseFormat', () => {
`);
});

it('warns when using optional fields with OpenAI API', () => {
const consoleSpy = jest.spyOn(console, 'warn');

zodResponseFormat(
z.object({
required: z.string(),
optional: z.string().optional(),
}),
'test',
);

expect(consoleSpy).toHaveBeenCalledWith(
expect.stringContaining('uses .optional() which is not supported by OpenAI API Structured Outputs'),
);

Copy link

@PoornakumarRasiraju PoornakumarRasiraju Feb 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we also test expect(consoleSpy).toHaveBeenCalledTimes(1); to ensure this is called only once.

consoleSpy.mockRestore();
});

it('automatically adds properties with defaults to `required`', () => {
expect(
zodResponseFormat(
Expand Down