Class BaseToolAbstract

constructor

• new BaseTool(params: BaseToolParams): BaseTool

  Base constructor for a tool.

  Parameters

  • params: BaseToolParams

    The parameters for BaseTool.

  Returns BaseTool

Readonlydescription

ReadonlyisLongRunning

Readonlyname

apiVariant

• get apiVariant(): GoogleLLMVariant

  The Google API LLM variant to use.

  Returns GoogleLLMVariant

_getDeclaration

• _getDeclaration(): FunctionDeclaration | undefined

  Gets the OpenAPI specification of this tool in the form of a FunctionDeclaration.

  NOTE

  • Required if subclass uses the default implementation of processLlmRequest to add function declaration to LLM request.
  • Otherwise, can be skipped, e.g. for a built-in GoogleSearch tool for Gemini.

  Returns FunctionDeclaration | undefined

  The FunctionDeclaration of this tool, or undefined if it doesn't need to be added to LlmRequest.config.

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>

AbstractrunAsync

• runAsync(request: RunAsyncToolRequest): Promise<unknown>

  Runs the tool with the given arguments and context.

  NOTE

  • Required if this tool needs to run at the client side.
  • Otherwise, can be skipped, e.g. for a built-in GoogleSearch tool for Gemini.

  Parameters

  • request: RunAsyncToolRequest

    The request to run the tool.

  Returns Promise<unknown>

  A promise that resolves to the tool response.