Skip to main content

Interface: UseToolsProps

batteries/use-tools.UseToolsProps

Properties to be passed to the UseTools component.

Properties

children

children: Node

The conversation in which the AI can use a tool.

Defined in

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


tools

tools: Record<string, Tool>

The tools the AI can use.

Defined in

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


showSteps

Optional showSteps: boolean

Whether the result should include intermediate steps, for example, the execution of the function and its response.

Defined in

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


userData

Optional userData: string

User data the AI can use to determine what parameters to invoke the tool with.

For instance, if the user's query can be "what's the weather like at my current location", you might pass userData as { "location": "Seattle" }.

Defined in

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