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

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>

  Validates the model-provided arguments against the parameter schema and invokes the user-defined execute function.

  Parameters

  • req: RunAsyncToolRequest

    The tool request containing arguments and tool context.

  Returns Promise<unknown>

  A promise resolving to the function's return value.