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#
[key: string]: any
Properties#
$defs?#
optional $defs: Record<string, JSONSchema>;
Defined in: packages/ai/src/types.ts:81
$ref?#
optional $ref: string;
Defined in: packages/ai/src/types.ts:80
additionalItems?#
optional additionalItems: boolean | JSONSchema;
Defined in: packages/ai/src/types.ts:102
additionalProperties?#
optional additionalProperties: boolean | JSONSchema;
Defined in: packages/ai/src/types.ts:101
allOf?#
optional allOf: JSONSchema[];
Defined in: packages/ai/src/types.ts:83
anyOf?#
optional anyOf: JSONSchema[];
Defined in: packages/ai/src/types.ts:84
const?#
optional const: unknown;
Defined in: packages/ai/src/types.ts:77
default?#
optional default: unknown;
Defined in: packages/ai/src/types.ts:79
definitions?#
optional definitions: Record<string, JSONSchema>;
Defined in: packages/ai/src/types.ts:82
description?#
optional description: string;
Defined in: packages/ai/src/types.ts:78
else?#
optional else: JSONSchema;
Defined in: packages/ai/src/types.ts:89
enum?#
optional enum: unknown[];
Defined in: packages/ai/src/types.ts:76
examples?#
optional examples: unknown[];
Defined in: packages/ai/src/types.ts:108
exclusiveMaximum?#
optional exclusiveMaximum: number;
Defined in: packages/ai/src/types.ts:93
exclusiveMinimum?#
optional exclusiveMinimum: number;
Defined in: packages/ai/src/types.ts:92
format?#
optional format: string;
Defined in: packages/ai/src/types.ts:97
if?#
optional if: JSONSchema;
Defined in: packages/ai/src/types.ts:87
items?#
optional items: JSONSchema | JSONSchema[];
Defined in: packages/ai/src/types.ts:74
maximum?#
optional maximum: number;
Defined in: packages/ai/src/types.ts:91
maxItems?#
optional maxItems: number;
Defined in: packages/ai/src/types.ts:99
maxLength?#
optional maxLength: number;
Defined in: packages/ai/src/types.ts:95
maxProperties?#
optional maxProperties: number;
Defined in: packages/ai/src/types.ts:106
minimum?#
optional minimum: number;
Defined in: packages/ai/src/types.ts:90
minItems?#
optional minItems: number;
Defined in: packages/ai/src/types.ts:98
minLength?#
optional minLength: number;
Defined in: packages/ai/src/types.ts:94
minProperties?#
optional minProperties: number;
Defined in: packages/ai/src/types.ts:105
not?#
optional not: JSONSchema;
Defined in: packages/ai/src/types.ts:86
oneOf?#
optional oneOf: JSONSchema[];
Defined in: packages/ai/src/types.ts:85
pattern?#
optional pattern: string;
Defined in: packages/ai/src/types.ts:96
patternProperties?#
optional patternProperties: Record<string, JSONSchema>;
Defined in: packages/ai/src/types.ts:103
properties?#
optional properties: Record<string, JSONSchema>;
Defined in: packages/ai/src/types.ts:73
propertyNames?#
optional propertyNames: JSONSchema;
Defined in: packages/ai/src/types.ts:104
required?#
optional required: string[];
Defined in: packages/ai/src/types.ts:75
then?#
optional then: JSONSchema;
Defined in: packages/ai/src/types.ts:88
title?#
optional title: string;
Defined in: packages/ai/src/types.ts:107
type?#
optional type: string | string[];
Defined in: packages/ai/src/types.ts:72
uniqueItems?#
optional uniqueItems: boolean;
Defined in: packages/ai/src/types.ts:100