Interface FunctionTool<Parameters, UserData, Result>

interface FunctionTool<Parameters, UserData, Result> {
    [FUNCTION_TOOL_SYMBOL]: true;
    [TOOL_SYMBOL]: true;
    description: string;
    execute: ToolExecuteFunction<Parameters, UserData, Result>;
    parameters: ToolInputSchema<Parameters>;
    type: "function";
}

Type Parameters

  • Parameters extends JSONObject
  • UserData = UnknownUserData
  • Result = unknown

Hierarchy (view full)

Properties

[FUNCTION_TOOL_SYMBOL] [TOOL_SYMBOL] description execute parameters type

Properties

[FUNCTION_TOOL_SYMBOL]

[FUNCTION_TOOL_SYMBOL]: true

[TOOL_SYMBOL]

[TOOL_SYMBOL]: true

description

description: string

The description of the tool. Will be used by the language model to decide whether to use the tool.

execute

execute: ToolExecuteFunction<Parameters, UserData, Result>

An async function that is called with the arguments from the tool call and produces a result. It also carries context about current session, user-defined data, and the tool call id, etc.

parameters

parameters: ToolInputSchema<Parameters>

The schema of the input that the tool expects. The language model will use this to generate the input. It is also used to validate the output of the language model. Use descriptions to make the input understandable for the language model.

type

type: "function"

Settings

Member Visibility

Theme

On This Page

[FUNCTION_TOOL_SYMBOL][TOOL_SYMBOL]descriptionexecuteparameterstype