Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

convertZodToJsonSchema.md

81 lines2.0 KB

Function: convertZodToJsonSchema()

function convertZodToJsonSchema(schema, options): Record<string, any> | undefined;

Defined in: activities/chat/tools/zod-converter.ts:161

Converts a schema (Zod or JSONSchema) to JSON Schema format compatible with LLM providers. If the input is already a JSONSchema object, it is returned as-is. If the input is a Zod schema, it is converted to JSON Schema.

Parameters

schema

Zod schema or JSONSchema object to convert

SchemaInput | undefined

options

ConvertSchemaOptions = {}

Conversion options

Returns

Record<string, any> | undefined

JSON Schema object that can be sent to LLM providers

Example

import { z } from 'zod';

// Using Zod schema
const zodSchema = z.object({
  location: z.string().describe('City name'),
  unit: z.enum(['celsius', 'fahrenheit']).optional()
});

const jsonSchema = convertZodToJsonSchema(zodSchema);
// Returns:
// {
//   type: 'object',
//   properties: {
//     location: { type: 'string', description: 'City name' },
//     unit: { type: 'string', enum: ['celsius', 'fahrenheit'] }
//   },
//   required: ['location']
// }

// For OpenAI structured output (all fields required, optional fields nullable)
const structuredSchema = convertZodToJsonSchema(zodSchema, { forStructuredOutput: true });
// Returns:
// {
//   type: 'object',
//   properties: {
//     location: { type: 'string', description: 'City name' },
//     unit: { type: ['string', 'null'], enum: ['celsius', 'fahrenheit'] }
//   },
//   required: ['location', 'unit'],
//   additionalProperties: false
// }

// Using JSONSchema directly (passes through unchanged)
const rawSchema = {
  type: 'object',
  properties: { location: { type: 'string' } },
  required: ['location']
};
const result = convertZodToJsonSchema(rawSchema);
// Returns the same object