DOCSAPI reference

INTERFACE

ToolParameters

Defined in: tool.ts:4

JSON Schema object that describes the arguments of a tool.

Indexable

[key: string]: unknown

Properties

Property Type Description Defined in
additionalProperties? boolean Whether arguments not listed in properties are allowed. tool.ts:12
properties Record<string, unknown> JSON Schema of each argument, keyed by argument name. tool.ts:8
required? string[] Names of the arguments the model must provide. tool.ts:10
type string JSON Schema type of the arguments value. Tools take an object, so this is object. tool.ts:6