feat: add support for keep alive probe in agent engines

Keep alive probe allows reasoning engine users to configure a probe that a deployment host can use to keep the container alive, based on the probe settings. If the keep alive endpoint returns a 2xx status, the deployment host will make a best effort (up to 1 hour) to keep the container alive.

Reasoning engine users with custom container specs (BYOC) have the option to configure a custom keep alive probe while the users without custom container specs (BYOC) have the option to configure an empty keep alive probe {} and the reasoning engine platform will handle the configuration and logic for keep alive probe.

To opt in, users should set the keep alive probe field when creating or updating reasoning engines.

PiperOrigin-RevId: 889254469

Author: vertex-sdk-bot

src/genai/types/common.ts

@@ -240,6 +240,22 @@ export declare interface SecretEnvVar {
   secretRef?: SecretRef;
 }
 
+/** Specifies the HTTP GET configuration for the probe. */
+export declare interface KeepAliveProbeHttpGet {
+  /** Required. Specifies the path of the HTTP GET request (e.g., "/is_busy"). */
+  path?: string;
+  /** Optional. Specifies the port number on the container to which the request is sent. */
+  port?: number;
+}
+
+/** Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. */
+export declare interface KeepAliveProbe {
+  /** Optional. Specifies the HTTP GET configuration for the probe. */
+  httpGet?: KeepAliveProbeHttpGet;
+  /** Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour). */
+  maxSeconds?: number;
+}
+
 /** The specification of a Reasoning Engine deployment. */
 export declare interface ReasoningEngineSpecDeploymentSpec {
   /** The agent server mode. */
@@ -258,6 +274,8 @@ export declare interface ReasoningEngineSpecDeploymentSpec {
   resourceLimits?: Record<string, string>;
   /** Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent. */
   secretEnv?: SecretEnvVar[];
+  /** Optional. Specifies the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. */
+  keepAliveProbe?: KeepAliveProbe;
 }
 
 /** User-provided package specification, containing pickled object and package requirements. */
@@ -611,6 +629,10 @@ export declare interface CreateAgentEngineConfig {
           subdirectory and the path must be added to `extra_packages`.
        */
   buildOptions?: Record<string, string[]>;
+  /** Optional. Specifies the configuration for keep-alive probe.
+      Contains configuration on a specified endpoint that a deployment host
+      should use to keep the container alive based on the probe settings. */
+  keepAliveProbe?: KeepAliveProbe;
 }
 
 /** Parameters for creating agent engines. */
@@ -910,6 +932,10 @@ export declare interface UpdateAgentEngineConfig {
           subdirectory and the path must be added to `extra_packages`.
        */
   buildOptions?: Record<string, string[]>;
+  /** Optional. Specifies the configuration for keep-alive probe.
+      Contains configuration on a specified endpoint that a deployment host
+      should use to keep the container alive based on the probe settings. */
+  keepAliveProbe?: KeepAliveProbe;
   /** The update mask to apply. For the `FieldMask` definition, see
       https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask. */
   updateMask?: string;
@@ -2341,6 +2367,10 @@ export declare interface AgentEngineConfig {
   agentConfigSource?: ReasoningEngineSpecSourceCodeSpecAgentConfigSource;
   /** The container spec for the Agent Engine. */
   containerSpec?: ReasoningEngineSpecContainerSpec;
+  /** Optional. Specifies the configuration for keep-alive probe.
+      Contains configuration on a specified endpoint that a deployment host
+      should use to keep the container alive based on the probe settings. */
+  keepAliveProbe?: KeepAliveProbe;
 }
 
 /** Config for checking a query job on an agent engine. */