@google/adk 0.2.4 → 0.2.5

package/dist/types/agents/llm_agent.d.ts

@@ -24,8 +24,8 @@ export type InstructionProvider = (context: ReadonlyContext) => string | Promise
 /**
  * A callback that runs before a request is sent to the model.
  *
- * @param context The current callback context.
- * @param request The raw model request. Callback can mutate the request.
+ * @param params.context The current callback context.
+ * @param params.request The raw model request. Callback can mutate the request.
  * @returns The content to return to the user. When present, the model call
  *     will be skipped and the provided content will be returned to user.
  */
@@ -43,8 +43,8 @@ export type BeforeModelCallback = SingleBeforeModelCallback | SingleBeforeModelC
 /**
  * A callback that runs after a response is received from the model.
  *
- * @param context The current callback context.
- * @param response The actual model response.
+ * @param params.context The current callback context.
+ * @param params.response The actual model response.
  * @returns The content to return to the user. When present, the actual model
  *     response will be ignored and the provided content will be returned to
  *     user.
@@ -60,24 +60,20 @@ export type SingleAfterModelCallback = (params: {
  order they are listed until a callback does not return None.
  */
 export type AfterModelCallback = SingleAfterModelCallback | SingleAfterModelCallback[];
-/** A generic dictionary type. */
-export type Dict = {
-    [key: string]: unknown;
-};
 /**
  * A callback that runs before a tool is called.
  *
- * @param tool The tool to be called.
- * @param args The arguments to the tool.
- * @param tool_context: ToolContext,
+ * @param params.tool The tool to be called.
+ * @param params.args The arguments to the tool.
+ * @param params.context ToolContext for the tool call.
  * @returns The tool response. When present, the returned tool response will
  *     be used and the framework will skip calling the actual tool.
  */
 export type SingleBeforeToolCallback = (params: {
     tool: BaseTool;
-    args: Dict;
+    args: Record<string, unknown>;
     context: ToolContext;
-}) => Dict | undefined | Promise<Dict | undefined>;
+}) => Record<string, unknown> | undefined | Promise<Record<string, unknown> | undefined>;
 /**
  * A single callback or a list of callbacks.
  *
@@ -88,18 +84,18 @@ export type BeforeToolCallback = SingleBeforeToolCallback | SingleBeforeToolCall
 /**
  * A callback that runs after a tool is called.
  *
- * @param tool The tool to be called.
- * @param args The arguments to the tool.
- * @param tool_context: ToolContext,
- * @param tool_response: The response from the tool.
- * @returns When present, the returned dict will be used as tool result.
+ * @param params.tool The tool to be called.
+ * @param params.args The arguments to the tool.
+ * @param params.context ToolContext for the tool call.
+ * @param params.response The response from the tool.
+ * @returns When present, the returned record will be used as tool result.
  */
 export type SingleAfterToolCallback = (params: {
     tool: BaseTool;
-    args: Dict;
+    args: Record<string, unknown>;
     context: ToolContext;
-    response: Dict;
-}) => Dict | undefined | Promise<Dict | undefined>;
+    response: Record<string, unknown>;
+}) => Record<string, unknown> | undefined | Promise<Record<string, unknown> | undefined>;
 /**
  * A single callback or a list of callbacks.
  *
@@ -111,6 +107,9 @@ export type AfterToolCallback = SingleAfterToolCallback | SingleAfterToolCallbac
 export type ExamplesUnion = Example[] | BaseExampleProvider;
 /** A union of tool types that can be provided to an agent. */
 export type ToolUnion = BaseTool | BaseToolset;
+/**
+ * The configuration options for creating an LLM-based agent.
+ */
 export interface LlmAgentConfig extends BaseAgentConfig {
     /**
      * The model to use for the agent.
@@ -228,10 +227,23 @@ declare class CodeExecutionResponseProcessor implements BaseLlmResponseProcessor
  * The exported response processor instance.
  */
 export declare const responseProcessor: CodeExecutionResponseProcessor;
+/**
+ * A unique symbol to identify ADK agent classes.
+ * Defined once and shared by all LlmAgent instances.
+ */
+declare const LLM_AGENT_SIGNATURE_SYMBOL: unique symbol;
+/**
+ * Type guard to check if an object is an instance of LlmAgent.
+ * @param obj The object to check.
+ * @returns True if the object is an instance of LlmAgent, false otherwise.
+ */
+export declare function isLlmAgent(obj: unknown): obj is LlmAgent;
 /**
  * An agent that uses a large language model to generate responses.
  */
 export declare class LlmAgent extends BaseAgent {
+    /** A unique symbol to identify ADK LLM agent class. */
+    readonly [LLM_AGENT_SIGNATURE_SYMBOL] = true;
     model?: string | BaseLlm;
     instruction: string | InstructionProvider;
     globalInstruction: string | InstructionProvider;
@@ -258,30 +270,30 @@ export declare class LlmAgent extends BaseAgent {
      */
     get canonicalModel(): BaseLlm;
     /**
-     * The resolved self.instruction field to construct instruction for this
+     * The resolved instruction field to construct instruction for this
      * agent.
      *
      * This method is only for use by Agent Development Kit.
      * @param context The context to retrieve the session state.
-     * @returns The resolved self.instruction field.
+     * @returns The resolved instruction field.
      */
     canonicalInstruction(context: ReadonlyContext): Promise<{
         instruction: string;
         requireStateInjection: boolean;
     }>;
     /**
-     * The resolved self.instruction field to construct global instruction.
+     * The resolved globalInstruction field to construct global instruction.
      *
      * This method is only for use by Agent Development Kit.
      * @param context The context to retrieve the session state.
-     * @returns The resolved self.global_instruction field.
+     * @returns The resolved globalInstruction field.
      */
     canonicalGlobalInstruction(context: ReadonlyContext): Promise<{
         instruction: string;
         requireStateInjection: boolean;
     }>;
     /**
-     * The resolved self.tools field as a list of BaseTool based on the context.
+     * The resolved tools field as a list of BaseTool based on the context.
      *
      * This method is only for use by Agent Development Kit.
      */
@@ -294,28 +306,28 @@ export declare class LlmAgent extends BaseAgent {
      */
     private static normalizeCallbackArray;
     /**
-     * The resolved self.before_model_callback field as a list of
+     * The resolved beforeModelCallback field as a list of
      * SingleBeforeModelCallback.
      *
      * This method is only for use by Agent Development Kit.
      */
     get canonicalBeforeModelCallbacks(): SingleBeforeModelCallback[];
     /**
-     * The resolved self.after_model_callback field as a list of
+     * The resolved afterModelCallback field as a list of
      * SingleAfterModelCallback.
      *
      * This method is only for use by Agent Development Kit.
      */
     get canonicalAfterModelCallbacks(): SingleAfterModelCallback[];
     /**
-     * The resolved self.before_tool_callback field as a list of
+     * The resolved beforeToolCallback field as a list of
      * BeforeToolCallback.
      *
      * This method is only for use by Agent Development Kit.
      */
     get canonicalBeforeToolCallbacks(): SingleBeforeToolCallback[];
     /**
-     * The resolved self.after_tool_callback field as a list of AfterToolCallback.
+     * The resolved afterToolCallback field as a list of AfterToolCallback.
      *
      * This method is only for use by Agent Development Kit.
      */

package/dist/types/agents/loop_agent.d.ts

@@ -17,6 +17,17 @@ export interface LoopAgentConfig extends BaseAgentConfig {
      */
     maxIterations?: number;
 }
+/**
+ * A unique symbol to identify ADK agent classes.
+ * Defined once and shared by all LoopAgent instances.
+ */
+declare const LOOP_AGENT_SIGNATURE_SYMBOL: unique symbol;
+/**
+ * Type guard to check if an object is an instance of LoopAgent.
+ * @param obj The object to check.
+ * @returns True if the object is an instance of LoopAgent, false otherwise.
+ */
+export declare function isLoopAgent(obj: unknown): obj is LoopAgent;
 /**
  * A shell agent that run its sub-agents in a loop.
  *
@@ -24,8 +35,13 @@ export interface LoopAgentConfig extends BaseAgentConfig {
  * reached, the loop agent will stop.
  */
 export declare class LoopAgent extends BaseAgent {
+    /**
+     * A unique symbol to identify ADK loop agent class.
+     */
+    readonly [LOOP_AGENT_SIGNATURE_SYMBOL] = true;
     private readonly maxIterations;
     constructor(config: LoopAgentConfig);
     protected runAsyncImpl(context: InvocationContext): AsyncGenerator<Event, void, void>;
     protected runLiveImpl(context: InvocationContext): AsyncGenerator<Event, void, void>;
 }
+export {};

package/dist/types/agents/parallel_agent.d.ts

@@ -6,6 +6,17 @@
 import { Event } from '../events/event.js';
 import { BaseAgent } from './base_agent.js';
 import { InvocationContext } from './invocation_context.js';
+/**
+ * A unique symbol to identify ADK agent classes.
+ * Defined once and shared by all ParallelAgent instances.
+ */
+declare const PARALLEL_AGENT_SIGNATURE_SYMBOL: unique symbol;
+/**
+ * Type guard to check if an object is an instance of ParallelAgent.
+ * @param obj The object to check.
+ * @returns True if the object is an instance of ParallelAgent, false otherwise.
+ */
+export declare function isParallelAgent(obj: unknown): obj is ParallelAgent;
 /**
  * A shell agent that run its sub-agents in parallel in isolated manner.
  *
@@ -16,6 +27,11 @@ import { InvocationContext } from './invocation_context.js';
  *  - Generating multiple responses for review by a subsequent evaluation agent.
  */
 export declare class ParallelAgent extends BaseAgent {
+    /**
+     * A unique symbol to identify ADK parallel agent class.
+     */
+    readonly [PARALLEL_AGENT_SIGNATURE_SYMBOL] = true;
     protected runAsyncImpl(context: InvocationContext): AsyncGenerator<Event, void, void>;
     protected runLiveImpl(context: InvocationContext): AsyncGenerator<Event, void, void>;
 }
+export {};

package/dist/types/agents/sequential_agent.d.ts

@@ -6,10 +6,25 @@
 import { Event } from '../events/event.js';
 import { BaseAgent } from './base_agent.js';
 import { InvocationContext } from './invocation_context.js';
+/**
+ * A unique symbol to identify ADK agent classes.
+ * Defined once and shared by all SequentialAgent instances.
+ */
+declare const SEQUENTIAL_AGENT_SIGNATURE_SYMBOL: unique symbol;
+/**
+ * Type guard to check if an object is an instance of SequentialAgent.
+ * @param obj The object to check.
+ * @returns True if the object is an instance of SequentialAgent, false otherwise.
+ */
+export declare function isSequentialAgent(obj: unknown): obj is SequentialAgent;
 /**
  * A shell agent that runs its sub-agents in a sequential order.
  */
 export declare class SequentialAgent extends BaseAgent {
+    /**
+     * A unique symbol to identify ADK sequential agent class.
+     */
+    readonly [SEQUENTIAL_AGENT_SIGNATURE_SYMBOL] = true;
     protected runAsyncImpl(context: InvocationContext): AsyncGenerator<Event, void, void>;
     /**
      * Implementation for live SequentialAgent.
@@ -20,7 +35,8 @@ export declare class SequentialAgent extends BaseAgent {
      * the model can call this function to signal that it's finished the task and
      * we can move on to the next agent.
      *
-     * @param context: The invocation context of the agent.
+     * @param context The invocation context of the agent.
      */
     protected runLiveImpl(context: InvocationContext): AsyncGenerator<Event, void, void>;
 }
+export {};

package/dist/types/auth/auth_schemes.d.ts

@@ -5,8 +5,11 @@
  */
 import { OpenAPIV3 } from 'openapi-types';
 type Oauth2Flow = OpenAPIV3.OAuth2SecurityScheme['flows'];
-export interface OpenIdConnectWithConfig extends OpenAPIV3
-    .OpenIdSecurityScheme {
+/**
+ * OpenIdConnectWithConfig extends OpenIdSecurityScheme with additional
+ * configuration options.
+ */
+export interface OpenIdConnectWithConfig extends OpenAPIV3.OpenIdSecurityScheme {
     authorizationEndpoint: string;
     tokenEndpoint: string;
     userinfoEndpoint?: string;

package/dist/types/code_executors/base_code_executor.d.ts

@@ -14,11 +14,24 @@ export interface ExecuteCodeParams {
     /** The input of the code execution. */
     codeExecutionInput: CodeExecutionInput;
 }
+/**
+ * A unique symbol to identify BaseCodeExecutor classes.
+ * Defined once and shared by all BaseCodeExecutor instances.
+ */
+declare const BASE_CODE_EXECUTOR_SIGNATURE_SYMBOL: unique symbol;
+/**
+ * Type guard to check if an object is an instance of BaseCodeExecutor.
+ * @param obj The object to check.
+ * @returns True if the object is an instance of BaseCodeExecutor, false otherwise.
+ */
+export declare function isBaseCodeExecutor(obj: unknown): obj is BaseCodeExecutor;
 /**
  * The code executor allows the agent to execute code blocks from model
  * responses and incorporate the execution results into the final response.
  */
 export declare abstract class BaseCodeExecutor {
+    /** A unique symbol to identify BaseCodeExecutor class. */
+    readonly [BASE_CODE_EXECUTOR_SIGNATURE_SYMBOL] = true;
     /**
      * If true, extract and process data files from the model request
      * and attach them to the code executor.
@@ -58,3 +71,4 @@ export declare abstract class BaseCodeExecutor {
      */
     abstract executeCode(params: ExecuteCodeParams): Promise<CodeExecutionResult>;
 }
+export {};

package/dist/types/code_executors/built_in_code_executor.d.ts

@@ -1,6 +1,22 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import { LlmRequest } from '../models/llm_request.js';
 import { BaseCodeExecutor, ExecuteCodeParams } from './base_code_executor.js';
 import { CodeExecutionResult } from './code_execution_utils.js';
+/**
+ * A unique symbol to identify BuiltInCodeExecutor classes.
+ * Defined once and shared by all BuiltInCodeExecutor instances.
+ */
+declare const BUILT_IN_CODE_EXECUTOR_SIGNATURE_SYMBOL: unique symbol;
+/**
+ * Type guard to check if an object is an instance of BuiltInCodeExecutor.
+ * @param obj The object to check.
+ * @returns True if the object is an instance of BuiltInCodeExecutor, false otherwise.
+ */
+export declare function isBuiltInCodeExecutor(obj: unknown): obj is BuiltInCodeExecutor;
 /**
  * A code executor that uses the Model's built-in code executor.
  *
@@ -8,6 +24,9 @@ import { CodeExecutionResult } from './code_execution_utils.js';
  * other models.
  */
 export declare class BuiltInCodeExecutor extends BaseCodeExecutor {
+    /** A unique symbol to identify BuiltInCodeExecutor class. */
+    readonly [BUILT_IN_CODE_EXECUTOR_SIGNATURE_SYMBOL] = true;
     executeCode(params: ExecuteCodeParams): Promise<CodeExecutionResult>;
     processLlmRequest(llmRequest: LlmRequest): void;
 }
+export {};

package/dist/types/common.d.ts

@@ -3,27 +3,45 @@
  * Copyright 2025 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+export { ActiveStreamingTool } from './agents/active_streaming_tool.js';
+export type { ActiveStreamingToolParams } from './agents/active_streaming_tool.js';
 export { BaseAgent, isBaseAgent } from './agents/base_agent.js';
+export type { AfterAgentCallback, BaseAgentConfig, BeforeAgentCallback, SingleAgentCallback, } from './agents/base_agent.js';
+export { BaseLlmRequestProcessor, BaseLlmResponseProcessor, } from './agents/base_llm_processor.js';
 export { CallbackContext } from './agents/callback_context.js';
 export { functionsExportedForTestingOnly } from './agents/functions.js';
 export { InvocationContext } from './agents/invocation_context.js';
+export type { InvocationContextParams } from './agents/invocation_context.js';
 export { LiveRequestQueue } from './agents/live_request_queue.js';
 export type { LiveRequest } from './agents/live_request_queue.js';
-export { LlmAgent } from './agents/llm_agent.js';
-export type { AfterModelCallback, AfterToolCallback, BeforeModelCallback, BeforeToolCallback, SingleAfterModelCallback, SingleAfterToolCallback, SingleBeforeModelCallback, SingleBeforeToolCallback } from './agents/llm_agent.js';
-export { LoopAgent } from './agents/loop_agent.js';
-export { ParallelAgent } from './agents/parallel_agent.js';
-export type { RunConfig } from './agents/run_config.js';
+export { LlmAgent, isLlmAgent } from './agents/llm_agent.js';
+export type { AfterModelCallback, AfterToolCallback, BeforeModelCallback, BeforeToolCallback, InstructionProvider, LlmAgentConfig, SingleAfterModelCallback, SingleAfterToolCallback, SingleBeforeModelCallback, SingleBeforeToolCallback, ToolUnion, } from './agents/llm_agent.js';
+export { LoopAgent, isLoopAgent } from './agents/loop_agent.js';
+export type { LoopAgentConfig } from './agents/loop_agent.js';
+export { ParallelAgent, isParallelAgent } from './agents/parallel_agent.js';
+export { ReadonlyContext } from './agents/readonly_context.js';
 export { StreamingMode } from './agents/run_config.js';
-export { SequentialAgent } from './agents/sequential_agent.js';
+export type { RunConfig } from './agents/run_config.js';
+export { SequentialAgent, isSequentialAgent } from './agents/sequential_agent.js';
+export type { TranscriptionEntry } from './agents/transcription_entry.js';
 export { InMemoryArtifactService } from './artifacts/in_memory_artifact_service.js';
+export { AuthCredentialTypes } from './auth/auth_credential.js';
+export type { AuthCredential, HttpAuth, HttpCredentials, OAuth2Auth, ServiceAccount, ServiceAccountCredential, } from './auth/auth_credential.js';
+export type { AuthScheme, OpenIdConnectWithConfig } from './auth/auth_schemes.js';
+export type { AuthConfig } from './auth/auth_tool.js';
 export type { BaseCredentialService } from './auth/credential_service/base_credential_service.js';
+export { BaseCodeExecutor } from './code_executors/base_code_executor.js';
+export type { ExecuteCodeParams } from './code_executors/base_code_executor.js';
 export { BuiltInCodeExecutor } from './code_executors/built_in_code_executor.js';
-export { createEvent, getFunctionCalls, getFunctionResponses, hasTrailingCodeExecutionResult, isFinalResponse, stringifyContent } from './events/event.js';
+export type { CodeExecutionInput, CodeExecutionResult, File, } from './code_executors/code_execution_utils.js';
+export { createEvent, getFunctionCalls, getFunctionResponses, hasTrailingCodeExecutionResult, isFinalResponse, stringifyContent, } from './events/event.js';
 export type { Event } from './events/event.js';
-export type { EventActions } from './events/event_actions.js';
 export { createEventActions } from './events/event_actions.js';
+export type { EventActions } from './events/event_actions.js';
+export { BaseExampleProvider, isBaseExampleProvider, } from './examples/base_example_provider.js';
+export type { Example } from './examples/example.js';
 export { InMemoryMemoryService } from './memory/in_memory_memory_service.js';
+export type { MemoryEntry } from './memory/memory_entry.js';
 export { BaseLlm, isBaseLlm } from './models/base_llm.js';
 export type { BaseLlmConnection } from './models/base_llm_connection.js';
 export { Gemini } from './models/google_llm.js';
@@ -31,28 +49,34 @@ export type { GeminiParams } from './models/google_llm.js';
 export type { LlmRequest } from './models/llm_request.js';
 export type { LlmResponse } from './models/llm_response.js';
 export { LLMRegistry } from './models/registry.js';
+export type { BaseLlmType } from './models/registry.js';
 export { BasePlugin } from './plugins/base_plugin.js';
 export { LoggingPlugin } from './plugins/logging_plugin.js';
 export { PluginManager } from './plugins/plugin_manager.js';
-export { getAskUserConfirmationFunctionCalls, InMemoryPolicyEngine, PolicyOutcome, REQUEST_CONFIRMATION_FUNCTION_CALL_NAME, SecurityPlugin } from './plugins/security_plugin.js';
-export type { BasePolicyEngine, PolicyCheckResult, ToolCallPolicyContext } from './plugins/security_plugin.js';
+export { InMemoryPolicyEngine, PolicyOutcome, REQUEST_CONFIRMATION_FUNCTION_CALL_NAME, SecurityPlugin, getAskUserConfirmationFunctionCalls, } from './plugins/security_plugin.js';
+export type { BasePolicyEngine, PolicyCheckResult, ToolCallPolicyContext, } from './plugins/security_plugin.js';
 export { InMemoryRunner } from './runner/in_memory_runner.js';
 export { Runner } from './runner/runner.js';
+export type { RunnerConfig } from './runner/runner.js';
 export { InMemorySessionService } from './sessions/in_memory_session_service.js';
 export { createSession } from './sessions/session.js';
 export type { Session } from './sessions/session.js';
 export { State } from './sessions/state.js';
-export { AgentTool } from './tools/agent_tool.js';
-export { BaseTool } from './tools/base_tool.js';
+export { AgentTool, isAgentTool } from './tools/agent_tool.js';
+export type { AgentToolConfig } from './tools/agent_tool.js';
+export { BaseTool, isBaseTool } from './tools/base_tool.js';
 export { BaseToolset } from './tools/base_toolset.js';
-export { FunctionTool } from './tools/function_tool.js';
-export { GOOGLE_SEARCH } from './tools/google_search_tool.js';
+export type { ToolPredicate } from './tools/base_toolset.js';
+export { FunctionTool, isFunctionTool } from './tools/function_tool.js';
+export type { ToolExecuteArgument, ToolExecuteFunction, ToolInputParameters, ToolOptions, } from './tools/function_tool.js';
+export { GOOGLE_SEARCH, GoogleSearchTool } from './tools/google_search_tool.js';
 export { LongRunningFunctionTool } from './tools/long_running_tool.js';
 export { ToolConfirmation } from './tools/tool_confirmation.js';
 export { ToolContext } from './tools/tool_context.js';
 export { LogLevel, setLogLevel } from './utils/logger.js';
 export { isGemini2OrAbove } from './utils/model_name.js';
 export { zodObjectToSchema } from './utils/simple_zod_to_json.js';
+export { GoogleLLMVariant } from './utils/variant_utils.js';
 export { version } from './version.js';
 export * from './artifacts/base_artifact_service.js';
 export * from './memory/base_memory_service.js';

package/dist/types/examples/base_example_provider.d.ts

@@ -4,12 +4,27 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { Example } from './example.js';
+/**
+ * A unique symbol to identify ADK agent classes.
+ * Defined once and shared by all BaseExampleProvider instances.
+ */
+declare const BASE_EXAMPLE_PROVIDER_SIGNATURE_SYMBOL: unique symbol;
+/**
+ * Type guard to check if an object is an instance of BaseExampleProvider.
+ * @param obj The object to check.
+ * @returns True if the object is an instance of BaseExampleProvider, false otherwise.
+ */
+export declare function isBaseExampleProvider(obj: unknown): obj is BaseExampleProvider;
 /**
  * Base class for example providers.
  *
  *  This class defines the interface for providing examples for a given query.
  */
 export declare abstract class BaseExampleProvider {
+    /**
+     * A unique symbol to identify ADK example provider classes.
+     */
+    readonly [BASE_EXAMPLE_PROVIDER_SIGNATURE_SYMBOL] = true;
     /**
      * Returns a list of examples for a given query.
      *
@@ -18,3 +33,4 @@ export declare abstract class BaseExampleProvider {
      */
     abstract getExamples(query: string): Example[];
 }
+export {};