Skip to main content

Interface: Tool

batteries/use-tools.Tool

Represents a tool that can be provided for the Large Language Model.

Properties

description

description: string

A description of what the tool does.

Defined in

packages/ai-jsx/src/batteries/use-tools.tsx:106


func

func: (...args: any[]) => undefined | null | string | number | boolean | Promise<null | string | number | boolean>

Type declaration

▸ (...args): undefined | null | string | number | boolean | Promise<null | string | number | boolean>

A function to invoke the tool.

Parameters
NameType
...argsany[]
Returns

undefined | null | string | number | boolean | Promise<null | string | number | boolean>

Defined in

packages/ai-jsx/src/batteries/use-tools.tsx:117


parameters

parameters: FunctionParameters

A map of parameter names to their description and type.

Defined in

packages/ai-jsx/src/batteries/use-tools.tsx:111