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,
  "authorizationConfig": {
    object (AuthorizationConfig)
  },
  "dataStoreSpecs": {
    object (DataStoreSpecs)
  },
  "state": enum (State),
  "languageCode": string,
  "starterPrompts": [
    {
      object (StarterPrompt)
    }
  ],
  "customPlaceholderText": string,

  // Union field definition can be only one of the following:
  "adkAgentDefinition": {
    object (AdkAgentDefinition)
  },
  "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}
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 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".
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 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".
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.
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.
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.

AdkAgentDefinition

Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine).

JSON representation 
{
  "provisionedReasoningEngine": {
    object (ProvisionedReasoningEngine)
  }
}
Fields
provisionedReasoningEngine

object (ProvisionedReasoningEngine)

Optional. The reasoning engine that the agent is connected to.

ProvisionedReasoningEngine

Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine.

JSON representation 
{
  "reasoningEngine": string
}
Fields
reasoningEngine

string

Required. The reasoning engine that the agent is connected to. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}

A2AAgentDefinition

Stored definition of an agent that uses A2A.

JSON representation 
{

  // Union field agent_card can be only one of the following:
  "jsonAgentCard": string
  // End of list of possible types for union field agent_card.
}
Fields
Union field agent_card. Stores agent's name, capabilities, auth info, etc. agent_card can be only one of the following:
jsonAgentCard

string

Optional. The agent card is a JSON string.

DialogflowAgentDefinition

Stored definition of an agent that uses a Dialogflow agent.

JSON representation 
{
  "dialogflowAgent": string
}
Fields
dialogflowAgent

string

Required. Resource name of the underlying Dialogflow Agent. Format: projects/{project}/locations/{location}/agents/{agent}

Image

Represents an image.

JSON representation 
{

  // Union field storage_method can be only one of the following:
  "uri": string,
  "content": string
  // End of list of possible types for union field storage_method.
}
Fields
Union field storage_method. Can be either a URI or the content encoded as a base64 string. storage_method can be only one of the following:
uri

string

Image URI.
content

string

Base64-encoded image file contents.

AuthorizationConfig

Describes the authorizations required.

JSON representation 
{
  "toolAuthorizations": [
    string
  ],
  "agentAuthorization": string
}
Fields
toolAuthorizations[]

string

Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
agentAuthorization

string

Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.

DataStoreSpecs

Represents a set of data store specs.

JSON representation 
{
  "specs": [
    {
      object (DataStoreSpec)
    }
  ]
}
Fields
specs[]

object (DataStoreSpec)

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

State

Possible values for the lifecycle state of the agent.

Enums
STATE_UNSPECIFIED The state is unspecified.
CONFIGURED The agent is configured, but no deployment triggered yet.
DEPLOYING The agent is being deployed.
DISABLED The agent is available for admins only.
DEPLOYMENT_FAILED The agent deployment failed.
PRIVATE Agent is available only to its creator..
ENABLED Agent is available for users who have access.
SUSPENDED Agent is temporarily unavailable, though visible to users who have access.

StarterPrompt

The starter prompt suggestion to show the user on the landing page of the agent.

JSON representation 
{
  "text": string
}
Fields
text

string

Required. The text of the starter prompt.

Methods

create

 Creates an Agent.

delete

 Deletes an Agent.

get

 Gets an Agent.

list

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

patch

 Updates an Agent