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

JSONSchema.md

387 lines6.6 KB

Interface: JSONSchema

Defined in: types.ts:25

JSON Schema type for defining tool input/output schemas as raw JSON Schema objects. This allows tools to be defined without Zod when you have JSON Schema definitions available.

Indexable

[key: string]: any

Properties

$defs?

optional $defs: Record<string, JSONSchema>;

Defined in: types.ts:35


$ref?

optional $ref: string;

Defined in: types.ts:34


additionalItems?

optional additionalItems: boolean | JSONSchema;

Defined in: types.ts:56


additionalProperties?

optional additionalProperties: boolean | JSONSchema;

Defined in: types.ts:55


allOf?

optional allOf: JSONSchema[];

Defined in: types.ts:37


anyOf?

optional anyOf: JSONSchema[];

Defined in: types.ts:38


const?

optional const: any;

Defined in: types.ts:31


default?

optional default: any;

Defined in: types.ts:33


definitions?

optional definitions: Record<string, JSONSchema>;

Defined in: types.ts:36


description?

optional description: string;

Defined in: types.ts:32


else?

optional else: JSONSchema;

Defined in: types.ts:43


enum?

optional enum: any[];

Defined in: types.ts:30


examples?

optional examples: any[];

Defined in: types.ts:62


exclusiveMaximum?

optional exclusiveMaximum: number;

Defined in: types.ts:47


exclusiveMinimum?

optional exclusiveMinimum: number;

Defined in: types.ts:46


format?

optional format: string;

Defined in: types.ts:51


if?

optional if: JSONSchema;

Defined in: types.ts:41


items?

optional items: JSONSchema | JSONSchema[];

Defined in: types.ts:28


maximum?

optional maximum: number;

Defined in: types.ts:45


maxItems?

optional maxItems: number;

Defined in: types.ts:53


maxLength?

optional maxLength: number;

Defined in: types.ts:49


maxProperties?

optional maxProperties: number;

Defined in: types.ts:60


minimum?

optional minimum: number;

Defined in: types.ts:44


minItems?

optional minItems: number;

Defined in: types.ts:52


minLength?

optional minLength: number;

Defined in: types.ts:48


minProperties?

optional minProperties: number;

Defined in: types.ts:59


not?

optional not: JSONSchema;

Defined in: types.ts:40


oneOf?

optional oneOf: JSONSchema[];

Defined in: types.ts:39


pattern?

optional pattern: string;

Defined in: types.ts:50


patternProperties?

optional patternProperties: Record<string, JSONSchema>;

Defined in: types.ts:57


properties?

optional properties: Record<string, JSONSchema>;

Defined in: types.ts:27


propertyNames?

optional propertyNames: JSONSchema;

Defined in: types.ts:58


required?

optional required: string[];

Defined in: types.ts:29


then?

optional then: JSONSchema;

Defined in: types.ts:42


title?

optional title: string;

Defined in: types.ts:61


type?

optional type: string | string[];

Defined in: types.ts:26


uniqueItems?

optional uniqueItems: boolean;

Defined in: types.ts:54