REST Resource: projects.locations.collections.engines.assistants.agents

Resource: Agent

Performs a predefined, specific task.

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "icon": {
    object (Image)
  },
  "createTime": string,
  "updateTime": string,
  "authorizations": [
    string
  ],
  "authorizationConfig": {
    object (AuthorizationConfig)
  },
  "dataStoreSpecs": {
    object (DataStoreSpecs)
  },
  "state": enum (State),
  "toolSettings": {
    object (AgentToolSettings)
  },
  "languageCode": string,
  "starterPrompts": [
    {
      object (StarterPrompt)
    }
  ],
  "customPlaceholderText": string,

  // Union field definition can be only one of the following:
  "adkAgentDefinition": {
    object (AdkAgentDefinition)
  },
  "managedAgentDefinition": {
    object (ManagedAgentDefinition)
  },
  "a2aAgentDefinition": {
    object (A2AAgentDefinition)
  },
  "dialogflowAgentDefinition": {
    object (DialogflowAgentDefinition)
  }
  // End of list of possible types for union field definition.

  // Union field agent_state_reason can be only one of the following:
  "suspensionReason": string,
  "rejectionReason": string,
  "deploymentFailureReason": string
  // End of list of possible types for union field agent_state_reason.
}
Fields
name

string

Identifier. Resource name of the agent. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent} or projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/agents/{agent}
displayName

string

Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
description

string

Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
icon

object (Image)

Optional. The icon that represents the agent on the UI.
createTime

string (Timestamp format)

Output only. timestamp when this Agent was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 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".
updateTime

string (Timestamp format)

Output only. timestamp when this Agent was most recently updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 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".
authorizations[]
(deprecated)

string

Optional. Deprecated: Use Agent.authorization_config instead. List of required authorizations for this agent.
authorizationConfig

object (AuthorizationConfig)

Optional. The authorizations that are required by the agent.
dataStoreSpecs

object (DataStoreSpecs)

Optional. DataStoreSpecs associated with the agent. Not setting this field will result in using all data stores in the engine.
state

enum (State)

Output only. The lifecycle state of the agent.
toolSettings
(deprecated)

object (AgentToolSettings)

Optional. DEPRECATED: Planned migration to AgentCard definition.
languageCode

string

Optional. The code of the language of the text in the description, displayName and starterPrompts fields.
starterPrompts[]

object (StarterPrompt)

Optional. The starter prompt suggestions to show the user on the landing page of the agent.
customPlaceholderText

string

Optional. The custom placeholder text that appears in the text box before the user enters any text.
Union field definition. The definition of the agent. LINT.IfChange(definition) definition can be only one of the following:
adkAgentDefinition

object (AdkAgentDefinition)

Optional. The behavior of the agent is defined as an ADK agent.
managedAgentDefinition

object (ManagedAgentDefinition)

Optional. The behavior of the Google managed agent.
a2aAgentDefinition

object (A2AAgentDefinition)

Optional. The behavior of the agent is defined as an A2A agent.
dialogflowAgentDefinition

object (DialogflowAgentDefinition)

Optional. The behavior of the agent is defined as a Dialogflow agent.
Union field agent_state_reason. The reason why the agent is in its current state. agent_state_reason can be only one of the following:
suspensionReason

string

Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
rejectionReason

string

Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
deploymentFailureReason

string

Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.

Methods

create

 Creates an Agent.

delete

 Deletes an Agent.

deploy

 Deploys an Agent.

disableAgent

 Disables an Agent.

enableAgent

 Enables an Agent.

get

 Gets an Agent.

getAgentView

 Returns a AgentView for a given Agent, which contains additional information about the Agent.

getIamPolicy

 Gets the access control policy for an agent resource.

list

 Lists all Agents under an Assistant which were created by the caller.

patch

 Updates an Agent

rejectAgent

 Rejects an Agent offered to the public.

requestAgentReview

 Presents an Agent to admins by making it available for review.

setIamPolicy

 Sets the access control policy for an agent resource.

suspendAgent

 Suspends an Agent.

withdrawAgent

 Withdraws an Agent offered to the public.