Class FunctionTool<TParameters>

The base class for all tools.

Type Parameters

TParameters extends ToolInputParameters = undefined

Hierarchy (View Summary)

BaseTool
- FunctionTool
  - LongRunningFunctionTool

Constructors

constructor

new FunctionTool<TParameters extends ToolInputParameters = undefined>(
options: ToolOptions<TParameters>,
): FunctionTool<TParameters>
The constructor acts as the user-friendly factory.
Type Parameters
- TParameters extends ToolInputParameters = undefined
Parameters
- options: ToolOptions<TParameters>
  The configuration for the tool.
Returns FunctionTool<TParameters>
Overrides BaseTool.constructor
- Defined in core/src/tools/function_tool.ts:81

Properties

`Readonly`description

description: string

`Readonly`isLongRunning

isLongRunning: boolean

`Readonly`name

name: string

Accessors

apiVariant

get apiVariant(): GoogleLLMVariant
The Google API LLM variant to use.

Returns GoogleLLMVariant
Inherited from BaseTool.apiVariant
- Defined in core/src/tools/base_tool.ts:125

Methods

_getDeclaration

_getDeclaration(): FunctionDeclaration
Provide a schema for the function.

Returns FunctionDeclaration
Overrides BaseTool._getDeclaration
- Defined in core/src/tools/function_tool.ts:100

processLlmRequest

processLlmRequest(request: ToolProcessLlmRequest): Promise<void>
Processes the outgoing LLM request for this tool.

Use cases:
- Most common use case is adding this tool to the LLM request.
- Some tools may just preprocess the LLM request before it's sent out.
Parameters
- request: ToolProcessLlmRequest
  The request to process the LLM request.
Returns Promise<void>
Inherited from BaseTool.processLlmRequest
- Defined in core/src/tools/base_tool.ts:97

runAsync

runAsync(req: RunAsyncToolRequest): Promise<unknown>
Logic for running the tool.
Parameters
- req: RunAsyncToolRequest
Returns Promise<unknown>
Overrides BaseTool.runAsync
- Defined in core/src/tools/function_tool.ts:111