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

Ressource : Agent

Effectue une tâche spécifique prédéfinie.

Représentation 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.
}
Champs
name

string

Identifiant. Nom de ressource de l'agent. Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent} ou projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/agents/{agent}
displayName

string

Obligatoire. Nom à afficher de l'agent. Un LLM peut l'utiliser pour sélectionner automatiquement un agent afin de répondre à une requête utilisateur.
description

string

Obligatoire. Description de l'agent lisible par l'humain. Un LLM peut l'utiliser pour sélectionner automatiquement un agent afin de répondre à une requête utilisateur.
icon

object (Image)

Facultatif. Icône représentant l'agent dans l'UI.
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la création de cet agent.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour de cet agent.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
authorizations[]
(deprecated)

string

Facultatif. Obsolète : utilisez plutôt Agent.authorization_config. Liste des autorisations requises pour cet agent.
authorizationConfig

object (AuthorizationConfig)

Facultatif. Autorisations requises par l'agent.
dataStoreSpecs

object (DataStoreSpecs)

Facultatif. DataStoreSpecs associés à l'agent. Si vous ne définissez pas ce champ, tous les data stores du moteur seront utilisés.
state

enum (State)

Uniquement en sortie. État du cycle de vie de l'agent.
toolSettings
(deprecated)

object (AgentToolSettings)

Facultatif. OBSOLÈTE : Migration prévue vers la définition AgentCard.
languageCode

string

Facultatif. Code de la langue du texte dans les champs "description", "displayName" et "starterPrompts".
starterPrompts[]

object (StarterPrompt)

Facultatif. Suggestions de requêtes de démarrage à afficher à l'utilisateur sur la page de destination de l'agent.
customPlaceholderText

string

Facultatif. Texte d'espace réservé personnalisé qui s'affiche dans la zone de texte avant que l'utilisateur ne saisisse du texte.
Champ d'union definition. Définition de l'agent. LINT.IfChange(definition) definition ne peut être que l'un des éléments suivants :
adkAgentDefinition

object (AdkAgentDefinition)

Facultatif. Le comportement de l'agent est défini comme un agent ADK.
managedAgentDefinition

object (ManagedAgentDefinition)

Facultatif. Comportement de l'agent géré par Google.
a2aAgentDefinition

object (A2AAgentDefinition)

Facultatif. Le comportement de l'agent est défini comme un agent A2A.
dialogflowAgentDefinition

object (DialogflowAgentDefinition)

Facultatif. Le comportement de l'agent est défini comme un agent Dialogflow.
Champ d'union agent_state_reason. Raison pour laquelle l'agent est dans son état actuel. agent_state_reason ne peut être qu'un des éléments suivants :
suspensionReason

string

Uniquement en sortie. Raison pour laquelle l'agent a été suspendu. Défini uniquement si l'état est SUSPENDED.
rejectionReason

string

Uniquement en sortie. Raison pour laquelle l'agent a été refusé. Défini uniquement si l'état est "PRIVATE" et qu'il a été atteint après un refus.
deploymentFailureReason

string

Uniquement en sortie. Raison de l'échec du déploiement de l'agent. Défini uniquement si l'état est DEPLOYMENT_FAILED.

AdkAgentDefinition

Stocke la définition d'un agent qui utilise ADK et qui est déployé sur Agent Engine (anciennement appelé Reasoning Engine).

Représentation JSON 
{
  "toolSettings": {
    object (AgentToolSettings)
  },
  "provisionedReasoningEngine": {
    object (ProvisionedReasoningEngine)
  },
  "authorizations": [
    string
  ]
}
Champs
toolSettings

object (AgentToolSettings)

Facultatif. Paramètres qui définissent la façon dont l'agent est présenté au LLM du planificateur.
provisionedReasoningEngine

object (ProvisionedReasoningEngine)

Facultatif. Moteur de raisonnement auquel l'agent est connecté.
authorizations[]
(deprecated)

string

Facultatif. "DEPRECATED" (Obsolète) : utilisez plutôt Agent.authorizations. Noms de ressources des autorisations requises. Si l'utilisateur n'est pas autorisé, le service renvoie un certain nombre d'URI d'autorisation que l'utilisateur doit ouvrir dans un navigateur et autoriser. Une fois toutes les autorisations accordées, l'utilisateur peut réessayer la requête, et les autorisations seront transmises à l'agent.

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

AgentToolSettings

Paramètres de l'outil qui représente l'agent pour le LLM du planificateur Agentspace.

Représentation JSON 
{
  "toolDescription": string,
  "inputParameterName": string,
  "inputParameterDescription": string
}
Champs
toolDescription

string

Obligatoire. Un LLM peut l'utiliser pour décrire quand l'agent doit être utilisé.
inputParameterName

string

Facultatif. Nom de paramètre pour l'appel de fonction. Ce nom de paramètre donnera une indication au LLM sur le type de contenu que le paramètre est censé contenir, par exemple une "question", une "commande", une "requête_de_recherche", etc.
inputParameterDescription

string

Facultatif. Description du paramètre pour l'appel de fonction. Cette description fournira au LLM plus d'informations sur le paramètre, par exemple, le type de contenu attendu et les actions à effectuer sur celui-ci.

ProvisionedReasoningEngine

Permet de suivre le moteur de raisonnement auquel l'agent est connecté. Ce message n'est pas destiné à suivre le cycle de vie de l'agent. Il sert uniquement à définir les paramètres permettant de se connecter à l'agent déjà déployé sur un moteur de raisonnement.

Représentation JSON 
{
  "reasoningEngine": string
}
Champs
reasoningEngine

string

Obligatoire. Moteur de raisonnement auquel l'agent est connecté. Format : projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}

ManagedAgentDefinition

Stocke la définition d'un agent géré par Google.

Représentation 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.
}
Champs
toolSettings

object (AgentToolSettings)

Facultatif. Paramètres qui définissent la façon dont l'agent est présenté au LLM du planificateur.
authorizations[]
(deprecated)

string

Facultatif. "DEPRECATED" (Obsolète) : utilisez plutôt Agent.authorizations. Noms de ressources des autorisations requises. Si l'utilisateur n'est pas autorisé, le service renvoie un certain nombre d'URI d'autorisation que l'utilisateur doit ouvrir dans un navigateur et autoriser. Une fois toutes les autorisations accordées, l'utilisateur peut réessayer la requête, et les autorisations seront transmises à l'agent.

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

object (DeploymentInfo)

Uniquement en sortie. Informations sur le déploiement automatique de l'agent.
Champ d'union agent_config. Configuration spécifique au type d'agent. agent_config ne peut être qu'un des éléments suivants :
dataScienceAgentConfig

object (DataScienceAgentConfig)

Facultatif. Configuration spécifique aux agents de science des données prédéfinis de Google. Cette structure de données est destinée à stocker la configuration du déploiement et du temps de requête pour l'agent.

DataScienceAgentConfig

Configuration spécifique aux agents de science des données prédéfinis de Google. Cette structure de données est destinée à stocker la configuration du déploiement et du temps de requête pour l'agent.

Représentation JSON 
{
  "bqProjectId": string,
  "bqDatasetId": string,
  "blocklistTables": [
    string
  ],
  "allowlistTables": [
    string
  ],
  "nlQueryConfig": {
    object (NlQueryConfig)
  }
}
Champs
bqProjectId

string

Obligatoire. ID du projet BigQuery dans lequel se trouve l'ensemble de données.
bqDatasetId

string

Obligatoire. ID de l'ensemble de données BigQuery à utiliser pour l'agent. L'ensemble de données doit se trouver dans le projet spécifié par bqProjectId.
blocklistTables[]

string

Facultatif. Tables BigQuery dont l'utilisation par l'agent doit être bloquée.
allowlistTables[]

string

Facultatif. Tables BigQuery que l'agent est autorisé à utiliser.
nlQueryConfig

object (NlQueryConfig)

Facultatif. Configuration fournie par le client.

NlQueryConfig

Définissez les configurations fournies par le client spécifiques à la traduction du langage naturel en code SQL/Python.

Représentation JSON 
{
  "nl2sqlPrompt": string,
  "nl2pyPrompt": string,
  "nl2sqlExamples": [
    {
      object (Nl2SqlExample)
    }
  ],
  "schemaDescription": string,
  "bqSqlGenUseCustomPrompt": boolean
}
Champs
nl2sqlPrompt

string

Facultatif. Instructions NL2SQL fournies par le client
nl2pyPrompt

string

Facultatif. Le client a fourni des instructions au LLM pour qu'il écrive du code Python pour l'analyse des données.
nl2sqlExamples[]

object (Nl2SqlExample)

Facultatif. Exemples NL2SQL fournis par le client, y compris l'entrée et le code SQL attendu.
schemaDescription

string

Facultatif. Description en langage naturel du schéma de l'ensemble de données BigQuery.
bqSqlGenUseCustomPrompt

boolean

Facultatif. Indique si vous souhaitez utiliser la requête personnalisée pour le service BigQuery SQL Gen.

Nl2SqlExample

Exemple unique de NL2SQL.

Représentation JSON 
{
  "query": string,
  "expectedSql": string,
  "expectedResponse": string
}
Champs
query

string

Facultatif. Requête en langage naturel à laquelle répondre.
expectedSql

string

Facultatif. Résultat SQL attendu.
expectedResponse

string

Facultatif. Réponse attendue à la requête.

DeploymentInfo

Informations sur le déploiement automatique de l'agent.

Représentation JSON 
{
  "operation": string,
  "finishTime": string
}
Champs
operation

string

Uniquement en sortie. Ressource d'opération de longue durée pour le déploiement. Peut être utilisé pour interroger l'état du déploiement. Ce champ sera vide une fois le déploiement terminé. Si le déploiement échoue,le champ contient le nom de ressource de la LRO ayant échoué, mais la ressource d'opération elle-même est supprimée automatiquement au bout d'un certain temps.
finishTime

string (Timestamp format)

Uniquement en sortie. Heure de fin du déploiement. N'est définie que si le déploiement est terminé ou a échoué.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

A2AAgentDefinition

Définition stockée d'un agent qui utilise A2A.

Représentation 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.
}
Champs
Champ d'union agent_card. Le nom, les capacités, les informations d'authentification, etc. de l'agent Stores agent_card ne peuvent être que l'un des suivants :
jsonAgentCard

string

Facultatif. La carte de l'agent est une chaîne JSON.
remoteAgentCard

object (RemoteAgentcard)

Facultatif. Carte d'un agent distant.

RemoteAgentcard

Définition d'une fiche d'agent hébergée à distance.

Représentation JSON 
{
  "uri": string
}
Champs
uri

string

Obligatoire. URI de la fiche de l'agent.

DialogflowAgentDefinition

Définition stockée d'un agent qui utilise un agent Dialogflow.

Représentation JSON 
{
  "toolSettings": {
    object (AgentToolSettings)
  },
  "dialogflowAgent": string
}
Champs
toolSettings

object (AgentToolSettings)

Facultatif. Paramètres qui définissent la façon dont l'agent est présenté au LLM du planificateur.
dialogflowAgent

string

Obligatoire. Nom de ressource de l'agent Dialogflow sous-jacent. Format : projects/{project}/locations/{location}/agents/{agent}

Image

Représente une image.

Représentation 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.
}
Champs
Champ d'union storage_method. Il peut s'agir d'un URI ou du contenu encodé sous forme de chaîne base64. storage_method ne peut être qu'un des éléments suivants :
uri

string

URI de l'image.
content

string

Contenu du fichier image encodé en base64.

AuthorizationConfig

Décrit les autorisations requises.

Représentation JSON 
{
  "toolAuthorizations": [
    string
  ],
  "agentAuthorization": string
}
Champs
toolAuthorizations[]

string

Facultatif. Liste des autorisations requises pour que l'agent puisse accéder à d'autres ressources. Les jetons d'authentification seront transmis à l'agent dans le corps de la requête.
agentAuthorization

string

Facultatif. Autorisation requise pour appeler l'agent. Les jetons d'authentification seront transmis à l'agent dans l'en-tête d'authentification de la requête.

DataStoreSpecs

Représente un ensemble de spécifications de data store.

Représentation JSON 
{
  "specs": [
    {
      object (DataStoreSpec)
    }
  ]
}
Champs
specs[]

object (DataStoreSpec)

Facultatif. Spécifications définissant les DataStore sur lesquels filtrer un appel de recherche et les configurations de ces magasins de données. Cela n'est pris en compte que pour les Engine comportant plusieurs data stores.

État

Valeurs possibles pour l'état du cycle de vie de l'agent.

Enums
STATE_UNSPECIFIED L'état n'est pas spécifié.
CONFIGURED L'agent est configuré, mais aucun déploiement n'a encore été déclenché.
DEPLOYING L'agent est en cours de déploiement.
DISABLED L'agent n'est disponible que pour les administrateurs.
DEPLOYMENT_FAILED Échec du déploiement de l'agent.
PRIVATE L'agent n'est disponible que pour son créateur.
ENABLED L'agent est disponible pour les utilisateurs qui y ont accès.
SUSPENDED L'agent est temporairement indisponible, mais reste visible pour les utilisateurs qui y ont accès.

StarterPrompt

Suggestion d'invite de démarrage à afficher à l'utilisateur sur la page de destination de l'agent.

Représentation JSON 
{
  "text": string
}
Champs
text

string

Obligatoire. Texte de la requête de démarrage.

Méthodes

create

 Crée un Agent.

delete

 Supprime un Agent.

deploy

 Déploie un Agent.

get

 Récupère un Agent.

getAgentView

 Renvoie un AgentView pour un Agent donné, qui contient des informations supplémentaires sur l'agent.

list

 Liste tous les Agent sous un Assistant qui ont été créés par l'appelant.

patch

 Met à jour un Agent.