Class VertexAiSearchTool

A built-in tool using Vertex AI Search.

Hierarchy (View Summary)

BaseTool
- VertexAiSearchTool

Constructors

constructor

new VertexAiSearchTool(params: VertexAiSearchToolParams): VertexAiSearchTool
Parameters
- params: VertexAiSearchToolParams
Returns VertexAiSearchTool
Overrides BaseTool.constructor
- Defined in core/src/tools/vertex_ai_search_tool.ts:62

Properties

`Readonly`[BASE_TOOL_SIGNATURE_SYMBOL]

"[BASE_TOOL_SIGNATURE_SYMBOL]": true

A unique symbol to identify ADK base tool class.

`Readonly`bypassMultiToolsLimit

bypassMultiToolsLimit: boolean

`Optional` `Readonly`dataStoreId

dataStoreId?: string

`Optional` `Readonly`dataStoreSpecs

dataStoreSpecs?: VertexAISearchDataStoreSpec[]

`Readonly`description

description: string

`Optional` `Readonly`filter

filter?: string

`Readonly`isLongRunning

isLongRunning: boolean

`Optional` `Readonly`maxResults

maxResults?: number

`Readonly`name

name: string

`Optional` `Readonly`searchEngineId

searchEngineId?: 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:151

Methods

_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.
Inherited from BaseTool._getDeclaration
- Defined in core/src/tools/base_tool.ts:94

`Protected`buildVertexAiSearchConfig

buildVertexAiSearchConfig(
_readonlyContext: ReadonlyContext,
): VertexAISearchConfig
Builds the VertexAISearch configuration.

Override this method in a subclass to dynamically customize the search configuration based on the context (e.g., set filter based on session state).
Parameters
- _readonlyContext: ReadonlyContext
Returns VertexAISearchConfig
- Defined in core/src/tools/vertex_ai_search_tool.ts:111

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>
Overrides BaseTool.processLlmRequest
- Defined in core/src/tools/vertex_ai_search_tool.ts:123

runAsync

runAsync(): 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.
Returns Promise<unknown>
A promise that resolves to the tool response.
Overrides BaseTool.runAsync
- Defined in core/src/tools/vertex_ai_search_tool.ts:98