@google/genai 2.3.0 → 2.4.0

package/dist/genai.d.ts

@@ -66,6 +66,225 @@ export declare enum AdapterSize {
     ADAPTER_SIZE_THIRTY_TWO = "ADAPTER_SIZE_THIRTY_TWO"
 }
 
+/**
+ * An agent definition for the CreateAgent API. This message is the target for
+ * annotation-parser-based JSON parsing. New format: { "id": "customer-sentinel",
+ * "base_agent": "", "system_instruction": "...", "base_environment": { "type":
+ * "remote", "sources": [...] }, "tools": [ {"type": "code_execution"} ] }
+ */
+declare interface Agent {
+    /**
+     * The unique identifier for the agent.
+     */
+    id?: string;
+    /**
+     * The base agent to extend.
+     */
+    base_agent?: string;
+    /**
+     * The environment configuration for the agent.
+     */
+    base_environment?: string | InteractionsAPI.Environment;
+    /**
+     * Agent description for developers to quickly read and understand.
+     */
+    description?: string;
+    /**
+     * System instruction for the agent.
+     */
+    system_instruction?: string;
+    /**
+     * The tools available to the agent.
+     */
+    tools?: Array<Agent.CodeExecution | Agent.GoogleSearch | Agent.URLContext | Agent.MCPServer>;
+}
+
+declare namespace Agent {
+    /**
+     * A tool that can be used by the model to execute code.
+     */
+    interface CodeExecution {
+        type: 'code_execution';
+    }
+    /**
+     * A tool that can be used by the model to search Google.
+     */
+    interface GoogleSearch {
+        type: 'google_search';
+        /**
+         * The types of search grounding to enable.
+         */
+        search_types?: Array<'web_search' | 'image_search' | 'enterprise_web_search'>;
+    }
+    /**
+     * A tool that can be used by the model to fetch URL context.
+     */
+    interface URLContext {
+        type: 'url_context';
+    }
+    /**
+     * A MCPServer is a server that can be called by the model to perform actions.
+     */
+    interface MCPServer {
+        type: 'mcp_server';
+        /**
+         * The allowed tools.
+         */
+        allowed_tools?: Array<InteractionsAPI.AllowedTools>;
+        /**
+         * Optional: Fields for authentication headers, timeouts, etc., if needed.
+         */
+        headers?: {
+            [key: string]: string;
+        };
+        /**
+         * The name of the MCPServer.
+         */
+        name?: string;
+        /**
+         * The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp"
+         */
+        url?: string;
+    }
+}
+
+declare interface AgentCreateParams {
+    /**
+     * Path param: Which version of the API to use.
+     */
+    api_version?: string;
+    /**
+     * Body param: The unique identifier for the agent.
+     */
+    id?: string;
+    /**
+     * Body param: The base agent to extend.
+     */
+    base_agent?: string;
+    /**
+     * Body param: The environment configuration for the agent.
+     */
+    base_environment?: string | InteractionsAPI.Environment;
+    /**
+     * Body param: Agent description for developers to quickly read and understand.
+     */
+    description?: string;
+    /**
+     * Body param: System instruction for the agent.
+     */
+    system_instruction?: string;
+    /**
+     * Body param: The tools available to the agent.
+     */
+    tools?: Array<AgentCreateParams.CodeExecution | AgentCreateParams.GoogleSearch | AgentCreateParams.URLContext | AgentCreateParams.MCPServer>;
+}
+
+declare namespace AgentCreateParams {
+    /**
+     * A tool that can be used by the model to execute code.
+     */
+    interface CodeExecution {
+        type: 'code_execution';
+    }
+    /**
+     * A tool that can be used by the model to search Google.
+     */
+    interface GoogleSearch {
+        type: 'google_search';
+        /**
+         * The types of search grounding to enable.
+         */
+        search_types?: Array<'web_search' | 'image_search' | 'enterprise_web_search'>;
+    }
+    /**
+     * A tool that can be used by the model to fetch URL context.
+     */
+    interface URLContext {
+        type: 'url_context';
+    }
+    /**
+     * A MCPServer is a server that can be called by the model to perform actions.
+     */
+    interface MCPServer {
+        type: 'mcp_server';
+        /**
+         * The allowed tools.
+         */
+        allowed_tools?: Array<InteractionsAPI.AllowedTools>;
+        /**
+         * Optional: Fields for authentication headers, timeouts, etc., if needed.
+         */
+        headers?: {
+            [key: string]: string;
+        };
+        /**
+         * The name of the MCPServer.
+         */
+        name?: string;
+        /**
+         * The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp"
+         */
+        url?: string;
+    }
+}
+
+declare interface AgentDeleteParams {
+    /**
+     * Which version of the API to use.
+     */
+    api_version?: string;
+}
+
+/**
+ * A generic empty message that you can re-use to avoid defining duplicated empty
+ * messages in your APIs. A typical example is to use it as the request or the
+ * response type of an API method. For instance:
+ *
+ *     service Foo {
+ *       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ *     }
+ */
+declare interface AgentDeleteResponse {
+}
+
+declare interface AgentGetParams {
+    /**
+     * Which version of the API to use.
+     */
+    api_version?: string;
+}
+
+declare interface AgentListParams {
+    /**
+     * Path param: Which version of the API to use.
+     */
+    api_version?: string;
+    /**
+     * Query param
+     */
+    pageSize?: number;
+    /**
+     * Query param
+     */
+    pageToken?: string;
+    /**
+     * Query param
+     */
+    parent?: string;
+}
+
+declare interface AgentListResponse {
+    agents?: Array<Agent>;
+    nextPageToken?: string;
+}
+
+export declare class Agents extends BaseAgents {
+}
+
+export declare namespace Agents {
+    export { type Agent as Agent, type AgentListResponse as AgentListResponse, type AgentDeleteResponse as AgentDeleteResponse, type AgentCreateParams as AgentCreateParams, type AgentListParams as AgentListParams, type AgentDeleteParams as AgentDeleteParams, type AgentGetParams as AgentGetParams, };
+}
+
 /** Aggregation metric. This enum is not supported in Gemini API. */
 export declare enum AggregationMetric {
     /**
@@ -671,6 +890,26 @@ export declare interface AvatarConfig {
 declare class BadRequestError extends APIError<400, Headers> {
 }
 
+declare class BaseAgents extends APIResource {
+    static readonly _key: readonly ['agents'];
+    /**
+     * Creates a new Agent (Typed version for SDK).
+     */
+    create(params?: AgentCreateParams | null | undefined, options?: RequestOptions): APIPromise<Agent>;
+    /**
+     * Lists all Agents.
+     */
+    list(params?: AgentListParams | null | undefined, options?: RequestOptions): APIPromise<AgentListResponse>;
+    /**
+     * Deletes an Agent.
+     */
+    delete(id: string, params?: AgentDeleteParams | null | undefined, options?: RequestOptions): APIPromise<AgentDeleteResponse>;
+    /**
+     * Gets a specific Agent.
+     */
+    get(id: string, params?: AgentGetParams | null | undefined, options?: RequestOptions): APIPromise<Agent>;
+}
+
 declare interface BaseCreateAgentInteractionParams {
     /**
      * Path param: Which version of the API to use.
@@ -692,6 +931,12 @@ declare interface BaseCreateAgentInteractionParams {
      * Body param: Input only. Whether to run the model interaction in the background.
      */
     background?: boolean;
+    /**
+     * Body param: The environment configuration for the interaction. Can be an object
+     * specifying remote environment sources or a string referencing an existing
+     * environment ID.
+     */
+    environment?: string | Environment_2;
     /**
      * Body param: The ID of the previous interaction, if any.
      */
@@ -702,8 +947,8 @@ declare interface BaseCreateAgentInteractionParams {
      */
     response_format?: Array<AudioResponseFormat | TextResponseFormat | ImageResponseFormat | unknown> | AudioResponseFormat | TextResponseFormat | ImageResponseFormat | unknown;
     /**
-     * Body param: The mime type of the response. This is required if response_format
-     * is set.
+     * @deprecated Body param: The mime type of the response. This is required if
+     * response_format is set.
      */
     response_mime_type?: string;
     /**
@@ -755,6 +1000,12 @@ declare interface BaseCreateModelInteractionParams {
      * Body param: Input only. Whether to run the model interaction in the background.
      */
     background?: boolean;
+    /**
+     * Body param: The environment configuration for the interaction. Can be an object
+     * specifying remote environment sources or a string referencing an existing
+     * environment ID.
+     */
+    environment?: string | Environment_2;
     /**
      * Body param: Input only. Configuration parameters for the model interaction.
      */
@@ -769,8 +1020,8 @@ declare interface BaseCreateModelInteractionParams {
      */
     response_format?: Array<AudioResponseFormat | TextResponseFormat | ImageResponseFormat | unknown> | AudioResponseFormat | TextResponseFormat | ImageResponseFormat | unknown;
     /**
-     * Body param: The mime type of the response. This is required if response_format
-     * is set.
+     * @deprecated Body param: The mime type of the response. This is required if
+     * response_format is set.
      */
     response_mime_type?: string;
     /**
@@ -3264,6 +3515,77 @@ export declare enum Environment {
     ENVIRONMENT_BROWSER = "ENVIRONMENT_BROWSER"
 }
 
+/**
+ * Configuration for a custom environment.
+ */
+declare interface Environment_2 {
+    type: 'remote';
+    /**
+     * Network configuration for the environment.
+     */
+    network?: 'disabled' | Environment_2.Allowlist;
+    sources?: Array<Environment_2.Source>;
+}
+
+declare namespace Environment_2 {
+    /**
+     * Outbound networking configuration for the sandbox. When specified, restricts
+     * which external domains the sandbox can reach. Omit entirely to allow all
+     * outbound traffic with no header injection.
+     */
+    interface Allowlist {
+        /**
+         * List of allowed outbound domains. Only requests to listed domains are permitted.
+         * Use [{'domain': '*'}] to allow all domains while still injecting headers on
+         * specific ones.
+         */
+        allowlist?: Array<Allowlist.Allowlist>;
+    }
+    namespace Allowlist {
+        /**
+         * A single domain allowlist rule with optional header injection.
+         */
+        interface Allowlist {
+            /**
+             * Domain to allow outbound requests to. Supports wildcards (e.g.
+             * '_.googleapis.com'). Use '_' to allow all domains.
+             */
+            domain: string;
+            /**
+             * Headers to inject on all outbound requests matching this domain. Each entry is a
+             * flat {header_name: header_value} object. The egress proxy injects these
+             * automatically.
+             */
+            transform?: Array<{
+                [key: string]: string;
+            }>;
+        }
+    }
+    /**
+     * A source to be mounted into the environment.
+     */
+    interface Source {
+        /**
+         * The inline content if `type` is `INLINE`.
+         */
+        content?: string;
+        /**
+         * Optional encoding for inline content (e.g. `base64`).
+         */
+        encoding?: string;
+        /**
+         * The source of the environment. For GCS, this is the GCS path. For GitHub, this
+         * is the GitHub path.
+         */
+        source?: string;
+        /**
+         * Where the source should appear in the environment.
+         */
+        target?: string;
+        type?: 'gcs' | 'inline' | 'repository' | 'skill_registry';
+    }
+}
+
 declare interface ErrorEvent_2 {
     event_type: 'error';
     /**
@@ -4848,7 +5170,7 @@ export declare interface GenerationConfig {
  */
 declare interface GenerationConfig_2 {
     /**
-     * Configuration for image interaction.
+     * @deprecated Configuration for image interaction.
      */
     image_config?: ImageConfig_2;
     /**
@@ -5136,10 +5458,12 @@ export declare class GoogleGenAI {
     readonly fileSearchStores: FileSearchStores;
     private _interactions;
     private _webhooks;
+    private _agents;
     private _nextGenClient;
     private getNextGenClient;
     get interactions(): Interactions;
     get webhooks(): Webhooks;
+    get agents(): Agents;
     constructor(options: GoogleGenAIOptions);
 }
 
@@ -6264,6 +6588,16 @@ declare interface Interaction {
      * Configuration parameters for the agent interaction.
      */
     agent_config?: DynamicAgentConfig | DeepResearchAgentConfig;
+    /**
+     * The environment configuration for the interaction. Can be an object specifying
+     * remote environment sources or a string referencing an existing environment ID.
+     */
+    environment?: string | Environment_2;
+    /**
+     * Output only. The environment ID for the interaction. Only populated if
+     * environment config is set in the request.
+     */
+    environment_id?: string;
     /**
      * The input for the interaction.
      */
@@ -6282,7 +6616,8 @@ declare interface Interaction {
      */
     response_format?: Array<AudioResponseFormat | TextResponseFormat | ImageResponseFormat | unknown> | AudioResponseFormat | TextResponseFormat | ImageResponseFormat | unknown;
     /**
-     * The mime type of the response. This is required if response_format is set.
+     * @deprecated The mime type of the response. This is required if response_format
+     * is set.
      */
     response_mime_type?: string;
     /**
@@ -6432,7 +6767,7 @@ export declare class Interactions extends BaseInteractions {
 }
 
 export declare namespace Interactions {
-    export { type AllowedTools as AllowedTools, type Annotation as Annotation, type AudioContent as AudioContent, type AudioResponseFormat as AudioResponseFormat, type CodeExecutionCallArguments as CodeExecutionCallArguments, type CodeExecutionCallStep as CodeExecutionCallStep, type CodeExecutionResultStep as CodeExecutionResultStep, type Content_2 as Content, type DeepResearchAgentConfig as DeepResearchAgentConfig, type DocumentContent as DocumentContent, type DynamicAgentConfig as DynamicAgentConfig, type ErrorEvent_2 as ErrorEvent, type FileCitation as FileCitation, type FileSearchCallStep as FileSearchCallStep, type FileSearchResultStep as FileSearchResultStep, type Function_2 as Function, type FunctionCallStep as FunctionCallStep, type FunctionResultStep as FunctionResultStep, type GenerationConfig_2 as GenerationConfig, type GoogleMapsCallArguments as GoogleMapsCallArguments, type GoogleMapsCallStep as GoogleMapsCallStep, type GoogleMapsResult as GoogleMapsResult, type GoogleMapsResultStep as GoogleMapsResultStep, type GoogleSearchCallArguments as GoogleSearchCallArguments, type GoogleSearchCallStep as GoogleSearchCallStep, type GoogleSearchResult as GoogleSearchResult, type GoogleSearchResultStep as GoogleSearchResultStep, type ImageConfig_2 as ImageConfig, type ImageContent as ImageContent, type ImageResponseFormat as ImageResponseFormat, type Interaction as Interaction, type InteractionCompletedEvent as InteractionCompletedEvent, type InteractionCreatedEvent as InteractionCreatedEvent, type InteractionSSEEvent as InteractionSSEEvent, type InteractionStatusUpdate as InteractionStatusUpdate, type MCPServerToolCallStep as MCPServerToolCallStep, type MCPServerToolResultStep as MCPServerToolResultStep, type Model_2 as Model, type ModelOutputStep as ModelOutputStep, type PlaceCitation as PlaceCitation, type SpeechConfig_2 as SpeechConfig, type Step as Step, type StepDelta as StepDelta, type StepStart as StepStart, type StepStop as StepStop, type TextContent as TextContent, type TextResponseFormat as TextResponseFormat, type ThinkingLevel_2 as ThinkingLevel, type ThoughtStep as ThoughtStep, type Tool_2 as Tool, type ToolChoiceConfig as ToolChoiceConfig, type ToolChoiceType as ToolChoiceType, type URLCitation as URLCitation, type URLContextCallArguments as URLContextCallArguments, type URLContextCallStep as URLContextCallStep, type URLContextResult as URLContextResult, type URLContextResultStep as URLContextResultStep, type Usage as Usage, type UserInputStep as UserInputStep, type VideoContent as VideoContent, type WebhookConfig_2 as WebhookConfig, type InteractionDeleteResponse as InteractionDeleteResponse, type InteractionCreateParams as InteractionCreateParams, type CreateModelInteractionParamsNonStreaming as CreateModelInteractionParamsNonStreaming, type CreateModelInteractionParamsStreaming as CreateModelInteractionParamsStreaming, type CreateAgentInteractionParamsNonStreaming as CreateAgentInteractionParamsNonStreaming, type CreateAgentInteractionParamsStreaming as CreateAgentInteractionParamsStreaming, type InteractionDeleteParams as InteractionDeleteParams, type InteractionCancelParams as InteractionCancelParams, type InteractionGetParams as InteractionGetParams, type InteractionGetParamsNonStreaming as InteractionGetParamsNonStreaming, type InteractionGetParamsStreaming as InteractionGetParamsStreaming, };
+    export { type AllowedTools as AllowedTools, type Annotation as Annotation, type AudioContent as AudioContent, type AudioResponseFormat as AudioResponseFormat, type CodeExecutionCallArguments as CodeExecutionCallArguments, type CodeExecutionCallStep as CodeExecutionCallStep, type CodeExecutionResultStep as CodeExecutionResultStep, type Content_2 as Content, type DeepResearchAgentConfig as DeepResearchAgentConfig, type DocumentContent as DocumentContent, type DynamicAgentConfig as DynamicAgentConfig, type Environment_2 as Environment, type ErrorEvent_2 as ErrorEvent, type FileCitation as FileCitation, type FileSearchCallStep as FileSearchCallStep, type FileSearchResultStep as FileSearchResultStep, type Function_2 as Function, type FunctionCallStep as FunctionCallStep, type FunctionResultStep as FunctionResultStep, type GenerationConfig_2 as GenerationConfig, type GoogleMapsCallArguments as GoogleMapsCallArguments, type GoogleMapsCallStep as GoogleMapsCallStep, type GoogleMapsResult as GoogleMapsResult, type GoogleMapsResultStep as GoogleMapsResultStep, type GoogleSearchCallArguments as GoogleSearchCallArguments, type GoogleSearchCallStep as GoogleSearchCallStep, type GoogleSearchResult as GoogleSearchResult, type GoogleSearchResultStep as GoogleSearchResultStep, type ImageConfig_2 as ImageConfig, type ImageContent as ImageContent, type ImageResponseFormat as ImageResponseFormat, type Interaction as Interaction, type InteractionCompletedEvent as InteractionCompletedEvent, type InteractionCreatedEvent as InteractionCreatedEvent, type InteractionSSEEvent as InteractionSSEEvent, type InteractionStatusUpdate as InteractionStatusUpdate, type MCPServerToolCallStep as MCPServerToolCallStep, type MCPServerToolResultStep as MCPServerToolResultStep, type Model_2 as Model, type ModelOutputStep as ModelOutputStep, type PlaceCitation as PlaceCitation, type SpeechConfig_2 as SpeechConfig, type Step as Step, type StepDelta as StepDelta, type StepStart as StepStart, type StepStop as StepStop, type TextContent as TextContent, type TextResponseFormat as TextResponseFormat, type ThinkingLevel_2 as ThinkingLevel, type ThoughtStep as ThoughtStep, type Tool_2 as Tool, type ToolChoiceConfig as ToolChoiceConfig, type ToolChoiceType as ToolChoiceType, type URLCitation as URLCitation, type URLContextCallArguments as URLContextCallArguments, type URLContextCallStep as URLContextCallStep, type URLContextResult as URLContextResult, type URLContextResultStep as URLContextResultStep, type Usage as Usage, type UserInputStep as UserInputStep, type VideoContent as VideoContent, type WebhookConfig_2 as WebhookConfig, type InteractionDeleteResponse as InteractionDeleteResponse, type InteractionCreateParams as InteractionCreateParams, type CreateModelInteractionParamsNonStreaming as CreateModelInteractionParamsNonStreaming, type CreateModelInteractionParamsStreaming as CreateModelInteractionParamsStreaming, type CreateAgentInteractionParamsNonStreaming as CreateAgentInteractionParamsNonStreaming, type CreateAgentInteractionParamsStreaming as CreateAgentInteractionParamsStreaming, type InteractionDeleteParams as InteractionDeleteParams, type InteractionCancelParams as InteractionCancelParams, type InteractionGetParams as InteractionGetParams, type InteractionGetParamsNonStreaming as InteractionGetParamsNonStreaming, type InteractionGetParamsStreaming as InteractionGetParamsStreaming, };
 }
 
 declare namespace InteractionsAPI {
@@ -6450,6 +6785,7 @@ declare namespace InteractionsAPI {
         DeepResearchAgentConfig,
         DocumentContent,
         DynamicAgentConfig,
+        Environment_2 as Environment,
         ErrorEvent_2 as ErrorEvent,
         FileCitation,
         FileSearchCallStep,