ToolMetadata

ToolMetadata<Parameters> = object

Defined in: packages/core/src/llms/type.ts:217

Type Parameters

Parameters

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

Properties

description

description: string

Defined in: packages/core/src/llms/type.ts:220

---

name

name: string

Defined in: packages/core/src/llms/type.ts:221

---

parameters?

optional parameters: Parameters

Defined in: packages/core/src/llms/type.ts:226

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

Link

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

---

requireContext?

optional requireContext: boolean

Defined in: packages/core/src/llms/type.ts:230

Whether the tool requires workflow context to be passed in.