Resource: Environment
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 , "agentVersion" : string , "state" : enum ( |
name
string
Output only. The unique identifier of this agent environment. Supported formats:
-
projects/<Project ID>/agent/environments/<Environment ID> -
projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>
The environment ID for the default environment is -
.
description
string
Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
agentVersion
string
Optional. The agent version loaded into this environment. Supported formats:
-
projects/<Project ID>/agent/versions/<Version ID> -
projects/<Project ID>/locations/<Location ID>/agent/versions/<Version ID>
state
enum (
State
)
Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
updateTime
string (
Timestamp
format)
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.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
or "2014-10-02T15:01:23+05:30"
.
textToSpeechSettings
object (
TextToSpeechSettings
)
Optional. Text to speech settings for this environment.
fulfillment
object (
Fulfillment
)
Optional. The fulfillment settings to use for this environment.
Methods |
|
|---|---|
|
Creates an agent environment. |
|
Deletes the specified agent environment. |
|
Retrieves the specified agent environment. |
|
Gets the history of the specified environment. |
|
Returns the list of all non-default environments of the specified agent. |
|
Updates the specified agent environment. |
