add ability to have `z.record` part of structured outputs

[lifeiscontent]

Confirm this is a feature request for the Node library and not the underlying OpenAI API.

• This is a feature request for the Node library

Describe the feature or improvement you're requesting

I'm currently working on a tool that provides edits to records the shape looks like:

model: string[][]

updates to model: Record<number, Record<number, string>>

the reason why this shape is ideal is because we can keep an in-memory lookup of all the "rows" and "columns" that have been edited and z.record is a good use case for this shape because we obviously don't need the entire array to be returned, just the edits. currently when using strict: true inside of a run, this kind of schema fails.

Additional context

No response

[silasalberti]

The OpenAI API doesn't support objects with dynamic fields (i.e. Record<number, string>): https://platform.openai.com/docs/guides/structured-outputs#additionalproperties-false-must-always-be-set-in-objects
So this is a current limitation of the OpenAI API, not the SDK.

A pragmatic workaround would be something like this:

model: z.array(
  z.object({
    row: z.number(),
    columns: z.array(
      z.object({
        column: z.number(),
        value: z.string(),
      }),
    ),
  }),
),

[RobertCraigie]

Thanks for feature request, as Silas mentioned, this is a limitation imposed by the API so there's nothing we can do in the SDK unfortunately so I'm going to close this.