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

Recurso: Agente

Realiza una tarea específica predefinida.

Representación JSON 
{
  "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.
}
Campos
name

string

Es el identificador. Es el nombre del recurso del agente. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent} o projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/agents/{agent}
displayName

string

Obligatorio. Es el nombre visible del agente. Un LLM podría usar esta descripción para seleccionar automáticamente un agente que responda a una consulta del usuario.
description

string

Obligatorio. Es una descripción del agente legible por humanos. Un LLM podría usar esta descripción para seleccionar automáticamente un agente que responda a una consulta del usuario.
icon

object (Image)

Opcional. Ícono que representa al agente en la IU.
createTime

string (Timestamp format)

Solo salida. Es la marca de tiempo de la creación de este agente.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo salida. Es la marca de tiempo de la actualización más reciente de este agente.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
authorizations[]
(deprecated)

string

Opcional. Obsoleto: Usa Agent.authorization_config en su lugar. Es la lista de autorizaciones requeridas para este agente.
authorizationConfig

object (AuthorizationConfig)

Opcional. Son las autorizaciones que requiere el agente.
dataStoreSpecs

object (DataStoreSpecs)

Opcional. Son los DataStoreSpecs asociados con el agente. Si no se configura este campo, se usarán todos los almacenes de datos del motor.
state

enum (State)

Solo salida. Es el estado del ciclo de vida del agente.
toolSettings
(deprecated)

object (AgentToolSettings)

Opcional. OBSOLETO: Se planeó la migración a la definición de AgentCard.
languageCode

string

Opcional. Es el código del idioma del texto en los campos description, displayName y starterPrompts.
starterPrompts[]

object (StarterPrompt)

Opcional. Son las sugerencias de instrucciones iniciales que se muestran al usuario en la página de destino del agente.
customPlaceholderText

string

Opcional. Es el texto de marcador de posición personalizado que aparece en el cuadro de texto antes de que el usuario ingrese texto.
Campo de unión definition. Es la definición del agente. LINT.IfChange(definition) definition puede ser solo una de las siguientes opciones:
adkAgentDefinition

object (AdkAgentDefinition)

Opcional. El comportamiento del agente se define como un agente de ADK.
managedAgentDefinition

object (ManagedAgentDefinition)

Opcional. Es el comportamiento del agente administrado por Google.
a2aAgentDefinition

object (A2AAgentDefinition)

Opcional. El comportamiento del agente se define como un agente de A2A.
dialogflowAgentDefinition

object (DialogflowAgentDefinition)

Opcional. El comportamiento del agente se define como un agente de Dialogflow.
Campo de unión agent_state_reason. Es el motivo por el que el agente se encuentra en su estado actual. agent_state_reason puede ser solo uno de los siguientes:
suspensionReason

string

Solo salida. Es el motivo por el que se suspendió al agente. Solo se establece si el estado es SUSPENDED.
rejectionReason

string

Solo salida. Es el motivo por el que se rechazó al agente. Solo se establece si el estado es PRIVATE y se llegó a él por rechazo.
deploymentFailureReason

string

Solo salida. Es el motivo por el que falló la implementación del agente. Solo se establece si el estado es DEPLOYMENT_FAILED.

Métodos

create

 Crea un Agent.

delete

 Borra un Agent.

deploy

 Implementa un Agent.

disableAgent

 Inhabilita un agente.

enableAgent

 Habilita un agente.

get

 Obtiene un Agent.

getAgentView

 Devuelve un AgentView para un Agent determinado, que contiene información adicional sobre el agente.

getIamPolicy

 Obtiene la política de control de acceso para un recurso de agente.

list

 Enumera todos los objetos Agent en un objeto Assistant que creó el llamador.

patch

 Actualiza un Agent

rejectAgent

 Rechaza un agente ofrecido al público.

requestAgentReview

 Presenta un agente a los administradores, ya que lo pone a disposición para su revisión.

setIamPolicy

 Establece la política de control de acceso para un recurso de agente.

suspendAgent

 Suspende un agente.

withdrawAgent

 Retira un agente ofrecido al público.