6.9 KiB
| id | title |
|---|---|
| JSONSchema | JSONSchema |
Interface: JSONSchema
Defined in: packages/ai/src/types.ts:87
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:97
$ref?
optional $ref?: string;
Defined in: packages/ai/src/types.ts:96
additionalItems?
optional additionalItems?: boolean | JSONSchema;
Defined in: packages/ai/src/types.ts:118
additionalProperties?
optional additionalProperties?: boolean | JSONSchema;
Defined in: packages/ai/src/types.ts:117
allOf?
optional allOf?: JSONSchema[];
Defined in: packages/ai/src/types.ts:99
anyOf?
optional anyOf?: JSONSchema[];
Defined in: packages/ai/src/types.ts:100
const?
optional const?: unknown;
Defined in: packages/ai/src/types.ts:93
default?
optional default?: unknown;
Defined in: packages/ai/src/types.ts:95
definitions?
optional definitions?: Record<string, JSONSchema>;
Defined in: packages/ai/src/types.ts:98
description?
optional description?: string;
Defined in: packages/ai/src/types.ts:94
else?
optional else?: JSONSchema;
Defined in: packages/ai/src/types.ts:105
enum?
optional enum?: unknown[];
Defined in: packages/ai/src/types.ts:92
examples?
optional examples?: unknown[];
Defined in: packages/ai/src/types.ts:124
exclusiveMaximum?
optional exclusiveMaximum?: number;
Defined in: packages/ai/src/types.ts:109
exclusiveMinimum?
optional exclusiveMinimum?: number;
Defined in: packages/ai/src/types.ts:108
format?
optional format?: string;
Defined in: packages/ai/src/types.ts:113
if?
optional if?: JSONSchema;
Defined in: packages/ai/src/types.ts:103
items?
optional items?: JSONSchema | JSONSchema[];
Defined in: packages/ai/src/types.ts:90
maximum?
optional maximum?: number;
Defined in: packages/ai/src/types.ts:107
maxItems?
optional maxItems?: number;
Defined in: packages/ai/src/types.ts:115
maxLength?
optional maxLength?: number;
Defined in: packages/ai/src/types.ts:111
maxProperties?
optional maxProperties?: number;
Defined in: packages/ai/src/types.ts:122
minimum?
optional minimum?: number;
Defined in: packages/ai/src/types.ts:106
minItems?
optional minItems?: number;
Defined in: packages/ai/src/types.ts:114
minLength?
optional minLength?: number;
Defined in: packages/ai/src/types.ts:110
minProperties?
optional minProperties?: number;
Defined in: packages/ai/src/types.ts:121
not?
optional not?: JSONSchema;
Defined in: packages/ai/src/types.ts:102
oneOf?
optional oneOf?: JSONSchema[];
Defined in: packages/ai/src/types.ts:101
pattern?
optional pattern?: string;
Defined in: packages/ai/src/types.ts:112
patternProperties?
optional patternProperties?: Record<string, JSONSchema>;
Defined in: packages/ai/src/types.ts:119
properties?
optional properties?: Record<string, JSONSchema>;
Defined in: packages/ai/src/types.ts:89
propertyNames?
optional propertyNames?: JSONSchema;
Defined in: packages/ai/src/types.ts:120
required?
optional required?: string[];
Defined in: packages/ai/src/types.ts:91
then?
optional then?: JSONSchema;
Defined in: packages/ai/src/types.ts:104
title?
optional title?: string;
Defined in: packages/ai/src/types.ts:123
type?
optional type?: string | string[];
Defined in: packages/ai/src/types.ts:88
uniqueItems?
optional uniqueItems?: boolean;
Defined in: packages/ai/src/types.ts:116