Class LongRunningFunctionTool<TParameters>

Readonly[BASE_TOOL_SIGNATURE_SYMBOL]

Readonly[FUNCTION_TOOL_SIGNATURE_SYMBOL]

Readonlydescription

ReadonlyisLongRunning

Readonlyname

apiVariant

• get apiVariant(): GoogleLLMVariant

  The Google API LLM variant to use.

  Returns GoogleLLMVariant

_callLive

• _callLive(req: CallLiveToolRequest): AsyncGenerator<unknown, void, void>

  Invokes the tool in live streaming mode, injecting any active input stream from the invocation context and yielding items from the returned stream.

  Parameters

  • req: CallLiveToolRequest

    The live tool invocation request.

  Returns AsyncGenerator<unknown, void, void>

checkRequireConfirmation

• checkRequireConfirmation(
      args: Record<string, unknown>,
      toolContext?: Context,
  ): Promise<boolean>

  Whether this call is gated on human approval — the static flag, or the predicate evaluated against the validated arguments.

  Parameters

  • args: Record<string, unknown>

    The arguments the tool would run with.

  • OptionaltoolContext: Context

    The context of the call, when there is one.

  Returns Promise<boolean>

  Whether the call requires confirmation.

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>

runAsync

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

  Invokes the user-defined execute function with the model-provided arguments, after parsing them when parameters is a Zod object schema. Any other parameters value is passed through unchecked.

  Parameters

  • req: RunAsyncToolRequest

    The tool request containing arguments and tool context.

  Returns Promise<unknown>

  A promise resolving to the function's return value.

  Throws

  Wrapped as Error in tool '<name>': … when a Zod parameters schema rejects the arguments or execute throws.