Interface: JSONSchema

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

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

[key: string]: any

Properties

$defs?

optional $defs: Record<string, JSONSchema>;

optional $defs: Record<string, JSONSchema>;

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

$ref?

optional $ref: string;

optional $ref: string;

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

additionalItems?

optional additionalItems: boolean | JSONSchema;

optional additionalItems: boolean | JSONSchema;

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

additionalProperties?

optional additionalProperties: boolean | JSONSchema;

optional additionalProperties: boolean | JSONSchema;

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

allOf?

optional allOf: JSONSchema[];

optional allOf: JSONSchema[];

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

anyOf?

optional anyOf: JSONSchema[];

optional anyOf: JSONSchema[];

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

const?

optional const: unknown;

optional const: unknown;

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

default?

optional default: unknown;

optional default: unknown;

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

definitions?

optional definitions: Record<string, JSONSchema>;

optional definitions: Record<string, JSONSchema>;

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

description?

optional description: string;

optional description: string;

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

else?

optional else: JSONSchema;

optional else: JSONSchema;

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

enum?

optional enum: unknown[];

optional enum: unknown[];

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

examples?

optional examples: unknown[];

optional examples: unknown[];

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

exclusiveMaximum?

optional exclusiveMaximum: number;

optional exclusiveMaximum: number;

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

exclusiveMinimum?

optional exclusiveMinimum: number;

optional exclusiveMinimum: number;

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

format?

optional format: string;

optional format: string;

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

if?

optional if: JSONSchema;

optional if: JSONSchema;

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

items?

optional items: JSONSchema | JSONSchema[];

optional items: JSONSchema | JSONSchema[];

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

maximum?

optional maximum: number;

optional maximum: number;

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

maxItems?

optional maxItems: number;

optional maxItems: number;

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

maxLength?

optional maxLength: number;

optional maxLength: number;

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

maxProperties?

optional maxProperties: number;

optional maxProperties: number;

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

minimum?

optional minimum: number;

optional minimum: number;

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

minItems?

optional minItems: number;

optional minItems: number;

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

minLength?

optional minLength: number;

optional minLength: number;

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

minProperties?

optional minProperties: number;

optional minProperties: number;

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

not?

optional not: JSONSchema;

optional not: JSONSchema;

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

oneOf?

optional oneOf: JSONSchema[];

optional oneOf: JSONSchema[];

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

pattern?

optional pattern: string;

optional pattern: string;

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

patternProperties?

optional patternProperties: Record<string, JSONSchema>;

optional patternProperties: Record<string, JSONSchema>;

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

properties?

optional properties: Record<string, JSONSchema>;

optional properties: Record<string, JSONSchema>;

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

propertyNames?

optional propertyNames: JSONSchema;

optional propertyNames: JSONSchema;

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

required?

optional required: string[];

optional required: string[];

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

then?

optional then: JSONSchema;

optional then: JSONSchema;

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

title?

optional title: string;

optional title: string;

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

type?

optional type: string | string[];

optional type: string | string[];

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

uniqueItems?

optional uniqueItems: boolean;

optional uniqueItems: boolean;

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

JSONSchema

Interface: JSONSchema#

Indexable#

Properties#

$defs?#

$ref?#

additionalItems?#

additionalProperties?#

allOf?#

anyOf?#

const?#

default?#

definitions?#

description?#

else?#

enum?#

examples?#

exclusiveMaximum?#

exclusiveMinimum?#

format?#

if?#

items?#

maximum?#

maxItems?#

maxLength?#

maxProperties?#

minimum?#

minItems?#

minLength?#

minProperties?#

not?#

oneOf?#

pattern?#

patternProperties?#

properties?#

propertyNames?#

required?#

then?#

title?#

type?#

uniqueItems?#

Interface: JSONSchema

Indexable

Properties

$defs?

$ref?

additionalItems?

additionalProperties?

allOf?

anyOf?

const?

default?

definitions?

description?

else?

enum?

examples?

exclusiveMaximum?

exclusiveMinimum?

format?

if?

items?

maximum?

maxItems?

maxLength?

maxProperties?

minimum?

minItems?

minLength?

minProperties?

not?

oneOf?

pattern?

patternProperties?

properties?

propertyNames?

required?

then?

title?

type?

uniqueItems?