[Go to site: main page, start]
ADK for TypeScript: API Reference
    Preparing search index...

    Class EnterpriseWebSearchTool

    A Gemini 2+ built-in tool that grounds responses on public web data via Vertex AI Search with Enterprise (Sec4) compliance.

    This tool operates internally within the model and does not require or perform local code execution.

    Hierarchy (View Summary)

    Constructors

    Properties

    "[BASE_TOOL_SIGNATURE_SYMBOL]": true

    A unique symbol to identify ADK base tool class.

    description: string
    isLongRunning: boolean
    name: string

    Accessors

    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.

    • 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.

    Constructors
    Properties
    Accessors
    Methods