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,
  "dataStoreSpecs": {
    object (DataStoreSpecs)
  },

  // Union field definition can be only one of the following:
  "adkAgentDefinition": {
    object (AdkAgentDefinition)
  }
  // End of list of possible types for union field definition.
}
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.
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 and to generate the first version of the steps for the agent that can be modified by the user.
icon

object (Image)

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".
dataStoreSpecs

object (DataStoreSpecs)

Optional. DataStoreSpecs associated with the agent. Not setting this field will result in using all data stores in the engine.
Union field definition. The definition of the agent. definition can be only one of the following:
adkAgentDefinition

object (AdkAgentDefinition)

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

AdkAgentDefinition

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

JSON representation 
{
  "toolSettings": {
    object (AgentToolSettings)
  },
  "provisionedReasoningEngine": {
    object (ProvisionedReasoningEngine)
  },
  "authorizations": [
    string
  ]
}
Fields
toolSettings

object (AgentToolSettings)

Required. The parameters that define how the agent is presented to the planner LLM.
provisionedReasoningEngine

object (ProvisionedReasoningEngine)

Optional. The reasoning engine that the agent is connected to.
authorizations[]

string

Optional. Resource names of the required authorizations. If the user is not authorized, the service will return a number of authorization URIs that the user must open in a browser and authorize. Once all authorizations are granted, the user can retry the query, and the authorizations will be forwarded to the agent.

Format: projects/{project}/locations/{location}/authorizations/{authorization}

AgentToolSettings

Settings for the tool that represents the agent to the Agentspace planner LLM.

JSON representation 
{
  "toolDescription": string,
  "inputParameterName": string,
  "inputParameterDescription": string
}
Fields
toolDescription

string

Required. This might be used by an LLM to describe when the agent should be used.
inputParameterName

string

Optional. Parameter name for the function call. This parameter name will hint the LLM what type of content the parameter is expected to contain, e.g. a "question", a "command", a "searchQuery", etc.
inputParameterDescription

string

Optional. Parameter description for the function call. This description will give the LLM more information about the parameter, e.g. what kind of content is expected to be passed in and what actions should be performed on it.

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}

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.

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.

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