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

Identificador. Nombre de 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. Nombre visible del agente. Un LLM puede usarlo para seleccionar automáticamente un agente que responda a la consulta de un usuario.
description

string

Obligatorio. Descripción del agente legible por humanos. Un LLM puede usarlo para seleccionar automáticamente un agente que responda a la consulta de un usuario.
icon

object (Image)

Opcional. El icono que representa al agente en la interfaz de usuario.
createTime

string (Timestamp format)

Solo de salida. Marca de tiempo de creación de este agente.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "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. Marca de tiempo de la última actualización de este agente.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "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. Lista de autorizaciones necesarias para este agente.
authorizationConfig

object (AuthorizationConfig)

Opcional. Las autorizaciones que requiere el agente.
dataStoreSpecs

object (DataStoreSpecs)

Opcional. DataStoreSpecs asociado al agente. Si no se define este campo, se usarán todos los almacenes de datos del motor.
state

enum (State)

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

object (AgentToolSettings)

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

string

Opcional. El código del idioma del texto de los campos description, displayName y starterPrompts.
starterPrompts[]

object (StarterPrompt)

Opcional. Las sugerencias de peticiones iniciales que se muestran al usuario en la página de destino del agente.
customPlaceholderText

string

Opcional. Texto genérico personalizado que aparece en el cuadro de texto antes de que el usuario introduzca texto.
Campo de unión definition. La definición del agente. LINT.IfChange(definition) definition solo puede ser una de estas dos opciones:
adkAgentDefinition

object (AdkAgentDefinition)

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

object (ManagedAgentDefinition)

Opcional. El comportamiento del agente gestionado por Google.
a2aAgentDefinition

object (A2AAgentDefinition)

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

object (DialogflowAgentDefinition)

Opcional. El comportamiento del agente se define como agente de Dialogflow.
Campo de unión agent_state_reason. El motivo por el que el agente se encuentra en su estado actual. agent_state_reason solo puede ser una de estas dos opciones:
suspensionReason

string

Solo de salida. El motivo por el que se ha suspendido al agente. Solo se define si el estado es SUSPENDED.
rejectionReason

string

Solo de salida. El motivo por el que se ha rechazado al agente. Solo se define si el estado es PRIVATE y se ha llegado a él mediante un rechazo.
deploymentFailureReason

string

Solo de salida. El motivo por el que no se ha podido implementar el agente. Solo se define si el estado es DEPLOYMENT_FAILED.

Métodos

create

 Crea un Agent.

delete

 Elimina un Agent.

deploy

 Despliega un Agent.

disableAgent

 Inhabilita un agente.

enableAgent

 Habilita un agente.

get

 Obtiene un Agent.

getAgentView

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

getIamPolicy

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

list

 Muestra todos los Agents de un Assistant que haya creado el llamante.

patch

 Actualiza un Agent.

rejectAgent

 Rechaza un agente ofrecido al público.

requestAgentReview

 Presenta un agente a los administradores poniéndolo a su disposición para que lo revisen.

setIamPolicy

 Define la política de control de acceso de un recurso de agente.

suspendAgent

 Suspende un agente.

withdrawAgent

 Retira un agente ofrecido al público.