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:18


func

func: Component<any>

A function that invokes the tool.

Remarks

The function will be treated as an AI.JSX component: the tool parameters will be passed as fields on the first argument (props) and the function can return a string or any AI.JSX Node, synchronously or asynchronously.

Defined in

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


parameters

parameters: FunctionParameters

A map of parameter names to their description and type.

Defined in

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