TanStack

JSONSchema

Interface: JSONSchema

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

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:81


$ref?

ts
optional $ref: string;

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


additionalItems?

ts
optional additionalItems: boolean | JSONSchema;

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


additionalProperties?

ts
optional additionalProperties: boolean | JSONSchema;

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


allOf?

ts
optional allOf: JSONSchema[];

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


anyOf?

ts
optional anyOf: JSONSchema[];

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


const?

ts
optional const: unknown;

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


default?

ts
optional default: unknown;

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


definitions?

ts
optional definitions: Record<string, JSONSchema>;

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


description?

ts
optional description: string;

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


else?

ts
optional else: JSONSchema;

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


enum?

ts
optional enum: unknown[];

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


examples?

ts
optional examples: unknown[];

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


exclusiveMaximum?

ts
optional exclusiveMaximum: number;

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


exclusiveMinimum?

ts
optional exclusiveMinimum: number;

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


format?

ts
optional format: string;

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


if?

ts
optional if: JSONSchema;

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


items?

ts
optional items: JSONSchema | JSONSchema[];

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


maximum?

ts
optional maximum: number;

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


maxItems?

ts
optional maxItems: number;

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


maxLength?

ts
optional maxLength: number;

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


maxProperties?

ts
optional maxProperties: number;

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


minimum?

ts
optional minimum: number;

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


minItems?

ts
optional minItems: number;

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


minLength?

ts
optional minLength: number;

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


minProperties?

ts
optional minProperties: number;

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


not?

ts
optional not: JSONSchema;

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


oneOf?

ts
optional oneOf: JSONSchema[];

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


pattern?

ts
optional pattern: string;

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


patternProperties?

ts
optional patternProperties: Record<string, JSONSchema>;

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


properties?

ts
optional properties: Record<string, JSONSchema>;

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


propertyNames?

ts
optional propertyNames: JSONSchema;

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


required?

ts
optional required: string[];

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


then?

ts
optional then: JSONSchema;

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


title?

ts
optional title: string;

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


type?

ts
optional type: string | string[];

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


uniqueItems?

ts
optional uniqueItems: boolean;

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