REST Resource: projects.locations.collections.engines.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.

AdkAgentDefinition

Almacena la definición de un agente que usa ADK y se implementa en Agent Engine (antes conocido como Reasoning Engine).

Representación JSON 
{
  "toolSettings": {
    object (AgentToolSettings)
  },
  "provisionedReasoningEngine": {
    object (ProvisionedReasoningEngine)
  },
  "authorizations": [
    string
  ]
}
Campos
toolSettings

object (AgentToolSettings)

Opcional. Los parámetros que definen cómo se presenta el agente al LLM del planificador.
provisionedReasoningEngine

object (ProvisionedReasoningEngine)

Opcional. El motor de razonamiento al que está conectado el agente.
authorizations[]
(deprecated)

string

Opcional. OBSOLETO: usa Agent.authorizations en su lugar. Nombres de recurso de las autorizaciones necesarias. Si el usuario no está autorizado, el servicio devolverá una serie de URIs de autorización que el usuario debe abrir en un navegador y autorizar. Una vez que se hayan concedido todas las autorizaciones, el usuario puede volver a intentar la consulta y las autorizaciones se reenviarán al agente.

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

AgentToolSettings

Ajustes de la herramienta que representa al agente en el LLM de planificación de Agentspace.

Representación JSON 
{
  "toolDescription": string,
  "inputParameterName": string,
  "inputParameterDescription": string
}
Campos
toolDescription

string

Obligatorio. Un LLM puede usarlo para describir cuándo se debe usar el agente.
inputParameterName

string

Opcional. Nombre del parámetro de la llamada a la función. El nombre de este parámetro indicará al LLM qué tipo de contenido se espera que contenga el parámetro (por ejemplo, una "pregunta", un "comando", una "consulta de búsqueda", etc.).
inputParameterDescription

string

Opcional. Descripción del parámetro de la llamada a la función. Esta descripción proporcionará al LLM más información sobre el parámetro, como el tipo de contenido que se espera que se transfiera y las acciones que se deben realizar en él.

ProvisionedReasoningEngine

Registra el motor de razonamiento al que está conectado el agente. Este mensaje no tiene como objetivo hacer un seguimiento del ciclo de vida del agente. En su lugar, solo se usa para definir parámetros para conectarse al agente que ya se ha implementado en un motor de razonamiento.

Representación JSON 
{
  "reasoningEngine": string
}
Campos
reasoningEngine

string

Obligatorio. El motor de razonamiento al que está conectado el agente. Formato: projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}

ManagedAgentDefinition

Almacena la definición de un agente gestionado por Google.

Representación JSON 
{
  "toolSettings": {
    object (AgentToolSettings)
  },
  "authorizations": [
    string
  ],
  "deploymentInfo": {
    object (DeploymentInfo)
  },

  // Union field agent_config can be only one of the following:
  "dataScienceAgentConfig": {
    object (DataScienceAgentConfig)
  }
  // End of list of possible types for union field agent_config.
}
Campos
toolSettings

object (AgentToolSettings)

Opcional. Los parámetros que definen cómo se presenta el agente al LLM del planificador.
authorizations[]
(deprecated)

string

Opcional. OBSOLETO: usa Agent.authorizations en su lugar. Nombres de recurso de las autorizaciones necesarias. Si el usuario no está autorizado, el servicio devolverá una serie de URIs de autorización que el usuario debe abrir en un navegador y autorizar. Una vez que se hayan concedido todas las autorizaciones, el usuario puede volver a intentar la consulta y las autorizaciones se reenviarán al agente.

Formato: projects/{project}/locations/{location}/authorizations/{authorization}
deploymentInfo

object (DeploymentInfo)

Solo de salida. Información de despliegue automático del agente.
Campo de unión agent_config. Configuración específica del tipo de agente. agent_config solo puede ser una de estas dos opciones:
dataScienceAgentConfig

object (DataScienceAgentConfig)

Opcional. Configuración específica de los agentes de ciencia de datos prediseñados de Google. Esta estructura de datos se usa para almacenar la configuración de la hora de implementación y de solicitud del agente.

DataScienceAgentConfig

Configuración específica de los agentes de ciencia de datos prediseñados de Google. Esta estructura de datos se usa para almacenar la configuración de la hora de implementación y de solicitud del agente.

Representación JSON 
{
  "bqProjectId": string,
  "bqDatasetId": string,
  "blocklistTables": [
    string
  ],
  "allowlistTables": [
    string
  ],
  "nlQueryConfig": {
    object (NlQueryConfig)
  }
}
Campos
bqProjectId

string

Obligatorio. El ID del proyecto de BigQuery en el que se encuentra el conjunto de datos.
bqDatasetId

string

Obligatorio. ID del conjunto de datos de BigQuery que se va a usar en el agente. El conjunto de datos debe estar en el proyecto especificado por bqProjectId.
blocklistTables[]

string

Opcional. Las tablas de BigQuery que no debe usar el agente.
allowlistTables[]

string

Opcional. Las tablas de BigQuery que se pueden usar en el agente.
nlQueryConfig

object (NlQueryConfig)

Opcional. Configuración proporcionada por el cliente.

NlQueryConfig

Define las configuraciones proporcionadas por el cliente específicas de la traducción del lenguaje natural al código SQL o Python.

Representación JSON 
{
  "nl2sqlPrompt": string,
  "nl2pyPrompt": string,
  "nl2sqlExamples": [
    {
      object (Nl2SqlExample)
    }
  ],
  "schemaDescription": string,
  "bqSqlGenUseCustomPrompt": boolean
}
Campos
nl2sqlPrompt

string

Opcional. El cliente ha proporcionado instrucciones de lenguaje natural a SQL
nl2pyPrompt

string

Opcional. El cliente ha proporcionado instrucciones a la LLM para que escriba código Python para analizar datos.
nl2sqlExamples[]

object (Nl2SqlExample)

Opcional. El cliente ha proporcionado ejemplos de NL2SQL, tanto de entrada como de SQL esperado.
schemaDescription

string

Opcional. Descripción en lenguaje natural del esquema del conjunto de datos de BigQuery.
bqSqlGenUseCustomPrompt

boolean

Opcional. Indica si se debe usar la petición personalizada para el servicio de generación de SQL de BigQuery.

Nl2SqlExample

Un ejemplo de NL2SQL.

Representación JSON 
{
  "query": string,
  "expectedSql": string,
  "expectedResponse": string
}
Campos
query

string

Opcional. La consulta en lenguaje natural a la que se debe responder.
expectedSql

string

Opcional. La salida de SQL esperada.
expectedResponse

string

Opcional. La respuesta esperada a la consulta.

DeploymentInfo

Información de despliegue automático del agente.

Representación JSON 
{
  "operation": string,
  "finishTime": string
}
Campos
operation

string

Solo de salida. Recurso de operación de larga duración para la implementación. Se puede usar para sondear el estado de la implementación. Cuando finalice la implementación, este campo estará vacío. Si la implementación falla,el campo contendrá el nombre del recurso de la LRO fallida, pero el recurso de operación en sí se eliminará automáticamente al cabo de un tiempo.
finishTime

string (Timestamp format)

Solo de salida. Hora de finalización de la implementación: solo se define si la implementación se ha completado o ha fallado.

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

A2AAgentDefinition

Definición almacenada de un agente que usa A2A.

Representación JSON 
{

  // Union field agent_card can be only one of the following:
  "jsonAgentCard": string,
  "remoteAgentCard": {
    object (RemoteAgentcard)
  }
  // End of list of possible types for union field agent_card.
}
Campos
Campo de unión agent_card. Almacena el nombre, las funciones, la información de autenticación, etc. del agente. agent_card solo puede ser uno de los siguientes valores:
jsonAgentCard

string

Opcional. La tarjeta de agente es una cadena JSON.
remoteAgentCard

object (RemoteAgentcard)

Opcional. Una tarjeta de agente remoto.

RemoteAgentcard

Definición de una tarjeta de agente alojada de forma remota.

Representación JSON 
{
  "uri": string
}
Campos
uri

string

Obligatorio. El URI de la tarjeta del agente.

DialogflowAgentDefinition

Definición almacenada de un agente que usa un agente de Dialogflow.

Representación JSON 
{
  "toolSettings": {
    object (AgentToolSettings)
  },
  "dialogflowAgent": string
}
Campos
toolSettings

object (AgentToolSettings)

Opcional. Los parámetros que definen cómo se presenta el agente al LLM del planificador.
dialogflowAgent

string

Obligatorio. Nombre de recurso del agente de Dialogflow subyacente. Formato: projects/{project}/locations/{location}/agents/{agent}

Imagen

Representa una imagen.

Representación JSON 
{

  // 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.
}
Campos
Campo de unión storage_method. Puede ser un URI o el contenido codificado como una cadena base64. storage_method solo puede ser una de estas dos opciones:
uri

string

URI de la imagen.
content

string

Contenido del archivo de imagen codificado en Base64.

AuthorizationConfig

Describe las autorizaciones necesarias.

Representación JSON 
{
  "toolAuthorizations": [
    string
  ],
  "agentAuthorization": string
}
Campos
toolAuthorizations[]

string

Opcional. Lista de autorizaciones necesarias para que el agente acceda a otros recursos. Los tokens de autorización se transferirán al agente como parte del cuerpo de la solicitud.
agentAuthorization

string

Opcional. La autorización necesaria para invocar al agente. Los tokens de autenticación se transferirán al agente como parte del encabezado de autenticación de la solicitud.

DataStoreSpecs

Representa un conjunto de especificaciones de almacén de datos.

Representación JSON 
{
  "specs": [
    {
      object (DataStoreSpec)
    }
  ]
}
Campos
specs[]

object (DataStoreSpec)

Opcional. Especificaciones que definen los DataStore por los que se va a filtrar en una llamada de búsqueda y las configuraciones de esos almacenes de datos. Esto solo se tiene en cuenta en los Engines con varios almacenes de datos.

Estado

Valores posibles del estado del ciclo de vida del agente.

Enumeraciones
STATE_UNSPECIFIED El estado no está especificado.
CONFIGURED El agente está configurado, pero aún no se ha activado ningún despliegue.
DEPLOYING El agente se está desplegando.
DISABLED El agente solo está disponible para los administradores.
DEPLOYMENT_FAILED No se ha podido desplegar el agente.
PRIVATE El agente solo está disponible para su creador.
ENABLED El agente está disponible para los usuarios que tienen acceso.
SUSPENDED El agente no está disponible temporalmente, aunque los usuarios que tienen acceso pueden verlo.

StarterPrompt

La sugerencia de petición inicial que se muestra al usuario en la página de destino del agente.

Representación JSON 
{
  "text": string
}
Campos
text

string

Obligatorio. El texto de la petición inicial.

Métodos

create

 Crea un Agent.

delete

 Elimina un Agent.

deploy

 Despliega un Agent.

get

 Obtiene un Agent.

getAgentView

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

list

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

patch

 Actualiza un Agent.