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

JSONSchema.md

387 lines6.8 KB

Interface: JSONSchema

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

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

[key: string]: any

Properties

$defs?

optional $defs: Record<string, JSONSchema>;

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


$ref?

optional $ref: string;

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


additionalItems?

optional additionalItems: boolean | JSONSchema;

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


additionalProperties?

optional additionalProperties: boolean | JSONSchema;

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


allOf?

optional allOf: JSONSchema[];

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


anyOf?

optional anyOf: JSONSchema[];

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


const?

optional const: unknown;

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


default?

optional default: unknown;

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


definitions?

optional definitions: Record<string, JSONSchema>;

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


description?

optional description: string;

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


else?

optional else: JSONSchema;

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


enum?

optional enum: unknown[];

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


examples?

optional examples: unknown[];

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


exclusiveMaximum?

optional exclusiveMaximum: number;

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


exclusiveMinimum?

optional exclusiveMinimum: number;

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


format?

optional format: string;

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


if?

optional if: JSONSchema;

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


items?

optional items: JSONSchema | JSONSchema[];

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


maximum?

optional maximum: number;

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


maxItems?

optional maxItems: number;

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


maxLength?

optional maxLength: number;

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


maxProperties?

optional maxProperties: number;

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


minimum?

optional minimum: number;

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


minItems?

optional minItems: number;

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


minLength?

optional minLength: number;

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


minProperties?

optional minProperties: number;

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


not?

optional not: JSONSchema;

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


oneOf?

optional oneOf: JSONSchema[];

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


pattern?

optional pattern: string;

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


patternProperties?

optional patternProperties: Record<string, JSONSchema>;

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


properties?

optional properties: Record<string, JSONSchema>;

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


propertyNames?

optional propertyNames: JSONSchema;

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


required?

optional required: string[];

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


then?

optional then: JSONSchema;

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


title?

optional title: string;

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


type?

optional type: string | string[];

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


uniqueItems?

optional uniqueItems: boolean;

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