@google/adk 2.3.0 → 2.5.0

package/dist/types/telemetry/tracing.d.ts

@@ -1,129 +0,0 @@
-/**
- * @license
- * Copyright 2025 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-/**
- * NOTE:
- *
- *    We expect that the underlying GenAI SDK will provide a certain
- *    level of tracing and logging telemetry aligned with Open Telemetry
- *    Semantic Conventions (such as logging prompts, responses,
- *    request properties, etc.) and so the information that is recorded by the
- *    Agent Development Kit should be focused on the higher-level
- *    constructs of the framework that are not observable by the SDK.
- */
-import { Content } from '@google/genai';
-import { Context } from '@opentelemetry/api';
-import { BaseAgent } from '../agents/base_agent.js';
-import { InvocationContext } from '../agents/invocation_context.js';
-import { Event } from '../events/event.js';
-import { LlmRequest } from '../models/llm_request.js';
-import { LlmResponse } from '../models/llm_response.js';
-import { BaseTool } from '../tools/base_tool.js';
-export declare const tracer: import("@opentelemetry/api").Tracer;
-export interface TraceAgentInvocationParams {
-    agent: BaseAgent;
-    invocationContext: InvocationContext;
-}
-/**
- * Sets span attributes immediately available on agent invocation according to OTEL semconv version 1.37.
- *
- * @param params The parameters object containing agent and invocation context.
- *
- * Inference related fields are not set, due to their planned removal from invoke_agent span:
- * https://github.com/open-telemetry/semantic-conventions/issues/2632
- *
- * `gen_ai.agent.id` is not set because currently it's unclear what attributes this field should have, specifically:
- * - In which scope should it be unique (globally, given project, given agentic flow, given deployment).
- * - Should it be unchanging between deployments, and how this should this be achieved.
- *
- * `gen_ai.data_source.id` is not set because it's not available.
- * Closest type which could contain this information is types.GroundingMetadata, which does not have an ID.
- *
- * `server.*` attributes are not set pending confirmation from aabmass.
- */
-export declare function traceAgentInvocation({ agent, invocationContext, }: TraceAgentInvocationParams): void;
-export interface TraceWorkflowInvocationParams {
-    workflowName: string;
-    nodePath: string;
-    sessionId: string;
-}
-export declare function traceWorkflowInvocation({ workflowName, nodePath, sessionId, }: TraceWorkflowInvocationParams): void;
-export type NodeExecutionStatus = 'completed' | 'waiting' | 'failed';
-export interface TraceNodeExecutionParams {
-    nodePath: string;
-    runId: string;
-    attempt: number;
-    status: NodeExecutionStatus;
-    interruptCount: number;
-}
-export declare function traceNodeExecution({ nodePath, runId, attempt, status, interruptCount, }: TraceNodeExecutionParams): void;
-export interface TraceToolCallParams {
-    tool: BaseTool;
-    args: Record<string, unknown>;
-    functionResponseEvent: Event;
-    invocationContext: InvocationContext;
-}
-/**
- * Traces tool call.
- *
- * @param params The parameters object containing tool, args, and function response event.
- */
-export declare function traceToolCall({ tool, args, functionResponseEvent, invocationContext, }: TraceToolCallParams): void;
-export interface TraceMergedToolCallsParams {
-    responseEventId: string;
-    functionResponseEvent: Event;
-    invocationContext: InvocationContext;
-}
-/**
- * Traces merged tool call events.
- *
- * Calling this function is not needed for telemetry purposes. This is provided
- * for preventing /debug/trace requests (typically sent by web UI).
- *
- * @param params The parameters object containing response event ID and function response event.
- */
-export declare function traceMergedToolCalls({ responseEventId, functionResponseEvent, invocationContext, }: TraceMergedToolCallsParams): void;
-export interface TraceCallLlmParams {
-    invocationContext: InvocationContext;
-    eventId: string;
-    llmRequest: LlmRequest;
-    llmResponse: LlmResponse;
-}
-/**
- * Traces a call to the LLM.
- *
- * This function records details about the LLM request and response as
- * attributes on the current OpenTelemetry span.
- *
- * @param params The parameters object containing invocationContext, eventId, llmRequest, and llmResponse.
- */
-export declare function traceCallLlm({ invocationContext, eventId, llmRequest, llmResponse, }: TraceCallLlmParams): void;
-export interface TraceSendDataParams {
-    /** The invocation context for the current agent run. */
-    invocationContext: InvocationContext;
-    /** The ID of the event. */
-    eventId: string;
-    /** A list of content objects. */
-    data: Content[];
-}
-/**
- * Traces the sending of data to the agent.
- *
- * This function records details about the data sent to the agent as
- * attributes on the current OpenTelemetry span.
- *
- * @param params The parameters object containing invocationContext, eventId, and data.
- */
-export declare function traceSendData({ invocationContext, eventId, data, }: TraceSendDataParams): void;
-/**
- * Runs an async generator function with both OTEL context and JavaScript 'this' context.
- *
- * @param otelContext - The OpenTelemetry context to bind the generator to
- * @param generatorFnContext - The 'this' context to bind to the generator function
- * @param generatorFn - The generator function to execute
- *
- * @returns A new async generator that executes within both contexts
- */
-export declare function runAsyncGeneratorWithOtelContext<TThis, T>(otelContext: Context, generatorFnContext: TThis, generatorFn: (this: TThis) => AsyncGenerator<T, void, void>): AsyncGenerator<T, void, void>;

package/dist/types/tools/crewai_tool.d.ts

@@ -1,85 +0,0 @@
-/**
- * @license
- * Copyright 2026 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import { FunctionDeclaration } from '@google/genai';
-import { Context } from '../agents/context.js';
-import { SchemaLike } from '../utils/schema.js';
-import { FunctionTool, ToolInputParameters } from './function_tool.js';
-/**
- * Schema formats accepted on a wrapped CrewAI tool.
- */
-export type CrewaiSchemaLike = SchemaLike | {
-    jsonSchema: () => Record<string, unknown>;
-} | {
-    modelJsonSchema: () => Record<string, unknown>;
-} | Record<string, unknown>;
-/**
- * Structural interface for a CrewAI tool instance.
- */
-export interface CrewaiToolLike {
-    /**
-     * The name of the CrewAI tool.
-     */
-    name?: string;
-    /**
-     * The description of the CrewAI tool.
-     */
-    description?: string;
-    /**
-     * Optional parameters schema for the tool.
-     */
-    argsSchema?: CrewaiSchemaLike;
-    /**
-     * Executes the CrewAI tool with the given arguments.
-     */
-    run(args: Record<string, unknown>, toolContext?: Context): unknown | Promise<unknown>;
-}
-/**
- * Configuration options for {@link CrewaiTool}.
- */
-export interface CrewaiToolConfig {
-    /**
-     * The wrapped CrewAI tool instance.
-     */
-    tool: CrewaiToolLike;
-    /**
-     * Optional custom name override. When omitted or empty, defaults to
-     * `tool.name` with spaces replaced by underscores and lowercased.
-     */
-    name?: string;
-    /**
-     * Optional custom description override. When omitted or empty, defaults to
-     * `tool.description`.
-     */
-    description?: string;
-}
-declare const CREWAI_TOOL_SIGNATURE_SYMBOL: unique symbol;
-/**
- * Type guard to check if an object is an instance of {@link CrewaiTool}.
- */
-export declare function isCrewaiTool(obj: unknown): obj is CrewaiTool;
-/**
- * Wrapper class that adapts a CrewAI tool for use in ADK.
- *
- * If the original tool name and description are not suitable, you can override
- * them in the constructor.
- */
-export declare class CrewaiTool extends FunctionTool<ToolInputParameters> {
-    /** A unique symbol to identify ADK CrewaiTool class. */
-    readonly [CREWAI_TOOL_SIGNATURE_SYMBOL] = true;
-    /**
-     * The wrapped CrewAI tool.
-     */
-    readonly tool: CrewaiToolLike;
-    constructor(toolOrConfig: CrewaiToolConfig | CrewaiToolLike, options?: {
-        name?: string;
-        description?: string;
-    });
-    /**
-     * Builds the `FunctionDeclaration` for the wrapped CrewAI tool.
-     */
-    _getDeclaration(): FunctionDeclaration;
-}
-export {};

package/dist/types/tools/google_api_tool/google_api_tool_set.d.ts

@@ -1,78 +0,0 @@
-/**
- * @license
- * Copyright 2026 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import { OpenAPIV3 } from 'openapi-types';
-import { ReadonlyContext } from '../../agents/readonly_context.js';
-import { BaseToolset, ToolPredicate } from '../base_toolset.js';
-import { OpenAPIToolset } from '../openapi_tool/openapi_toolset.js';
-import { RestApiTool } from '../openapi_tool/rest_api_tool.js';
-import { GoogleApiTool } from './google_api_tool.js';
-declare const GOOGLE_API_TOOL_SET_SIGNATURE_SYMBOL: unique symbol;
-/**
- * Options for constructing a {@link GoogleApiToolSet}.
- */
-export interface GoogleApiToolSetOptions {
-    apiName?: string;
-    apiVersion?: string;
-    toolFilter?: ToolPredicate | string[];
-}
-/**
- * Options for loading an {@link OpenAPIToolset} pre-configured with Google
- * OpenID Connect endpoints.
- */
-export interface LoadToolSetWithOidcAuthOptions {
-    specFile?: string;
-    specDict?: OpenAPIV3.Document;
-    scopes?: string[];
-    callerDir?: string;
-}
-/**
- * Type guard to check if an object is an instance of {@link GoogleApiToolSet}.
- */
-export declare function isGoogleApiToolSet(obj: unknown): obj is GoogleApiToolSet;
-/**
- * Toolset that wraps Google Discovery API operations as {@link GoogleApiTool}
- * instances configured for Google OpenID Connect authentication.
- */
-export declare class GoogleApiToolSet extends BaseToolset {
-    readonly [GOOGLE_API_TOOL_SET_SIGNATURE_SYMBOL] = true;
-    readonly apiName?: string;
-    readonly apiVersion?: string;
-    private tools;
-    private toolsLoaded;
-    private loadingPromise?;
-    private pendingAuth?;
-    constructor(tools?: Array<RestApiTool | GoogleApiTool>, options?: GoogleApiToolSetOptions);
-    private ensureToolsLoaded;
-    /**
-     * Returns all tools in the toolset matching the active `toolFilter`.
-     */
-    getTools(context?: ReadonlyContext): Promise<GoogleApiTool[]>;
-    /**
-     * Finds a tool in the toolset by name.
-     */
-    getTool(toolName: string): Promise<GoogleApiTool | undefined>;
-    /**
-     * Configures OAuth2 client ID and secret across all tools in the toolset.
-     */
-    configureAuth(clientId: string, clientSecret: string): void;
-    close(): Promise<void>;
-    /**
-     * Builds an {@link OpenAPIToolset} from an OpenAPI specification dictionary
-     * or YAML/JSON file and configures it with Google's OpenID Connect endpoints.
-     */
-    static loadToolSetWithOidcAuth(options?: LoadToolSetWithOidcAuthOptions): OpenAPIToolset;
-    /**
-     * Fetches and converts a Google API Discovery document and returns a
-     * {@link GoogleApiToolSet} containing its operations.
-     */
-    static loadToolSet(apiName: string, apiVersion: string): Promise<GoogleApiToolSet>;
-}
-/**
- * Creates a lazy-loaded {@link GoogleApiToolSet} singleton without triggering
- * the `@experimental` class constructor warning at module import time.
- */
-export declare function createLazyGoogleApiToolSet(apiName: string, apiVersion: string): GoogleApiToolSet;
-export {};

package/dist/types/tools/google_api_tool/google_api_tool_sets.d.ts

@@ -1,33 +0,0 @@
-/**
- * @license
- * Copyright 2026 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-/**
- * Pre-configured {@link GoogleApiToolSet} for the Google Calendar v3 API.
- */
-export declare const calendarToolSet: import("./google_api_tool_set.js").GoogleApiToolSet;
-/**
- * Pre-configured {@link GoogleApiToolSet} for the Google BigQuery v2 API.
- */
-export declare const bigqueryToolSet: import("./google_api_tool_set.js").GoogleApiToolSet;
-/**
- * Pre-configured {@link GoogleApiToolSet} for the Gmail v1 API.
- */
-export declare const gmailToolSet: import("./google_api_tool_set.js").GoogleApiToolSet;
-/**
- * Pre-configured {@link GoogleApiToolSet} for the YouTube Data v3 API.
- */
-export declare const youtubeToolSet: import("./google_api_tool_set.js").GoogleApiToolSet;
-/**
- * Pre-configured {@link GoogleApiToolSet} for the Google Slides v1 API.
- */
-export declare const slidesToolSet: import("./google_api_tool_set.js").GoogleApiToolSet;
-/**
- * Pre-configured {@link GoogleApiToolSet} for the Google Sheets v4 API.
- */
-export declare const sheetsToolSet: import("./google_api_tool_set.js").GoogleApiToolSet;
-/**
- * Pre-configured {@link GoogleApiToolSet} for the Google Docs v1 API.
- */
-export declare const docsToolSet: import("./google_api_tool_set.js").GoogleApiToolSet;

package/dist/types/tools/langchain_tool.d.ts

@@ -1,103 +0,0 @@
-/**
- * @license
- * Copyright 2026 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import { FunctionDeclaration } from '@google/genai';
-import { Context } from '../agents/context.js';
-import { SchemaLike } from '../utils/schema.js';
-import { FunctionTool, ToolInputParameters } from './function_tool.js';
-/**
- * Schema formats accepted on a wrapped LangChain tool.
- */
-export type LangchainSchemaLike = SchemaLike | {
-    jsonSchema: () => Record<string, unknown>;
-} | {
-    modelJsonSchema: () => Record<string, unknown>;
-} | Record<string, unknown>;
-/**
- * Structural interface for a LangChain tool instance.
- */
-export interface LangchainToolLike {
-    /**
-     * The name of the LangChain tool.
-     */
-    name?: string;
-    /**
-     * The description of the LangChain tool.
-     */
-    description?: string;
-    /**
-     * Optional parameter schema (`argsSchema`).
-     */
-    argsSchema?: LangchainSchemaLike;
-    /**
-     * Optional parameter schema (`StructuredTool.schema`).
-     */
-    schema?: LangchainSchemaLike;
-    /**
-     * Optional raw parameter properties map (`BaseTool.args`).
-     */
-    args?: Record<string, unknown>;
-    /**
-     * Executes the tool (`BaseTool._run`).
-     */
-    _run?(args: Record<string, unknown>, toolContext?: Context): unknown | Promise<unknown>;
-    /**
-     * Executes the tool (`StructuredTool._call`).
-     */
-    _call?(args: Record<string, unknown>, toolContext?: Context): unknown | Promise<unknown>;
-    /**
-     * Executes the tool (`Runnable.invoke`).
-     */
-    invoke?(args: Record<string, unknown>, toolContext?: Context): unknown | Promise<unknown>;
-    /**
-     * Executes a simple convention-based tool (`tool.run`).
-     */
-    run?(args: Record<string, unknown>, toolContext?: Context): unknown | Promise<unknown>;
-}
-/**
- * Configuration options for {@link LangchainTool}.
- */
-export interface LangchainToolConfig {
-    /**
-     * The wrapped LangChain tool instance.
-     */
-    tool: LangchainToolLike;
-    /**
-     * Optional custom name override.
-     */
-    name?: string;
-    /**
-     * Optional custom description override.
-     */
-    description?: string;
-}
-declare const LANGCHAIN_TOOL_SIGNATURE_SYMBOL: unique symbol;
-/**
- * Type guard to check if an object is an instance of {@link LangchainTool}.
- */
-export declare function isLangchainTool(obj: unknown): obj is LangchainTool;
-/**
- * Wrapper class that adapts a LangChain tool for use in ADK.
- *
- * If the original tool name and description are not suitable, you can override
- * them in the constructor.
- */
-export declare class LangchainTool extends FunctionTool<ToolInputParameters> {
-    /** A unique symbol to identify ADK LangchainTool class. */
-    readonly [LANGCHAIN_TOOL_SIGNATURE_SYMBOL] = true;
-    /**
-     * The wrapped LangChain tool.
-     */
-    readonly tool: LangchainToolLike;
-    constructor(toolOrConfig: LangchainToolConfig | LangchainToolLike, options?: {
-        name?: string;
-        description?: string;
-    });
-    /**
-     * Builds the `FunctionDeclaration` for the wrapped LangChain tool.
-     */
-    _getDeclaration(): FunctionDeclaration;
-}
-export {};

package/dist/types/tools/toolbox_tool.d.ts

@@ -1,73 +0,0 @@
-/**
- * @license
- * Copyright 2026 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import { LangchainTool, LangchainToolLike } from './langchain_tool.js';
-/**
- * Structural interface for a Toolbox client instance.
- */
-export interface ToolboxClientLike {
-    /**
-     * Loads a single tool by name (camelCase convention).
-     */
-    loadTool?: (toolName: string) => LangchainToolLike;
-    /**
-     * Loads a single tool by name (snake_case convention).
-     */
-    load_tool?: (toolName: string) => LangchainToolLike;
-    /**
-     * Loads a toolset by name (camelCase convention).
-     */
-    loadToolset?: (toolsetName: string) => LangchainToolLike[];
-    /**
-     * Loads a toolset by name (snake_case convention).
-     */
-    load_toolset?: (toolsetName: string) => LangchainToolLike[];
-}
-/**
- * Configuration options for {@link ToolboxTool}.
- */
-export interface ToolboxToolOptions {
-    /**
-     * The URL of the Toolbox server.
-     */
-    url?: string;
-    /**
-     * Optional pre-configured Toolbox client instance.
-     */
-    client?: ToolboxClientLike;
-}
-declare const TOOLBOX_TOOL_SIGNATURE_SYMBOL: unique symbol;
-/**
- * Type guard to check if an object is an instance of {@link ToolboxTool}.
- */
-export declare function isToolboxTool(obj: unknown): obj is ToolboxTool;
-/**
- * Provides access to Toolbox tools and toolsets wrapped as {@link LangchainTool}
- * instances.
- */
-export declare class ToolboxTool {
-    /** A unique symbol to identify ADK ToolboxTool class. */
-    readonly [TOOLBOX_TOOL_SIGNATURE_SYMBOL] = true;
-    /**
-     * The URL of the Toolbox server, if provided.
-     */
-    readonly url?: string;
-    /**
-     * The underlying Toolbox client.
-     */
-    readonly toolboxClient: ToolboxClientLike;
-    constructor(urlOrOptions: string | ToolboxToolOptions);
-    /**
-     * Loads a single tool from the Toolbox client and wraps it in a
-     * {@link LangchainTool}.
-     */
-    getTool(toolName: string): LangchainTool;
-    /**
-     * Loads a toolset from the Toolbox client and wraps each tool in a
-     * {@link LangchainTool}.
-     */
-    getToolset(toolsetName: string): LangchainTool[];
-}
-export {};