ADK for TypeScript: API Reference
    Preparing search index...

    Class LlamaIndexRetrieval

    A retrieval tool backed by a LlamaIndex retriever.

    Answers with the text of the single highest-scoring node, as adk-python does.

    Ported from adk-python src/google/adk/tools/retrieval/llama_index_retrieval.py at ref v0.1.0.

    const tool = new LlamaIndexRetrieval({
      name: 'docs',
      description: 'Company documentation.',
      retriever: index.asRetriever(),
    });

    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
    retriever: LlamaIndexRetriever

    Accessors

    Methods

    _getDeclaration

    • _getDeclaration(): FunctionDeclaration

      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

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

    • Whether this tool needs a human to approve args before it runs.

      The gate itself lives in the tool that owns it (see FunctionTool), but the resume path has to ask the same question a turn later, to check that an approval it is about to honour belongs to a tool that gates at all. A tool that never gates returns false here, which is the safe default: an approval naming it is meaningless and gets rejected rather than executed. Mirrors Python's BaseTool.check_require_confirmation.

      Parameters

      • _args: Record<string, unknown>

        The arguments the tool would run with.

      • Optional_toolContext: Context

        The context of the call, when there is one.

      Returns Promise<boolean>

      Whether the call requires confirmation.

    Constructors
    Properties
    Accessors
    Methods