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

JSONSchema.md

387 lines7.7 KB

Interface: JSONSchema

Defined in: packages/typescript/ai/src/types.ts:56

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/typescript/ai/src/types.ts:66


$ref?

optional $ref: string;

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


additionalItems?

optional additionalItems: boolean | JSONSchema;

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


additionalProperties?

optional additionalProperties: boolean | JSONSchema;

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


allOf?

optional allOf: JSONSchema[];

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


anyOf?

optional anyOf: JSONSchema[];

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


const?

optional const: unknown;

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


default?

optional default: unknown;

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


definitions?

optional definitions: Record<string, JSONSchema>;

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


description?

optional description: string;

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


else?

optional else: JSONSchema;

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


enum?

optional enum: unknown[];

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


examples?

optional examples: unknown[];

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


exclusiveMaximum?

optional exclusiveMaximum: number;

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


exclusiveMinimum?

optional exclusiveMinimum: number;

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


format?

optional format: string;

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


if?

optional if: JSONSchema;

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


items?

optional items: JSONSchema | JSONSchema[];

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


maximum?

optional maximum: number;

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


maxItems?

optional maxItems: number;

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


maxLength?

optional maxLength: number;

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


maxProperties?

optional maxProperties: number;

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


minimum?

optional minimum: number;

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


minItems?

optional minItems: number;

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


minLength?

optional minLength: number;

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


minProperties?

optional minProperties: number;

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


not?

optional not: JSONSchema;

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


oneOf?

optional oneOf: JSONSchema[];

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


pattern?

optional pattern: string;

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


patternProperties?

optional patternProperties: Record<string, JSONSchema>;

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


properties?

optional properties: Record<string, JSONSchema>;

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


propertyNames?

optional propertyNames: JSONSchema;

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


required?

optional required: string[];

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


then?

optional then: JSONSchema;

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


title?

optional title: string;

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


type?

optional type: string | string[];

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


uniqueItems?

optional uniqueItems: boolean;

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