Skip to content

Commit 719f65c

Browse files
vertex-sdk-botcopybara-github
authored andcommitted
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
1 parent 365a14a commit 719f65c

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

src/genai/types/common.ts

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ export declare interface ReasoningEngineSpecDeploymentSpecAgentGatewayConfig {
276276

277277
/** Specifies the HTTP GET configuration for the probe. */
278278
export declare interface KeepAliveProbeHttpGet {
279-
/** Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`). */
279+
/** Required. Specifies the path of the HTTP GET request (e.g., "/is_busy"). */
280280
path?: string;
281281
/** Optional. Specifies the port number on the container to which the request is sent. */
282282
port?: number;
@@ -715,6 +715,10 @@ export declare interface CreateAgentEngineConfig {
715715
buildOptions?: Record<string, string[]>;
716716
/** Agent Gateway configuration for a Reasoning Engine deployment. */
717717
agentGatewayConfig?: ReasoningEngineSpecDeploymentSpecAgentGatewayConfig;
718+
/** Optional. Specifies the configuration for keep-alive probe.
719+
Contains configuration on a specified endpoint that a deployment host
720+
should use to keep the container alive based on the probe settings. */
721+
keepAliveProbe?: KeepAliveProbe;
718722
}
719723

720724
/** Parameters for creating agent engines. */
@@ -1043,6 +1047,10 @@ export declare interface UpdateAgentEngineConfig {
10431047
buildOptions?: Record<string, string[]>;
10441048
/** Agent Gateway configuration for a Reasoning Engine deployment. */
10451049
agentGatewayConfig?: ReasoningEngineSpecDeploymentSpecAgentGatewayConfig;
1050+
/** Optional. Specifies the configuration for keep-alive probe.
1051+
Contains configuration on a specified endpoint that a deployment host
1052+
should use to keep the container alive based on the probe settings. */
1053+
keepAliveProbe?: KeepAliveProbe;
10461054
/** The update mask to apply. For the `FieldMask` definition, see
10471055
https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask. */
10481056
updateMask?: string;
@@ -2610,6 +2618,10 @@ export declare interface AgentEngineConfig {
26102618
containerSpec?: ReasoningEngineSpecContainerSpec;
26112619
/** Agent Gateway configuration for a Reasoning Engine deployment. */
26122620
agentGatewayConfig?: ReasoningEngineSpecDeploymentSpecAgentGatewayConfig;
2621+
/** Optional. Specifies the configuration for keep-alive probe.
2622+
Contains configuration on a specified endpoint that a deployment host
2623+
should use to keep the container alive based on the probe settings. */
2624+
keepAliveProbe?: KeepAliveProbe;
26132625
}
26142626

26152627
/** Config for checking a query job on an agent engine. */

0 commit comments

Comments
 (0)