Adding .optional() or .partial() to the parent zod schema object with OpenAIs Structured output leads to error

[AnzeKop]

Description

When passing a schema with .optional() or .partial() at the end of the root zod object combined with OpenAIs structured data the call fails

I_APICallError: Invalid schema for response_format 'response': In context=('properties', 'katzen', 'items'), 'required' is required to be supplied and to be an array including every key in properties

Code example

const openAiModel = openai("gpt-4o-2024-08-06", { structuredOutputs: true })
const schema = z.object({
  id: z.number(),
  type: z.enum(["cat"]),
  name: z.string(),
}).partial()

Additional context

No response

[lgrammel]

This error is an OpenAI limitation and thrown by the OpenAI API. You can use a stronger model without structured outputs or design you schema differently.