REST Resource: projects.agent.versions

Stay organized with collections Save and categorize content based on your preferences.

Resource: Version

You can create multiple versions of your agent and publish them to separate environments.

When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent.

When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for:

  • testing
  • development
  • production
  • etc.

For more information, see the versions and environments guide.

JSON representation
{
  "name": string,
  "description": string,
  "versionNumber": integer,
  "createTime": string,
  "status": enum (VersionStatus)
}
Fields
name

string

Output only. The unique identifier of this agent version. Supported formats:

  • projects/<Project ID>/agent/versions/<Version ID>
  • projects/<Project ID>/locations/<Location ID>/agent/versions/<Version ID>
description

string

Optional. The developer-provided description of this version.

versionNumber

integer

Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.

createTime

string (Timestamp format)

Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

status

enum (VersionStatus)

Output only. The status of this version. This field is read-only and cannot be set by create and update methods.

VersionStatus

The status of a version.

Enums
VERSION_STATUS_UNSPECIFIED Not specified. This value is not used.
IN_PROGRESS Version is not ready to serve (e.g. training is in progress).
READY Version is ready to serve.
FAILED Version training failed.

Methods

create

Creates an agent version.

delete

Delete the specified agent version.

get

Retrieves the specified agent version.

list

Returns the list of all versions of the specified agent.

patch

Updates the specified agent version.