Skip to content

feat: Add Agent Engine Runtime Versioning support to SDK. #600

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
copybara-service wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Add Agent Engine Runtime Versioning support to SDK. #600

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
154 changes: 23 additions & 131 deletions src/genai/types/common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -721,7 +721,7 @@ export declare interface ReasoningEngineTrafficConfigTrafficSplitManual {
targets?: ReasoningEngineTrafficConfigTrafficSplitManualTarget[];
}

/** Traffic distribution configuration. */
/** Traffic distribution configuration for the Reasoning Engine. */
export declare interface ReasoningEngineTrafficConfig {
/** Optional. Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision. */
trafficSplitAlwaysLatest?: ReasoningEngineTrafficConfigTrafficSplitAlwaysLatest;
Expand Down Expand Up @@ -907,136 +907,6 @@ export class QueryReasoningEngineResponse {
output?: unknown;
}

/** Config for updating agent engine. */
export declare interface UpdateAgentEngineConfig {
/** Used to override HTTP request options. */
httpOptions?: genaiTypes.HttpOptions;
/** Abort signal which can be used to cancel the request.

NOTE: AbortSignal is a client-only operation. Using it to cancel an
operation will not cancel the request in the service. You will still
be charged usage for any applicable operations.
*/
abortSignal?: AbortSignal;
/** The user-defined name of the Agent Engine.

The display name can be up to 128 characters long and can comprise any
UTF-8 characters.
*/
displayName?: string;
/** The description of the Agent Engine. */
description?: string;
/** Optional. Configurations of the Agent Engine. */
spec?: ReasoningEngineSpec;
/** Optional. The context spec to be used for the Agent Engine. */
contextSpec?: ReasoningEngineContextSpec;
/** Optional. The PSC interface config for PSC-I to be used for the
Agent Engine. */
pscInterfaceConfig?: PscInterfaceConfig;
/** The minimum number of instances to run for the Agent Engine.
Defaults to 1. Range: [0, 10].
*/
minInstances?: number;
/** The maximum number of instances to run for the Agent Engine.
Defaults to 100. Range: [1, 1000].
If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100].
*/
maxInstances?: number;
/** The resource limits to be applied to the Agent Engine.
Required keys: 'cpu' and 'memory'.
Supported values for 'cpu': '1', '2', '4', '6', '8'.
Supported values for 'memory': '1Gi', '2Gi', ..., '32Gi'.
*/
resourceLimits?: Record<string, string>;
/** The container concurrency to be used for the Agent Engine.
Recommended value: 2 * cpu + 1. Defaults to 9.
*/
containerConcurrency?: number;
/** The encryption spec to be used for the Agent Engine. */
encryptionSpec?: genaiTypes.EncryptionSpec;
/** The labels to be used for the Agent Engine. */
labels?: Record<string, string>;
/** The class methods to be used for the Agent Engine.
If specified, they'll override the class methods that are autogenerated by
default. By default, methods are generated by inspecting the agent object
and generating a corresponding method for each method defined on the
agent class.
*/
classMethods?: Record<string, unknown>[];
/** The user-provided paths to the source packages (if any).
If specified, the files in the source packages will be packed into a
a tarball file, uploaded to Agent Engine's API, and deployed to the
Agent Engine.
The following fields will be ignored:
- agent
- extra_packages
- staging_bucket
- requirements
The following fields will be used to install and use the agent from the
source packages:
- entrypoint_module (required)
- entrypoint_object (required)
- requirements_file (optional)
- class_methods (required)
*/
sourcePackages?: string[];
/** Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect. This includes the repository, revision, and directory to use. */
developerConnectSource?: ReasoningEngineSpecSourceCodeSpecDeveloperConnectConfig;
/** The entrypoint module to be used for the Agent Engine
This field only used when source_packages is specified. */
entrypointModule?: string;
/** The entrypoint object to be used for the Agent Engine.
This field only used when source_packages is specified. */
entrypointObject?: string;
/** The user-provided path to the requirements file (if any).
This field is only used when source_packages is specified.
If not specified, agent engine will find and use the `requirements.txt` in
the source package.
*/
requirementsFile?: string;
/** The agent framework to be used for the Agent Engine.
The OSS agent framework used to develop the agent.
Currently supported values: "google-adk", "langchain", "langgraph",
"ag2", "llama-index", "custom".
If not specified:
- If `agent` is specified, the agent framework will be auto-detected.
- If `source_packages` is specified, the agent framework will
default to "custom". */
agentFramework?:
| 'google-adk'
| 'langchain'
| 'langgraph'
| 'ag2'
| 'llama-index'
| 'custom';
/** The Python version to be used for the Agent Engine.
If not specified, it will use the current Python version of the environment.
Supported versions: "3.9", "3.10", "3.11", "3.12", "3.13", "3.14".
*/
pythonVersion?: '3.9' | '3.10' | '3.11' | '3.12' | '3.13' | '3.14';
/** The build options for the Agent Engine.
The following keys are supported:
- installation_scripts:
Optional. The paths to the installation scripts to be
executed in the Docker image.
The scripts must be located in the `installation_scripts`
subdirectory and the path must be added to `extra_packages`.
*/
buildOptions?: Record<string, string[]>;
/** Agent Gateway configuration for a Reasoning Engine deployment. */
agentGatewayConfig?: ReasoningEngineSpecDeploymentSpecAgentGatewayConfig;
/** The update mask to apply. For the `FieldMask` definition, see
https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask. */
updateMask?: string;
}

/** Parameters for updating agent engines. */
export declare interface UpdateAgentEngineRequestParameters {
/** Name of the agent engine. */
name: string;
config?: UpdateAgentEngineConfig;
}

/** The metadata values for memories. */
export declare interface MemoryMetadataValue {
/** Represents a boolean value. */
Expand Down Expand Up @@ -2641,3 +2511,25 @@ export declare interface SchemaPromptSpecAppBuilderData {
/** Linked resources attached to the application by the user. */
linkedResources?: SchemaPromptSpecAppBuilderDataLinkedResource[];
}

/** A runtime revision. */
export declare interface ReasoningEngineRuntimeRevision {
/** Output only. Timestamp when this ReasoningEngineRuntimeRevision was created. */
createTime?: string;
/** Identifier. The resource name of the ReasoningEngineRuntimeRevision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/runtimeRevisions/{runtime_revision}` */
name?: string;
/** Immutable. Configurations of the ReasoningEngineRuntimeRevision. Contains only revision specific fields. */
spec?: ReasoningEngineSpec;
/** Output only. The state of the revision. */
state?: State;
}

/** An agent engine runtime revision instance. */
export declare interface AgentEngineRuntimeRevision {
/** The underlying API client. */
apiClient?: unknown;
/** The underlying API client for asynchronous operations. */
apiAsyncClient?: unknown;
/** The underlying API resource (i.e. ReasoningEngineRuntimeRevision). */
apiResource?: ReasoningEngineRuntimeRevision;
}
Loading