TanStack

JSONSchema

Interface: JSONSchema

Defined in: packages/ai/src/types.ts:87

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

Indexable

ts
[key: string]: any

Properties

$defs?

ts
optional $defs?: Record<string, JSONSchema>;

Defined in: packages/ai/src/types.ts:97


$ref?

ts
optional $ref?: string;

Defined in: packages/ai/src/types.ts:96


additionalItems?

ts
optional additionalItems?: boolean | JSONSchema;

Defined in: packages/ai/src/types.ts:118


additionalProperties?

ts
optional additionalProperties?: boolean | JSONSchema;

Defined in: packages/ai/src/types.ts:117


allOf?

ts
optional allOf?: JSONSchema[];

Defined in: packages/ai/src/types.ts:99


anyOf?

ts
optional anyOf?: JSONSchema[];

Defined in: packages/ai/src/types.ts:100


const?

ts
optional const?: unknown;

Defined in: packages/ai/src/types.ts:93


default?

ts
optional default?: unknown;

Defined in: packages/ai/src/types.ts:95


definitions?

ts
optional definitions?: Record<string, JSONSchema>;

Defined in: packages/ai/src/types.ts:98


description?

ts
optional description?: string;

Defined in: packages/ai/src/types.ts:94


else?

ts
optional else?: JSONSchema;

Defined in: packages/ai/src/types.ts:105


enum?

ts
optional enum?: unknown[];

Defined in: packages/ai/src/types.ts:92


examples?

ts
optional examples?: unknown[];

Defined in: packages/ai/src/types.ts:124


exclusiveMaximum?

ts
optional exclusiveMaximum?: number;

Defined in: packages/ai/src/types.ts:109


exclusiveMinimum?

ts
optional exclusiveMinimum?: number;

Defined in: packages/ai/src/types.ts:108


format?

ts
optional format?: string;

Defined in: packages/ai/src/types.ts:113


if?

ts
optional if?: JSONSchema;

Defined in: packages/ai/src/types.ts:103


items?

ts
optional items?: JSONSchema | JSONSchema[];

Defined in: packages/ai/src/types.ts:90


maximum?

ts
optional maximum?: number;

Defined in: packages/ai/src/types.ts:107


maxItems?

ts
optional maxItems?: number;

Defined in: packages/ai/src/types.ts:115


maxLength?

ts
optional maxLength?: number;

Defined in: packages/ai/src/types.ts:111


maxProperties?

ts
optional maxProperties?: number;

Defined in: packages/ai/src/types.ts:122


minimum?

ts
optional minimum?: number;

Defined in: packages/ai/src/types.ts:106


minItems?

ts
optional minItems?: number;

Defined in: packages/ai/src/types.ts:114


minLength?

ts
optional minLength?: number;

Defined in: packages/ai/src/types.ts:110


minProperties?

ts
optional minProperties?: number;

Defined in: packages/ai/src/types.ts:121


not?

ts
optional not?: JSONSchema;

Defined in: packages/ai/src/types.ts:102


oneOf?

ts
optional oneOf?: JSONSchema[];

Defined in: packages/ai/src/types.ts:101


pattern?

ts
optional pattern?: string;

Defined in: packages/ai/src/types.ts:112


patternProperties?

ts
optional patternProperties?: Record<string, JSONSchema>;

Defined in: packages/ai/src/types.ts:119


properties?

ts
optional properties?: Record<string, JSONSchema>;

Defined in: packages/ai/src/types.ts:89


propertyNames?

ts
optional propertyNames?: JSONSchema;

Defined in: packages/ai/src/types.ts:120


required?

ts
optional required?: string[];

Defined in: packages/ai/src/types.ts:91


then?

ts
optional then?: JSONSchema;

Defined in: packages/ai/src/types.ts:104


title?

ts
optional title?: string;

Defined in: packages/ai/src/types.ts:123


type?

ts
optional type?: string | string[];

Defined in: packages/ai/src/types.ts:88


uniqueItems?

ts
optional uniqueItems?: boolean;

Defined in: packages/ai/src/types.ts:116