Class Environment (2.24.0)

Environment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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 <>__.


name str
Output only. The unique identifier of this agent environment. Supported formats: - projects/ - projects/ The environment ID for the default environment is -.
description str
Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
agent_version str
Optional. The agent version loaded into this environment. Supported formats: - projects/ - projects/
Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
Optional. Text to speech settings for this environment.
Optional. The fulfillment settings to use for this environment.




Represents an environment state. When an environment is pointed to a new agent version, the environment is temporarily set to the LOADING state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the RUNNING state.

Values: STATE_UNSPECIFIED (0): Not specified. This value is not used. STOPPED (1): Stopped. LOADING (2): Loading. RUNNING (3): Running.