JSONSchema

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

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

$ref?#

optional $ref?: string;

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

additionalItems?#

optional additionalItems?: boolean | JSONSchema;

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

additionalProperties?#

optional additionalProperties?: boolean | JSONSchema;

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

allOf?#

optional allOf?: JSONSchema[];

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

anyOf?#

optional anyOf?: JSONSchema[];

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

const?#

optional const?: unknown;

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

default?#

optional default?: unknown;

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

definitions?#

optional definitions?: Record<string, JSONSchema>;

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

description?#

optional description?: string;

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

else?#

optional else?: JSONSchema;

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

enum?#

optional enum?: unknown[];

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

examples?#

optional examples?: unknown[];

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

exclusiveMaximum?#

optional exclusiveMaximum?: number;

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

exclusiveMinimum?#

optional exclusiveMinimum?: number;

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

format?#

optional format?: string;

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

if?#

optional if?: JSONSchema;

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

items?#

optional items?: JSONSchema | JSONSchema[];

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

maximum?#

optional maximum?: number;

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

maxItems?#

optional maxItems?: number;

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

maxLength?#

optional maxLength?: number;

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

maxProperties?#

optional maxProperties?: number;

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

minimum?#

optional minimum?: number;

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

minItems?#

optional minItems?: number;

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

minLength?#

optional minLength?: number;

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

minProperties?#

optional minProperties?: number;

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

not?#

optional not?: JSONSchema;

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

oneOf?#

optional oneOf?: JSONSchema[];

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

pattern?#

optional pattern?: string;

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

patternProperties?#

optional patternProperties?: Record<string, JSONSchema>;

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

properties?#

optional properties?: Record<string, JSONSchema>;

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

propertyNames?#

optional propertyNames?: JSONSchema;

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

required?#

optional required?: string[];

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

then?#

optional then?: JSONSchema;

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

title?#

optional title?: string;

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

type?#

optional type?: string | string[];

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

uniqueItems?#

optional uniqueItems?: boolean;

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