Skip to main content

Type alias: ToolMetadata<Parameters>

ToolMetadata<Parameters>: object

Type parameters​

• Parameters extends Record<string, unknown> = Record<string, unknown>

Type declaration​

description​

description: string

name​

name: string

parameters?​

optional parameters: Parameters

OpenAI uses JSON Schema to describe the parameters that a tool can take.

https://json-schema.org/understanding-json-schema

Source​

packages/core/src/types.ts:43