REST Resource: projects.locations.apps.tools

Ressource : Tool

Un outil représente une action que l'agent CES peut effectuer pour atteindre certains objectifs.

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "executionType": enum (ExecutionType),
  "timeout": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "generatedSummary": string,
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },

  // Union field tool_type can be only one of the following:
  "clientFunction": {
    object (ClientFunction)
  },
  "openApiTool": {
    object (OpenApiTool)
  },
  "googleSearchTool": {
    object (GoogleSearchTool)
  },
  "connectorTool": {
    object (ConnectorTool)
  },
  "dataStoreTool": {
    object (DataStoreTool)
  },
  "pythonFunction": {
    object (PythonFunction)
  },
  "mcpTool": {
    object (McpTool)
  },
  "fileSearchTool": {
    object (FileSearchTool)
  },
  "systemTool": {
    object (SystemTool)
  },
  "agentTool": {
    object (AgentTool)
  },
  "widgetTool": {
    object (WidgetTool)
  },
  "remoteAgentTool": {
    object (RemoteAgentTool)
  }
  // End of list of possible types for union field tool_type.
}
Champs
name

string

Identifiant. Nom de ressource de l'outil. Format :

  • projects/{project}/locations/{location}/apps/{app}/tools/{tool} pour les outils autonomes.
  • projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool} pour les outils récupérés à partir d'un ensemble d'outils.

Ces outils sont dynamiques et en sortie uniquement. Ils ne peuvent pas être référencés directement lorsqu'un outil est attendu.
displayName

string

Uniquement en sortie. Nom à afficher de l'outil, dérivé en fonction de son type. Par exemple, le nom à afficher d'une [ClientFunction][Tool.ClientFunction] est dérivé de sa propriété name.
executionType

enum (ExecutionType)

Facultatif. Type d'exécution de l'outil.
timeout

string (Duration format)

Facultatif. Délai d'exécution de l'outil. Si ce paramètre n'est pas défini, le délai d'inactivité par défaut est de 30 secondes pour les outils SYNCHRONOUS et de 60 secondes pour les outils ASYNCHRONOUS.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la création de l'outil.

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 l'outil.

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

string

Etag utilisé pour s'assurer que l'objet n'a pas changé lors d'une opération de lecture/modification/écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.
generatedSummary

string

Uniquement en sortie. Si l'outil est généré par l'assistant LLM, ce champ contient un résumé descriptif de la génération.
toolFakeConfig

object (ToolFakeConfig)

Facultatif. Configuration du comportement de l'outil en mode factice.
Champ d'union tool_type. Type d'outil. tool_type ne peut être qu'un des éléments suivants :
clientFunction

object (ClientFunction)

Facultatif. Fonction client.
openApiTool

object (OpenApiTool)

Facultatif. Outil d'API ouverte.
googleSearchTool

object (GoogleSearchTool)

Facultatif. Outil de recherche Google.
connectorTool

object (ConnectorTool)

Facultatif. L'outil Integration Connectors.
dataStoreTool

object (DataStoreTool)

Facultatif. L'outil datastore.
pythonFunction

object (PythonFunction)

Facultatif. Outil de fonction Python.
mcpTool

object (McpTool)

Facultatif. L'outil MCP Un outil MCP ne peut pas être créé ni mis à jour directement. Il est géré par l'ensemble d'outils MCP.
fileSearchTool

object (FileSearchTool)

Facultatif. Outil de recherche de fichiers.
systemTool

object (SystemTool)

Facultatif. L'outil système.
agentTool

object (AgentTool)

Facultatif. Outil de l'agent.
widgetTool

object (WidgetTool)

Facultatif. L'outil de widget.
remoteAgentTool

object (RemoteAgentTool)

Facultatif. L'outil d'agent distant.

ClientFunction

Représente une fonction côté client que l'agent peut appeler. Lorsque l'agent choisit l'outil, le contrôle est transmis au client. Le client est responsable de l'exécution de la fonction et du renvoi du résultat sous la forme d'un ToolResponse pour poursuivre l'interaction avec l'agent.

Représentation JSON 
{
  "name": string,
  "description": string,
  "parameters": {
    object (Schema)
  },
  "response": {
    object (Schema)
  }
}
Champs
name

string

Obligatoire. Nom de la fonction.
description

string

Facultatif. Description de la fonction.
parameters

object (Schema)

Facultatif. Schéma des paramètres de la fonction.
response

object (Schema)

Facultatif. Schéma de la réponse de la fonction.

OpenApiTool

Outil d'API à distance défini par un schéma OpenAPI.

Représentation JSON 
{
  "openApiSchema": string,
  "name": string,
  "description": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
Champs
openApiSchema

string

Obligatoire. Schéma OpenAPI au format JSON ou YAML.
name

string

Facultatif. Nom de l'outil. S'il n'est pas fourni, le nom de l'outil sera dérivé du schéma OpenAPI, à partir de operation.operationId.
description

string

Facultatif. Description de l'outil. Si aucune description n'est fournie, elle sera dérivée du schéma OpenAPI, de operation.description ou de operation.summary.
apiAuthentication

object (ApiAuthentication)

Facultatif. Informations d'authentification requises par l'API.
tlsConfig

object (TlsConfig)

Facultatif. Configuration TLS. Inclut les certificats de serveur personnalisés auxquels le client fera confiance.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Facultatif. Configuration de l'annuaire des services.
ignoreUnknownFields

boolean

Facultatif. Si la valeur est "true", l'agent ignore les champs inconnus dans la réponse de l'API.
url

string

Facultatif. URL du serveur du schéma Open API. Ce champ n'est défini dans les outils des dépendances d'environnement lors du processus d'exportation que si le schéma contient une URL de serveur. Lors du processus d'importation, si cette URL est présente dans les dépendances de l'environnement et que le schéma comporte l'espace réservé $env_var, elle remplacera l'espace réservé dans le schéma.

GoogleSearchTool

Représente un outil permettant d'effectuer des recherches sur le Web Google pour l'ancrage. Consultez https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search.

Représentation JSON 
{
  "name": string,
  "description": string,
  "contextUrls": [
    string
  ],
  "preferredDomains": [
    string
  ],
  "excludeDomains": [
    string
  ],
  "promptConfig": {
    object (GoogleSearchTool.PromptConfig)
  }
}
Champs
name

string

Obligatoire. Nom de l'outil.
description

string

Facultatif. Description de l'objectif de l'outil.
contextUrls[]

string

Facultatif. Le contenu sera extrait directement de ces URL pour le contexte et l'ancrage. Exemple : "https://example.com/path.html". Vous ne pouvez pas inclure plus de 20 URL.
preferredDomains[]

string

Facultatif. Spécifie les domaines auxquels limiter les résultats de recherche. Exemple : "example.com", "another.site". Vous pouvez spécifier jusqu'à 20 domaines.
excludeDomains[]

string

Facultatif. Liste des domaines à exclure des résultats de recherche. Exemple : "example.com". Vous ne pouvez pas exclure plus de 2 000 domaines.
promptConfig

object (GoogleSearchTool.PromptConfig)

Facultatif. Instructions d'invite transmises au planificateur sur la façon dont les résultats de recherche doivent être traités pour le texte et la voix.

GoogleSearchTool.PromptConfig

Paramètres d'invite utilisés par le modèle lors du traitement ou de la synthèse des résultats de recherche Google.

Représentation JSON 
{
  "textPrompt": string,
  "voicePrompt": string
}
Champs
textPrompt

string

Facultatif. Définit la requête utilisée pour les instructions système lors des interactions avec l'agent dans les conversations par chat. Si aucune valeur n'est spécifiée, une requête par défaut sera utilisée.
voicePrompt

string

Facultatif. Définit la requête utilisée pour les instructions système lors de l'interaction avec l'agent dans les conversations vocales. Si aucune valeur n'est spécifiée, une requête par défaut sera utilisée.

ConnectorTool

Un ConnectorTool permet de se connecter à différentes intégrations. Consultez https://cloud.google.com/integration-connectors/docs/overview.

Représentation JSON 
{
  "connection": string,
  "action": {
    object (Action)
  },
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "name": string,
  "description": string
}
Champs
connection

string

Obligatoire. Nom complet de la ressource de la connexion Integration Connectors référencée. Format : projects/{project}/locations/{location}/connections/{connection}
action

object (Action)

Obligatoire. Action à utiliser pour l'outil.
authConfig

object (EndUserAuthConfig)

Facultatif. Configure la façon dont l'authentification est gérée dans Integration Connectors. Par défaut, une authentification d'administrateur est transmise dans les requêtes de l'API Integration Connectors. Vous pouvez la remplacer par une autre configuration d'authentification de l'utilisateur final. Remarque : La substitution de l'authentification doit être activée pour la connexion afin de pouvoir spécifier une configuration EUC ici. Sinon, la création de ConnectorTool échouera. Pour en savoir plus, consultez https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override.
name

string

Facultatif. Nom de l'outil que l'agent peut utiliser pour décider d'appeler ou non ConnectorTool.
description

string

Facultatif. Description de l'outil que l'agent peut utiliser pour déterminer s'il doit appeler ConnectorTool.

DataStoreTool

Outil permettant de récupérer des données à partir d'un data store ou d'un moteur Vertex AI Search pour l'ancrage. Accepte un data store ou un moteur, mais pas les deux. Consultez Vertex AI Search : https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

Représentation JSON 
{
  "name": string,
  "description": string,
  "boostSpecs": [
    {
      object (DataStoreTool.BoostSpecs)
    }
  ],
  "modalityConfigs": [
    {
      object (DataStoreTool.ModalityConfig)
    }
  ],
  "filterParameterBehavior": enum (DataStoreTool.FilterParameterBehavior),

  // Union field search_source can be only one of the following:
  "dataStoreSource": {
    object (DataStoreTool.DataStoreSource)
  },
  "engineSource": {
    object (DataStoreTool.EngineSource)
  }
  // End of list of possible types for union field search_source.
}
Champs
name

string

Obligatoire. Nom de l'outil data store.
description

string

Facultatif. Description de l'outil.
boostSpecs[]

object (DataStoreTool.BoostSpecs)

Facultatif. Booster les spécifications pour mettre en avant certains documents.
modalityConfigs[]

object (DataStoreTool.ModalityConfig)

Facultatif. Configurations de modalités pour le data store.
filterParameterBehavior

enum (DataStoreTool.FilterParameterBehavior)

Facultatif. Comportement du paramètre de filtre.
Champ d'union search_source. Définit la source de recherche, qui peut être un seul DataStore ou un seul moteur. search_source ne peut être qu'un des éléments suivants :
dataStoreSource

object (DataStoreTool.DataStoreSource)

Facultatif. Recherchez dans un seul DataStore spécifique.
engineSource

object (DataStoreTool.EngineSource)

Facultatif. Rechercher dans un moteur (potentiellement dans plusieurs DataStores).

DataStoreTool.DataStoreSource

Configuration pour la recherche dans un DataStore spécifique.

Représentation JSON 
{
  "filter": string,
  "dataStore": {
    object (DataStore)
  }
}
Champs
filter

string

Facultatif. Spécification du filtre pour DataStore. Consultez https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata.
dataStore

object (DataStore)

Facultatif. Datastore.

DataStore

Ressource DataStore dans Vertex AI Search.

Représentation JSON 
{
  "name": string,
  "type": enum (DataStore.DataStoreType),
  "documentProcessingMode": enum (DataStore.DocumentProcessingMode),
  "displayName": string,
  "createTime": string,
  "connectorConfig": {
    object (DataStore.ConnectorConfig)
  }
}
Champs
name

string

Obligatoire. Nom complet de la ressource DataStore. Format : projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
type

enum (DataStore.DataStoreType)

Uniquement en sortie. Type du data store. Ce champ est en lecture seule et est renseigné par le serveur.
documentProcessingMode

enum (DataStore.DocumentProcessingMode)

Uniquement en sortie. Mode de traitement des documents pour la connexion au data store. Défini uniquement pour les data stores PUBLIC_WEB et UNSTRUCTURED.
displayName

string

Uniquement en sortie. Nom à afficher du data store.
createTime

string (Timestamp format)

Uniquement en sortie. Horodatage de la création du data store.

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

object (DataStore.ConnectorConfig)

Uniquement en sortie. Configuration du connecteur pour la connexion au data store.

DataStore.DataStoreType

Type du data store.

Enums
DATA_STORE_TYPE_UNSPECIFIED Non spécifié. Cette valeur indique que le type de data store n'est pas spécifié. Il ne sera donc pas utilisé lors de la recherche.
PUBLIC_WEB Un data store contenant du contenu Web public.
UNSTRUCTURED Un data store contenant des données privées non structurées.
FAQ Un data store contenant des données structurées utilisées comme questions fréquentes.
CONNECTOR Datastore qui sert de connecteur à un service first party ou tiers.

DataStore.DocumentProcessingMode

Mode de traitement des documents du data store.

Enums
DOCUMENT_PROCESSING_MODE_UNSPECIFIED Non spécifié.
DOCUMENTS Les documents sont traités en tant que documents.
CHUNKS Les documents sont convertis en blocs.

DataStore.ConnectorConfig

Configuration du connecteur pour la connexion au data store.

Représentation JSON 
{
  "collection": string,
  "collectionDisplayName": string,
  "dataSource": string
}
Champs
collection

string

Nom de ressource de la collection à laquelle appartient le data store.
collectionDisplayName

string

Nom à afficher de la collection à laquelle appartient le data store.
dataSource

string

Nom de la source de données. Exemple : salesforce, jira, confluence, bigquery.

DataStoreTool.EngineSource

Configuration pour la recherche dans un moteur, ciblant potentiellement des DataStores spécifiques.

Représentation JSON 
{
  "engine": string,
  "dataStoreSources": [
    {
      object (DataStoreTool.DataStoreSource)
    }
  ],
  "filter": string
}
Champs
engine

string

Obligatoire. Nom complet de la ressource du moteur. Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
dataStoreSources[]

object (DataStoreTool.DataStoreSource)

Facultatif. Utilisez-le pour cibler des DataStores spécifiques dans le moteur. Si elle est vide, la recherche s'applique à tous les DataStores associés au moteur.
filter

string

Facultatif. Filtre appliqué à la recherche dans le moteur. Non pertinent et non utilisé si "dataStoreSources" est fourni. Consultez https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata.

DataStoreTool.BoostSpecs

Booster les spécifications pour mettre en avant certains documents. Pour en savoir plus, consultez https://cloud.google.com/generative-ai-app-builder/docs/boosting.

Représentation JSON 
{
  "dataStores": [
    string
  ],
  "spec": [
    {
      object (DataStoreTool.BoostSpec)
    }
  ]
}
Champs
dataStores[]

string

Obligatoire. Data Store auquel la configuration du boosting est appliquée. Nom complet de la ressource DataStore, par exemple projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
spec[]

object (DataStoreTool.BoostSpec)

Obligatoire. Liste des spécifications de boosting.

DataStoreTool.BoostSpec

Booster les spécifications pour mettre en avant certains documents.

Représentation JSON 
{
  "conditionBoostSpecs": [
    {
      object (DataStoreTool.BoostSpec.ConditionBoostSpec)
    }
  ]
}
Champs
conditionBoostSpecs[]

object (DataStoreTool.BoostSpec.ConditionBoostSpec)

Obligatoire. Liste des spécifications de boosting.

DataStoreTool.BoostSpec.ConditionBoostSpec

Spécification de boost pour une condition.

Représentation JSON 
{
  "condition": string,
  "boost": number,
  "boostControlSpec": {
    object (DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec)
  }
}
Champs
condition

string

Obligatoire. Expression qui spécifie une condition d'optimisation. La syntaxe est la même que celle des expressions de filtre. Pour le moment, la seule condition acceptée est une liste de codes de langue BCP-47. Exemple : Pour améliorer les suggestions dans les langues "en" ou "fr" : (lang_code: ANY("en", "fr"))
boost

number

Facultatif. Intensité du boost, qui doit être comprise entre -1 et 1. Un boosting négatif correspond à une rétrogradation. La valeur par défaut est 0.0.

Définir l'intensité sur 1.0 permet de promouvoir fortement les suggestions. Toutefois, cela ne signifie pas nécessairement que le premier résultat sera une suggestion boostée.

Si vous définissez la valeur sur -1,0, les suggestions sont fortement rétrogradées. Toutefois, d'autres suggestions pertinentes peuvent toujours s'afficher.

Si vous définissez la valeur sur 0,0, aucune amélioration n'est appliquée. La condition de boost est ignorée.
boostControlSpec

object (DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec)

Facultatif. Spécification complexe pour le classement personnalisé basé sur la valeur d'un attribut défini par le client.

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec

Spécification du classement personnalisé basé sur la valeur de l'attribut spécifié par le client. Elle offre plus de contrôles pour le classement personnalisé que la simple combinaison (condition, boost) ci-dessus.

Représentation JSON 
{
  "fieldName": string,
  "attributeType": enum (DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType),
  "interpolationType": enum (DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType),
  "controlPoints": [
    {
      object (DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint)
    }
  ]
}
Champs
fieldName

string

Facultatif. Nom du champ dont la valeur sera utilisée pour déterminer le montant du boost.
attributeType

enum (DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType)

Facultatif. Type d'attribut à utiliser pour déterminer le montant de l'augmentation. La valeur de l'attribut peut être dérivée de la valeur du champ fieldName spécifié. Dans le cas d'une valeur numérique, c'est simple : attributeValue = numerical_field_value. Dans le cas de la fraîcheur, attributeValue = (time.now() - datetime_field_value).
interpolationType

enum (DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType)

Facultatif. Type d'interpolation à appliquer pour connecter les points de contrôle listés ci-dessous.
controlPoints[]

object (DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint)

Facultatif. Points de contrôle utilisés pour définir la courbe. La fonction monotone (définie par interpolationType ci-dessus) passe par les points de contrôle listés ici.

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType

Attribut(ou fonction) auquel le classement personnalisé doit être appliqué.

Enums
ATTRIBUTE_TYPE_UNSPECIFIED Type d'attribut non spécifié.
NUMERICAL La valeur du champ numérique sera utilisée pour mettre à jour dynamiquement le montant du boost. Dans ce cas, la valeur d'attribut (valeur x) du point de contrôle correspondra à la valeur réelle du champ numérique pour lequel le boostAmount est spécifié.
FRESHNESS Dans le cas d'utilisation de la fraîcheur, la valeur de l'attribut correspond à la durée entre l'heure actuelle et la date spécifiée dans le champ "datetime". La valeur doit être au format XSD dayTimeDuration (sous-ensemble restreint d'une valeur de durée ISO 8601). Le format est le suivant : [nD][T[nH][nM][nS]]. Par exemple, 5D, 3DT12H30M ou T24H.

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType

Type d'interpolation à appliquer. La valeur par défaut est "linéaire" (linéaire par morceaux).

Enums
INTERPOLATION_TYPE_UNSPECIFIED Le type d'interpolation n'est pas spécifié. Dans ce cas, la valeur par défaut est "Linéaire".
LINEAR Une interpolation linéaire par morceaux sera appliquée.

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint

Points de contrôle utilisés pour définir la courbe. La courbe définie par ces points de contrôle ne peut qu'augmenter ou diminuer de manière monotone(les valeurs constantes sont acceptables).

Représentation JSON 
{
  "attributeValue": string,
  "boostAmount": number
}
Champs
attributeValue

string

Facultatif. Peut être l'une des valeurs suivantes : 1. Valeur numérique du champ. 2. Spécification de la durée de fraîcheur : la valeur doit être mise en forme en tant que valeur dayTimeDuration XSD (sous-ensemble restreint d'une valeur de durée ISO 8601). Le format est le suivant : [nD][T[nH][nM][nS]].
boostAmount

number

Facultatif. Valeur comprise entre -1 et 1 permettant d'augmenter le score si la valeur de l'attribut correspond à la valeur spécifiée ci-dessus.

DataStoreTool.ModalityConfig

Si spécifié, applique la configuration donnée pour la modalité spécifiée.

Représentation JSON 
{
  "modalityType": enum (DataStoreTool.ModalityConfig.ModalityType),
  "rewriterConfig": {
    object (DataStoreTool.RewriterConfig)
  },
  "summarizationConfig": {
    object (DataStoreTool.SummarizationConfig)
  },
  "groundingConfig": {
    object (DataStoreTool.GroundingConfig)
  }
}
Champs
modalityType

enum (DataStoreTool.ModalityConfig.ModalityType)

Obligatoire. Type de modalité.
rewriterConfig

object (DataStoreTool.RewriterConfig)

Facultatif. Configuration du réécriveur.
summarizationConfig

object (DataStoreTool.SummarizationConfig)

Facultatif. Configuration de la synthèse.
groundingConfig

object (DataStoreTool.GroundingConfig)

Facultatif. Configuration de l'ancrage.

DataStoreTool.ModalityConfig.ModalityType

Type de modalité.

Enums
MODALITY_TYPE_UNSPECIFIED Type de modalité non spécifié.
TEXT Modalité de texte.
AUDIO Modalité audio.

DataStoreTool.RewriterConfig

Configuration de la fonctionnalité de réécriture.

Représentation JSON 
{
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "disabled": boolean
}
Champs
modelSettings

object (ModelSettings)

Obligatoire. Configurations du modèle LLM.
prompt

string

Facultatif. Définition de la requête. Si aucune valeur n'est spécifiée, une requête par défaut sera utilisée.
disabled

boolean

Facultatif. Indique si le réécrivain est désactivé.

DataStoreTool.SummarizationConfig

Configuration de la synthèse.

Représentation JSON 
{
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "disabled": boolean
}
Champs
modelSettings

object (ModelSettings)

Facultatif. Configurations du modèle LLM.
prompt

string

Facultatif. Définition de la requête. Si aucune valeur n'est spécifiée, une requête par défaut sera utilisée.
disabled

boolean

Facultatif. Indique si la synthèse est désactivée.

DataStoreTool.GroundingConfig

Configuration de l'ancrage.

Représentation JSON 
{
  "groundingLevel": number,
  "disabled": boolean
}
Champs
groundingLevel

number

Facultatif. Seuil d'ancrage de la réponse en fonction des sources récupérées. La valeur a une plage configurable de [1, 5]. Le niveau est utilisé pour définir le seuil de l'ancrage de la réponse. Cela signifie que toutes les réponses dont le score d'ancrage est inférieur au seuil ne renverront que des extraits pertinents.

Par exemple, un niveau de 3 signifie que le score d'ancrage doit être supérieur ou égal à 3 pour que la réponse soit renvoyée.
disabled

boolean

Facultatif. Indique si l'ancrage est désactivé.

DataStoreTool.FilterParameterBehavior

Comportement des paramètres de filtre.

Enums
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED Comportement par défaut des filtres. Incluez le paramètre de filtre pour les data stores de connecteur. Pour les autres types de magasins de données, le paramètre d'entrée du filtre est omis.
ALWAYS_INCLUDE Incluez toujours le paramètre de filtre pour tous les types de data stores.
NEVER_INCLUDE Le paramètre de filtre n'est jamais inclus dans la liste des paramètres d'outil, quel que soit le type de data store.

PythonFunction

Un outil de fonction Python.

Représentation JSON 
{
  "name": string,
  "pythonCode": string,
  "description": string,
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  }
}
Champs
name

string

Facultatif. Nom de la fonction Python à exécuter. Doit correspondre à un nom de fonction Python défini dans le code Python. Sensible à la casse. Si aucun nom n'est fourni, la première fonction définie dans le code Python sera utilisée.
pythonCode

string

Facultatif. Code Python à exécuter pour l'outil.
description

string

Uniquement en sortie. Description de la fonction Python, analysée à partir de la docstring du code Python.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Facultatif. Configuration de l'annuaire des services pour l'outil.

McpTool

Outil MCP. Pour en savoir plus, consultez https://modelcontextprotocol.io/specification/2025-06-18/server/tools.

Représentation JSON 
{
  "name": string,
  "nameOverride": string,
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  },
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "state": enum (McpTool.State)
}
Champs
name

string

Obligatoire. Nom de l'outil MCP.
nameOverride

string

Facultatif. Nom de remplacement de l'outil MCP. Ce champ est renseigné si le nom a été remplacé par un remplacement Toolset.
description

string

Facultatif. Description de l'outil MCP.
inputSchema

object (Schema)

Facultatif. Schéma des arguments d'entrée de l'outil MCP.
outputSchema

object (Schema)

Facultatif. Schéma des arguments de sortie de l'outil MCP.
serverAddress

string

Obligatoire. Adresse du serveur MCP, par exemple "https://example.com/mcp/". Si le serveur est créé avec le SDK MCP, l'URL doit être suffixée par "/mcp/". Seuls les serveurs basés sur le transport HTTP Streamable sont acceptés. Cette valeur est identique à serverAddress dans McpToolset. Pour en savoir plus, consultez https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.
apiAuthentication

object (ApiAuthentication)

Facultatif. Informations d'authentification requises pour exécuter l'outil sur le serveur MCP. Pour l'authentification par jeton du porteur, le jeton ne s'applique qu'à l'exécution de l'outil, et non à la liste des outils. Cela nécessite que les outils puissent être listés sans authentification.
tlsConfig

object (TlsConfig)

Facultatif. Configuration TLS. Inclut les certificats de serveur personnalisés auxquels le client doit faire confiance.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Facultatif. Configuration Annuaire des services pour VPC-SC, utilisée pour résoudre les noms de service dans un périmètre.
customHeaders

map (key: string, value: string)

Facultatif. En-têtes personnalisés à envoyer dans la requête au serveur MCP. Les valeurs doivent être au format $context.variables.<name_of_variable> et peuvent être définies dans les variables de session. Pour en savoir plus, consultez https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
state

enum (McpTool.State)

Uniquement en sortie. État de disponibilité dynamique de l'outil sur le serveur externe.

McpTool.State

Représente l'état de disponibilité dynamique de l'outil.

Enums
STATE_UNSPECIFIED État par défaut.
ACTIVE L'outil est disponible et proposé activement par le serveur.
INACTIVE L'outil est configuré ou épinglé, mais n'est actuellement pas proposé par le serveur.
STALE L'outil existe sur le serveur, mais ne correspond pas à la version du serveur.

FileSearchTool

L'outil de recherche de fichiers permet à l'agent de rechercher des fichiers importés par le développeur de l'application ou de l'agent. Il dispose de préréglages pour fournir une recherche de qualité relativement bonne sur les fichiers importés et un résumé des résultats obtenus.

Représentation JSON 
{
  "corpusType": enum (FileSearchTool.CorpusType),
  "name": string,
  "description": string,
  "fileCorpus": string
}
Champs
corpusType

enum (FileSearchTool.CorpusType)

Facultatif. Type de corpus. La valeur par défaut est FULLY_MANAGED.
name

string

Obligatoire. Nom de l'outil.
description

string

Facultatif. Description de l'outil.
fileCorpus

string

Facultatif. Corpus dans lequel les fichiers sont stockés. Format : projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

FileSearchTool.CorpusType

Type du corpus RAG Vertex.

Enums
CORPUS_TYPE_UNSPECIFIED Type de corpus non spécifié.
USER_OWNED Le corpus est créé par l'utilisateur et lui appartient.
FULLY_MANAGED Le corpus est créé par l'agent.

SystemTool

Outil système prédéfini.

Représentation JSON 
{
  "name": string,
  "description": string
}
Champs
name

string

Obligatoire. Nom de l'outil système.
description

string

Uniquement en sortie. Description de l'outil système.

AgentTool

Représente un outil qui permet à l'agent d'appeler un autre agent.

Représentation JSON 
{
  "name": string,
  "description": string,
  "rootAgent": string,
  "agent": string
}
Champs
name

string

Obligatoire. Nom de l'outil de l'agent.
description

string

Facultatif. Description de l'objectif de l'outil.
rootAgent
(deprecated)

string

Facultatif. Obsolète : utilisez plutôt agent. Nom de ressource de l'agent racine qui est le point d'entrée de l'outil. Format : projects/{project}/locations/{location}/agents/{agent}
agent

string

Facultatif. Nom de ressource de l'agent qui constitue le point d'entrée de l'outil. Format : projects/{project}/locations/{location}/agents/{agent}

WidgetTool

Représente un outil de widget que l'agent peut appeler. Lorsque l'agent choisit l'outil, il renvoie le widget au client. Le client est responsable du traitement du widget et de la génération de la prochaine requête utilisateur pour poursuivre l'interaction avec l'agent.

Représentation JSON 
{
  "name": string,
  "description": string,
  "widgetType": enum (WidgetTool.WidgetType),
  "uiConfig": {
    object
  },
  "dataMapping": {
    object (WidgetTool.DataMapping)
  },
  "textResponseConfig": {
    object (WidgetTool.TextResponseConfig)
  },

  // Union field input can be only one of the following:
  "parameters": {
    object (Schema)
  }
  // End of list of possible types for union field input.
}
Champs
name

string

Obligatoire. Nom à afficher de l'outil de widget.
description

string

Facultatif. Description de l'outil de widget.
widgetType

enum (WidgetTool.WidgetType)

Facultatif. Type de l'outil de widget. Si aucun type n'est spécifié, le type par défaut est "CUSTOMIZED" (PERSONNALISÉ).
uiConfig

object (Struct format)

Facultatif. Configuration pour l'affichage du widget.
dataMapping

object (WidgetTool.DataMapping)

Facultatif. Mappage qui définit la façon dont les données d'un outil source sont mappées aux paramètres d'entrée du widget.
textResponseConfig

object (WidgetTool.TextResponseConfig)

Facultatif. Configuration des réponses textuelles toujours incluses.
Champ d'union input. Entrée de l'outil de widget. input ne peut être qu'un des éléments suivants :
parameters

object (Schema)

Facultatif. Paramètres d'entrée de l'outil de widget.

WidgetTool.WidgetType

Tous les types de widgets disponibles. De nouvelles valeurs pourront être ajoutées à cette énumération à l'avenir.

Enums
WIDGET_TYPE_UNSPECIFIED Type de widget non spécifié.
CUSTOM Type de widget personnalisé.
PRODUCT_DETAILS Widget d'informations détaillées sur le produit.
QUICK_ACTIONS Widget Actions rapides.
PRODUCT_COMPARISON Widget de comparaison de produits.
ADVANCED_PRODUCT_DETAILS Widget d'informations détaillées complémentaires sur le produit.
SHORT_FORM Widget de formulaire court.
OVERALL_SATISFACTION Widget de satisfaction globale.
ORDER_SUMMARY Widget de récapitulatif de la commande.
APPOINTMENT_DETAILS Widget "Détails du rendez-vous".
APPOINTMENT_SCHEDULER Widget de planification des rendez-vous.
CONTACT_FORM Widget de formulaire de contact.

WidgetTool.DataMapping

Configuration permettant de mapper les données d'un outil source aux paramètres d'entrée du widget.

Représentation JSON 
{
  "sourceToolName": string,
  "fieldMappings": {
    string: string,
    ...
  },
  "pythonFunction": {
    object (PythonFunction)
  },
  "mode": enum (WidgetTool.DataMapping.Mode),
  "pythonScript": string
}
Champs
sourceToolName

string

Facultatif. Nom de ressource de l'outil qui fournit les données du widget (par exemple, un outil de recherche ou une fonction personnalisée). Format : projects/{project}/locations/{location}/agents/{agent}/tools/{tool}
fieldMappings

map (key: string, value: string)

Facultatif. Mappage des champs de paramètres d'entrée du widget avec les champs de sortie correspondants de l'outil source.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
pythonFunction

object (PythonFunction)

Facultatif. Configuration d'une fonction Python utilisée pour transformer la sortie de l'outil source au format d'entrée du widget.
mode

enum (WidgetTool.DataMapping.Mode)

Facultatif. Mode du mappage de données.
pythonScript
(deprecated)

string

Obsolète : utilisez plutôt pythonFunction.

WidgetTool.DataMapping.Mode

Stratégie utilisée pour mapper les données de l'outil source au widget.

Enums
MODE_UNSPECIFIED Mode non spécifié.
FIELD_MAPPING Utilisez la carte fieldMappings pour transformer les données.
PYTHON_SCRIPT Utilisez pythonScript pour transformer les données.

WidgetTool.TextResponseConfig

Configuration de la réponse textuelle renvoyée avec le widget.

Représentation JSON 
{
  "type": enum (WidgetTool.TextResponseConfig.Type),
  "staticText": string,
  "textResponseInstruction": string
}
Champs
type

enum (WidgetTool.TextResponseConfig.Type)

Facultatif. Stratégie pour fournir la réponse textuelle.
staticText

string

Facultatif. Réponse texte statique à renvoyer lorsque le type est STATIC.
textResponseInstruction

string

Facultatif. Instruction pour le LLM sur la façon de générer la réponse textuelle. Utilisé comme description du paramètre de réponse textuelle si le type est LLM_GENERATED.

WidgetTool.TextResponseConfig.Type

Définit la manière dont la réponse textuelle est produite.

Enums
TYPE_UNSPECIFIED Type non spécifié.
NONE Le LLM décide de manière dynamique s'il doit générer une réponse textuelle en plus du widget en fonction du contexte de la conversation.
LLM_GENERATED Le LLM est explicitement tenu de générer une réponse textuelle.
STATIC Une réponse texte statique prédéfinie est toujours utilisée.

RemoteAgentTool

Représente un outil qui permet à l'agent d'appeler un autre agent distant.

Représentation JSON 
{
  "name": string,
  "description": string,
  "agentCard": {
    object (AgentCard)
  }
}
Champs
name

string

Obligatoire. Nom de l'outil.
description

string

Obligatoire. Description de l'outil.
agentCard

object (AgentCard)

Obligatoire. Fiche de l'agent distant que cet outil appelle.

AgentCard

AgentCard transmet des informations clés sur un agent à distance. Il s'agit d'une version réduite de l'AgentCard définie dans le protocole A2A https://a2a-protocol.org/dev/specification/#441-agentcard.

Représentation JSON 
{
  "name": string,
  "description": string,
  "supportedInterfaces": [
    {
      object (AgentInterface)
    }
  ],
  "version": string,
  "skills": [
    {
      object (AgentSkill)
    }
  ]
}
Champs
name

string

Obligatoire. Nom d'agent lisible par l'humain.
description

string

Obligatoire. Description du domaine d'action/de l'espace de solution de l'agent.
supportedInterfaces[]

object (AgentInterface)

Obligatoire. Liste ordonnée des interfaces compatibles. La première entrée est privilégiée.
version

string

Obligatoire. Version de l'agent.
skills[]

object (AgentSkill)

Obligatoire. Les compétences représentent une capacité qu'un agent peut effectuer. Cela peut sembler un peu abstrait, mais cela représente un ensemble d'actions plus ciblées que l'agent est très susceptible de réussir.

AgentInterface

Déclare une combinaison d'URL cible, de transport et de version de protocole pour interagir avec l'agent. Cela permet aux agents d'exposer la même fonctionnalité sur plusieurs mécanismes de liaison de protocole.

Représentation JSON 
{
  "url": string,
  "protocolBinding": string,
  "tenant": string,
  "protocolVersion": string
}
Champs
url

string

Obligatoire. URL où cette interface est disponible. Doit être une URL HTTPS absolue valide en production. Exemple : "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
protocolBinding

string

Obligatoire. L'association de protocole acceptée à cette URL. Il s'agit d'une chaîne de formulaire ouverte, qui peut être facilement étendue à d'autres liaisons de protocole. Les principaux officiellement acceptés sont JSONRPC, GRPC et HTTP+JSON.
tenant

string

ID de locataire à utiliser dans la requête lors de l'appel de l'agent.
protocolVersion

string

Obligatoire. Version du protocole A2A que cette interface expose. Utilisez la dernière version mineure compatible pour chaque version majeure. Exemples : "0.3", "1.0"

AgentSkill

Représente une capacité ou une fonction distincte qu'un agent peut effectuer.

Représentation JSON 
{
  "id": string,
  "name": string,
  "description": string,
  "tags": [
    string
  ],
  "examples": [
    string
  ],
  "inputModes": [
    string
  ],
  "outputModes": [
    string
  ]
}
Champs
id

string

Obligatoire. Identifiant unique de la compétence de l'agent.
name

string

Obligatoire. Nom lisible de la compétence.
description

string

Obligatoire. Description détaillée de la compétence.
tags[]

string

Obligatoire. Ensemble de mots clés décrivant les capacités de la skill.
examples[]

string

Exemples de requêtes ou de scénarios que cette compétence peut traiter.
inputModes[]

string

Ensemble des types de supports d'entrée acceptés pour cette compétence, qui remplacent les valeurs par défaut de l'agent.
outputModes[]

string

Ensemble des types de supports de sortie acceptés pour cette compétence, qui remplacent les valeurs par défaut de l'agent.

Méthodes

create

 Crée un outil dans l'application donnée.

delete

 Supprime l'outil spécifié.

get

 Accède aux détails de l'outil spécifié.

list

 Liste les outils de l'application spécifiée.

patch

 Met à jour l'outil spécifié.