MCP Tools Reference: ces.googleapis.com

Outil : create_app_version

Crée une version de l'application dans l'application donnée.

L'exemple de code suivant montre comment utiliser curl pour appeler l'outil MCP create_app_version.

Requête curl
curl --location 'https://ces.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "create_app_version", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }'

Schéma d'entrée

Message de requête pour AgentService.CreateAppVersion

CreateAppVersionRequest

Représentation JSON
{ "parent": string, "appVersionId": string, "appVersion": { object (AppVersion) } }

Champs
parent	string Obligatoire. Nom de ressource de l'application dans laquelle créer une version.
appVersionId	string Facultatif. ID à utiliser pour la version de l'application, qui constituera le composant final du nom de ressource de la version de l'application. Si aucun ID n'est fourni, un ID unique est automatiquement attribué à la version de l'application.
appVersion	object (AppVersion) Obligatoire. Version de l'application à créer.

AppVersion

Représentation JSON
{ "name": string, "displayName": string, "description": string, "creator": string, "createTime": string, "snapshot": { object (AppSnapshot) }, "etag": string }

Champs
name	string Identifiant. Identifiant unique de la version de l'application. Format : projects/{project}/locations/{location}/apps/{app}/versions/{version}
displayName	string Facultatif. Nom à afficher de la version de l'application.
description	string Facultatif. Description de la version de l'application.
creator	string Uniquement en sortie. Adresse e-mail de l'utilisateur qui a créé la version de l'application.
createTime	string (Timestamp format) Uniquement en sortie. Code temporel de la création de la version de l'application. 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".
snapshot	object (AppSnapshot) Uniquement en sortie. Instantané de l'application lors de la création de la version.
etag	string Uniquement en sortie. Etag utilisé pour s'assurer que l'objet n'a pas été modifié lors d'une opération de lecture/modification/écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.

Horodatage

Représentation JSON
{ "seconds": string, "nanos": integer }

Champs
seconds	string (int64 format) Représente les secondes de l'heure UTC à partir de l'epoch Unix 1970-01-01T00:00:00Z. La valeur doit être comprise entre -62135596800 et 253402300799 inclus (ce qui correspond à 0001-01-01T00:00:00Z et 9999-12-31T23:59:59Z).
nanos	integer Fractions de secondes non négatives avec une précision de l'ordre de la nanoseconde. Ce champ correspond à la partie en nanosecondes de la durée, et non à une alternative aux secondes. Les valeurs de secondes négatives avec des fractions doivent toujours comporter des valeurs de nanosecondes non négatives comptabilisées dans le temps. La valeur doit être comprise entre 0 et 999 999 999 inclus.

AppSnapshot

Représentation JSON
{ "app": { object (App) }, "agents": [ { object (Agent) } ], "tools": [ { object (Tool) } ], "examples": [ { object (Example) } ], "guardrails": [ { object (Guardrail) } ], "toolsets": [ { object (Toolset) } ] }

Champs
app	object (App) Facultatif. Paramètres de base de l'application.
agents[]	object (Agent) Facultatif. Liste des agents dans l'application.
tools[]	object (Tool) Facultatif. Liste des outils de l'application.
examples[]	object (Example) Facultatif. Liste d'exemples dans l'application.
guardrails[]	object (Guardrail) Facultatif. Liste des mesures de protection dans l'application.
toolsets[]	object (Toolset) Facultatif. Liste des ensembles d'outils dans l'application.

Application

Représentation JSON

{ "name": string, "displayName": string, "description": string, "pinned": boolean, "rootAgent": string, "languageSettings": { object (LanguageSettings) }, "timeZoneSettings": { object (TimeZoneSettings) }, "audioProcessingConfig": { object (AudioProcessingConfig) }, "loggingSettings": { object (LoggingSettings) }, "errorHandlingSettings": { object (ErrorHandlingSettings) }, "modelSettings": { object (ModelSettings) }, "toolExecutionMode": enum (ToolExecutionMode), "evaluationMetricsThresholds": { object (EvaluationMetricsThresholds) }, "variableDeclarations": [ { object (VariableDeclaration) } ], "predefinedVariableDeclarations": [ { object (VariableDeclaration) } ], "globalInstruction": string, "guardrails": [ string ], "dataStoreSettings": { object (DataStoreSettings) }, "defaultChannelProfile": { object (ChannelProfile) }, "metadata": { string: string, ... }, "createTime": string, "updateTime": string, "etag": string, "deploymentCount": integer, "clientCertificateSettings": { object (ClientCertificateSettings) }, "vpcScSettings": { object (VpcScSettings) }, "locked": boolean, "validationErrors": [ string ], "dashboardSettings": { object (DashboardSettings) } }

Champs
name	string Identifiant. Identifiant unique de l'application. Format : projects/{project}/locations/{location}/apps/{app}
displayName	string Obligatoire. Nom à afficher de l'application.
description	string Facultatif. Description de l'application dans un format lisible.
pinned	boolean Facultatif. Indique si l'application est épinglée dans la liste des applications.
rootAgent	string Facultatif. L'agent racine est le point d'entrée de l'application. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
languageSettings	object (LanguageSettings) Facultatif. Paramètres de langue de l'application.
timeZoneSettings	object (TimeZoneSettings) Facultatif. Paramètres de fuseau horaire de l'application.
audioProcessingConfig	object (AudioProcessingConfig) Facultatif. Configuration du traitement audio de l'application.
loggingSettings	object (LoggingSettings) Facultatif. Paramètres de journalisation de l'application.
errorHandlingSettings	object (ErrorHandlingSettings) Facultatif. Paramètres de gestion des exceptions de l'application.
modelSettings	object (ModelSettings) Facultatif. Paramètres de modèle LLM par défaut pour l'application. Les ressources individuelles (par exemple, les agents et les garde-fous) peuvent remplacer ces configurations si nécessaire.
toolExecutionMode	enum (ToolExecutionMode) Facultatif. Mode d'exécution de l'outil pour l'application. Si aucune valeur n'est fournie, la valeur par défaut est "PARALLEL".
evaluationMetricsThresholds	object (EvaluationMetricsThresholds) Facultatif. Seuils d'évaluation pour l'application.
variableDeclarations[]	object (VariableDeclaration) Facultatif. Déclarations des variables.
predefinedVariableDeclarations[]	object (VariableDeclaration) Uniquement en sortie. Déclarations des variables prédéfinies pour l'application.
globalInstruction	string Facultatif. Instructions pour tous les agents de l'application. Vous pouvez utiliser ces instructions pour configurer une identité ou une personnalité stable pour tous les agents.
guardrails[]	string Facultatif. Liste des garde-fous pour l'application. Format : projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
dataStoreSettings	object (DataStoreSettings) Facultatif. Paramètres du data store pour l'application.
defaultChannelProfile	object (ChannelProfile) Facultatif. Profil de chaîne par défaut utilisé par l'application.
metadata	map (key: string, value: string) Facultatif. Métadonnées sur l'application. Ce champ peut être utilisé pour stocker des informations supplémentaires concernant les détails ou les utilisations prévues de l'application. Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime	string (Timestamp format) Uniquement en sortie. Code temporel de la création de l'application. 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'application. 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 Uniquement en sortie. Etag utilisé pour s'assurer que l'objet n'a pas été modifié lors d'une opération de lecture/modification/écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.
deploymentCount	integer Uniquement en sortie. Nombre de déploiements dans l'application.
clientCertificateSettings	object (ClientCertificateSettings) Facultatif. Paramètres par défaut du certificat client pour l'application.
vpcScSettings	object (VpcScSettings) Facultatif. Paramètres VPC-SC de l'application.
locked	boolean Facultatif. Indique si l'application est verrouillée pour les modifications. Si l'application est verrouillée, les modifications apportées à ses ressources seront refusées.
validationErrors[]	string Uniquement en sortie. Mauvaise configuration ou avertissements dans l'application.
dashboardSettings	object (DashboardSettings) Facultatif. Paramètres de tableau de bord spécifiques à l'application pour associer et configurer les tableaux de bord Contact Center Insights.

LanguageSettings

Représentation JSON
{ "defaultLanguageCode": string, "supportedLanguageCodes": [ string ], "enableMultilingualSupport": boolean, "fallbackAction": string }

Champs
defaultLanguageCode	string Facultatif. Code de langue par défaut de l'application.
supportedLanguageCodes[]	string Facultatif. Liste des codes de langue acceptés par l'application, en plus de default_language_code.
enableMultilingualSupport	boolean Facultatif. Active la compatibilité multilingue. Si la valeur est "true", les agents de l'application utiliseront des instructions prédéfinies pour mieux gérer les entrées multilingues.
fallbackAction (deprecated)	string Cet élément est obsolète. Facultatif. Obsolète : cette fonctionnalité n'est plus disponible. Utilisez plutôt enable_multilingual_support pour améliorer la gestion des entrées multilingues. Action à effectuer lorsqu'un agent reçoit une entrée dans une langue non acceptée. Il peut s'agir d'une action prédéfinie ou d'un appel d'outil personnalisé. Les valeurs valides sont les suivantes : - Nom complet de la ressource d'un outil, qui déclenche l'exécution d'un outil spécifique. - Une action système prédéfinie, telle que "escalade" ou "quitter", qui déclenche un signal EndSession avec le metadata correspondant pour mettre fin à la conversation.

TimeZoneSettings

Représentation JSON
{ "timeZone": string }

Champs
timeZone	string Facultatif. Fuseau horaire de l'application, issu de la base de données des fuseaux horaires (par exemple, Amérique du Nord/Los_Angeles, Europe/Paris).

AudioProcessingConfig

Représentation JSON
{ "synthesizeSpeechConfigs": { string: { object (SynthesizeSpeechConfig) }, ... }, "bargeInConfig": { object (BargeInConfig) }, "inactivityTimeout": string, "ambientSoundConfig": { object (AmbientSoundConfig) } }

Champs
synthesizeSpeechConfigs	map (key: string, value: object (SynthesizeSpeechConfig)) Facultatif. Configuration de la synthèse de la réponse de l'agent, mappage du code de langue à SynthesizeSpeechConfig. Si la configuration pour le code de langue spécifié est introuvable, celle du code de langue racine sera utilisée. Par exemple, si la carte contient "en-us" et "en", et que le code de langue spécifié est "en-gb", la configuration "en" sera utilisée. Remarque : Le code de langue n'est pas sensible à la casse. Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
bargeInConfig	object (BargeInConfig) Facultatif. Configure le comportement de l'agent pour les activités d'interruption par l'utilisateur.
inactivityTimeout	string (Duration format) Facultatif. Durée d'inactivité de l'utilisateur (pas de parole ni d'interaction) avant que l'agent ne l'invite à réagir. Si ce paramètre n'est pas défini, l'agent ne demandera pas à l'utilisateur de réengager la conversation. Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
ambientSoundConfig	object (AmbientSoundConfig) Facultatif. Configuration du son ambiant à lire avec la réponse de l'agent synthétisée, pour rendre la conversation plus naturelle.

SynthesizeSpeechConfigsEntry

Représentation JSON
{ "key": string, "value": { object (SynthesizeSpeechConfig) } }

Champs
key	string
value	object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

Représentation JSON
{ "voice": string, "voiceSampleGcsUri": string, "speakingRate": number, "model": string, "instruction": string, "consentAudioGcsUri": string }

Champs
voice	string Facultatif. Nom de la voix. Si ce paramètre n'est pas défini, le service choisit une voix en fonction des autres paramètres, tels que language_code. Pour obtenir la liste des voix disponibles, veuillez consulter Voix et langues disponibles dans Cloud Text-to-Speech.
voiceSampleGcsUri (deprecated)	string Cet élément est obsolète. Facultatif. Obsolète : utilisez plutôt custom_voice_samples dans AudioProcessingConfig. URI Cloud Storage de l'échantillon audio pour le clonage de voix. L'échantillon audio doit être un fichier WAV mono-canal de 24 kHz. Remarque : Veuillez vous assurer que l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com dispose de l'autorisation storage.objects.get pour l'objet Cloud Storage.
speakingRate	number Facultatif. Taux/vitesse de l'énoncé. Valeur comprise dans la plage [0,25, 2,0]. La valeur 1,0 correspond à la vitesse native normale compatible avec la voix spécifique. La valeur 2,0 est deux fois plus rapide et la valeur 0,5 est deux fois moins rapide. Les valeurs en dehors de la plage [0,25, 2,0] renvoient une erreur.
model	string Facultatif. Modèle utilisé pour synthétiser l'audio. Valeurs actuellement acceptées : "gemini-3.1-flash-tts-preview". Si ce champ est vide, Chirp3-HD est utilisé.
instruction	string Facultatif. Instruction utilisée pour synthétiser la parole lors de l'utilisation d'un modèle génératif.
consentAudioGcsUri (deprecated)	string Cet élément est obsolète. Facultatif. Obsolète : utilisez plutôt custom_voice_samples dans AudioProcessingConfig. URI Cloud Storage de l'audio d'autorisation pour le clonage de voix.

BargeInConfig

Représentation JSON
{ "disableBargeIn": boolean, "bargeInAwareness": boolean }

Champs
disableBargeIn (deprecated)	boolean Cet élément est obsolète. Facultatif. Obsolète : disable_barge_in est obsolète et remplacé par disable_barge_in_control dans ChannelProfile. Désactive l'interruption par l'utilisateur pendant que l'agent parle. Si la valeur est "true", les entrées utilisateur pendant la lecture de la réponse de l'agent seront ignorées.
bargeInAwareness	boolean Facultatif. Si cette option est activée, l'agent adaptera sa prochaine réponse en partant du principe que l'utilisateur n'a pas entendu l'intégralité du message précédent de l'agent. Cette méthode ne doit pas être utilisée dans les scénarios où les réponses de l'agent sont affichées visuellement.

Durée

Représentation JSON
{ "seconds": string, "nanos": integer }

Champs
seconds	string (int64 format) Secondes signées de la période. La valeur doit être comprise entre -315 576 000 000 et [phone] (inclus). Remarque : Ces limites sont calculées à partir de : 60 s/min * 60 min/h * 24 h/jour * 365,25 jours/an * 10 000 ans
nanos	integer Fractions de secondes signées avec une précision de l'ordre de la nanoseconde pour la durée. Les durées inférieures à une seconde sont représentées par un champ seconds égal à 0 et un champ nanos positif ou négatif. Pour les durées d'une seconde ou plus, une valeur non nulle pour le champ nanos doit avoir le même signe que le champ seconds. La valeur doit être comprise entre -999 999 999 et [phone] inclus.

AmbientSoundConfig

Représentation JSON
{ "volumeGainDb": number, // Union field source can be only one of the following: "prebuiltAmbientNoise": enum (PrebuiltAmbientNoise), "gcsUri": string, "prebuiltAmbientSound": string // End of list of possible types for union field source. }

Champs
volumeGainDb	number Facultatif. Gain de volume (en dB) du volume natif normal compatible avec le bruit ambiant, compris entre -96 et 16. Si la valeur n'est pas définie ou si elle est définie sur une valeur de zéro (dB), elle est lue à une amplitude de signal natif normal. Une valeur de -6 (dB) est lue avec environ la moitié de l'amplitude du signal natif normal. Une valeur de +6 (dB) est lue avec environ deux fois plus d'amplitude que le signal natif normal. Nous vous recommandons vivement de ne pas dépasser +10 (dB), car il n'y a généralement pas d'augmentation efficace du volume pour une valeur supérieure à cette valeur.
Champ d'union source. Bruit ambiant à lire avec la réponse de l'agent synthétisée, pour rendre la conversation plus naturelle. source ne peut être qu'un des éléments suivants :
prebuiltAmbientNoise (deprecated)	enum (PrebuiltAmbientNoise) Cet élément est obsolète. Facultatif. Obsolète : prebuilt_ambient_noise est obsolète et remplacé par prebuilt_ambient_sound.
gcsUri	string Facultatif. Bruit ambiant sous forme de fichier WAV mono-canal à 16 kHz stocké dans Cloud Storage. Remarque : Veuillez vous assurer que l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com dispose de l'autorisation storage.objects.get pour l'objet Cloud Storage.
prebuiltAmbientSound	string Facultatif. Nom du son ambiant prédéfini. Les valeurs valides sont : "coffee_shop", "keyboard", "keypad", "hum", "office_1", "office_2", "office_3", "room_1", "room_2", "room_3", "room_4", "room_5", "air_conditioner".

LoggingSettings

Représentation JSON

{ "redactionConfig": { object (RedactionConfig) }, "audioRecordingConfig": { object (AudioRecordingConfig) }, "unredactedAudioRecordingConfig": { object (AudioRecordingConfig) }, "bigqueryExportSettings": { object (BigQueryExportSettings) }, "unredactedBigqueryExportSettings": { object (BigQueryExportSettings) }, "cloudLoggingSettings": { object (CloudLoggingSettings) }, "conversationLoggingSettings": { object (ConversationLoggingSettings) }, "evaluationAudioRecordingConfig": { object (AudioRecordingConfig) }, "metricAnalysisSettings": { object (MetricAnalysisSettings) } }

Champs
redactionConfig	object (RedactionConfig) Facultatif. Configuration du masquage des données sensibles.
audioRecordingConfig	object (AudioRecordingConfig) Facultatif. Configuration de l'enregistrement des interactions audio. L'audio est soumis à masquage, comme configuré dans RedactionConfig.
unredactedAudioRecordingConfig	object (AudioRecordingConfig) Facultatif. Configure un enregistrement supplémentaire de l'audio non masqué. Cette option peut être utilisée pour conserver une copie audio brute lorsque la censure audio est définie sur enabled, généralement à des fins d'audit ou de surveillance.
bigqueryExportSettings	object (BigQueryExportSettings) Facultatif. Configure les comportements d'exportation BigQuery pour l'application. Les données de conversation sont soumises à la censure configurée dans RedactionConfig.
unredactedBigqueryExportSettings	object (BigQueryExportSettings) Facultatif. Configure les comportements d'exportation BigQuery pour l'application. Les données de conversation non masquées seront exportées vers les tables BigQuery si cette option est activée.
cloudLoggingSettings	object (CloudLoggingSettings) Facultatif. Paramètres permettant de décrire les comportements de Cloud Logging pour l'application.
conversationLoggingSettings	object (ConversationLoggingSettings) Facultatif. Paramètres permettant de décrire les comportements de journalisation des conversations pour l'application.
evaluationAudioRecordingConfig	object (AudioRecordingConfig) Facultatif. Configuration de l'enregistrement des interactions audio pour l'évaluation. Par défaut, l'enregistrement audio n'est pas activé pour les sessions d'évaluation.
metricAnalysisSettings	object (MetricAnalysisSettings) Facultatif. Paramètres permettant de décrire les comportements de collecte de données de conversation pour le pipeline d'analyse LLM de l'application.

RedactionConfig

Représentation JSON
{ "enableRedaction": boolean, "inspectTemplate": string, "deidentifyTemplate": string }

Champs
enableRedaction	boolean Facultatif. Si la valeur est "true", le masquage sera appliqué dans différents scénarios de journalisation, y compris l'historique des conversations, Cloud Logging et l'enregistrement audio.
inspectTemplate	string Facultatif. Nom du modèle d'inspection DLP permettant de configurer la détection des types de données sensibles. Format : projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
deidentifyTemplate	string Facultatif. Nom du modèle d'anonymisation DLP pour indiquer comment anonymiser le contenu. Format : projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

AudioRecordingConfig

Représentation JSON
{ "gcsBucket": string, "gcsPathPrefix": string }

Champs
gcsBucket	string Facultatif. Bucket Cloud Storage pour stocker les enregistrements audio des sessions. L'URI doit commencer par "gs://". Veuillez choisir un emplacement de bucket qui répond à vos exigences de résidence des données. Remarque : Si le bucket Cloud Storage se trouve dans un projet différent de celui de l'application, vous devez accorder l'autorisation storage.objects.create à l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
gcsPathPrefix	string Facultatif. Préfixe du chemin d'accès Cloud Storage pour les enregistrements audio. Ce préfixe peut inclure les espaces réservés suivants, qui seront remplacés de manière dynamique au moment de la diffusion : - $project : ID du projet - $location : emplacement de l'application - $app : ID de l'application - $date : date de la session au format AAAA-MM-JJ - $session : ID de la session Si le préfixe de chemin n'est pas spécifié, le préfixe par défaut $project/$location/$app/$date/$session/ est utilisé.

BigQueryExportSettings

Représentation JSON
{ "enabled": boolean, "project": string, "dataset": string }

Champs
enabled	boolean Facultatif. Indique si l'exportation BigQuery est activée.
project	string Facultatif. L'ID du projet de l'ensemble de données BigQuery vers lequel exporter les données. Remarque : Si l'ensemble de données BigQuery se trouve dans un projet différent de celui de l'application, vous devez attribuer le rôle roles/bigquery.admin à l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
dataset	string Facultatif. L'ID de l'ensemble de données BigQuery vers lequel exporter les données.

CloudLoggingSettings

Représentation JSON
{ "enableCloudLogging": boolean }

Champs
enableCloudLogging	boolean Facultatif. Indique si Cloud Logging doit être activé pour les sessions.

ConversationLoggingSettings

Représentation JSON
{ "disableConversationLogging": boolean, "retentionWindow": string }

Champs
disableConversationLogging	boolean Facultatif. Indique si la journalisation des conversations doit être désactivée pour les sessions.
retentionWindow	string (Duration format) Facultatif. Contrôle la période de conservation de la conversation. Si elle n'est pas définie, la conversation sera conservée pendant 365 jours. Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

MetricAnalysisSettings

Représentation JSON
{ "llmMetricsOptedOut": boolean }

Champs
llmMetricsOptedOut	boolean Facultatif. Indique si les données de conversation doivent être collectées pour les métriques d'analyse des LLM. Si la valeur est "true", les données de conversation ne seront pas collectées pour les métriques d'analyse LLM. Dans le cas contraire, elles le seront.

ErrorHandlingSettings

Représentation JSON
{ "errorHandlingStrategy": enum (ErrorHandlingStrategy), "fallbackResponseConfig": { object (FallbackResponseConfig) }, "endSessionConfig": { object (EndSessionConfig) } }

Champs
errorHandlingStrategy	enum (ErrorHandlingStrategy) Facultatif. Stratégie à utiliser pour la gestion des exceptions.
fallbackResponseConfig	object (FallbackResponseConfig) Facultatif. Configuration pour la gestion des réponses de remplacement.
endSessionConfig	object (EndSessionConfig) Facultatif. Configuration pour mettre fin à la session en cas d'erreurs système (par exemple, erreurs LLM).

FallbackResponseConfig

Représentation JSON
{ "customFallbackMessages": { string: string, ... }, "maxFallbackAttempts": integer }

Champs
customFallbackMessages	map (key: string, value: string) Facultatif. Messages de remplacement en cas d'erreurs système (par exemple, erreurs LLM), mappés par code de langue compatible. Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
maxFallbackAttempts	integer Facultatif. Nombre maximal de tentatives de secours à effectuer avant que l'agent n'émette le signal EndSession.

CustomFallbackMessagesEntry

Représentation JSON
{ "key": string, "value": string }

Champs
key	string
value	string

EndSessionConfig

Représentation JSON
{ // Union field _escalate_session can be only one of the following: "escalateSession": boolean // End of list of possible types for union field _escalate_session. }

Champs
Champ d'union _escalate_session. _escalate_session ne peut être qu'un des éléments suivants :
escalateSession	boolean Facultatif. Indique si la session doit être escaladée dans EndSession. Si la session est escaladée, metadata in EndSession contient session_escalated = true. Pour en savoir plus, consultez https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent.

ModelSettings

Représentation JSON
{ "model": string, // Union field _temperature can be only one of the following: "temperature": number // End of list of possible types for union field _temperature. }

Champs
model	string Facultatif. Modèle LLM que l'agent doit utiliser. Si aucune valeur n'est définie, l'agent hérite du modèle de son agent parent.
Champ d'union _temperature. _temperature ne peut être qu'un des éléments suivants :
temperature	number Facultatif. Si cette option est définie, cette température sera utilisée pour le modèle LLM. La température contrôle le caractère aléatoire des réponses du modèle. Les températures plus basses produisent des réponses plus prévisibles. Les températures plus élevées génèrent des réponses plus créatives.

EvaluationMetricsThresholds

Représentation JSON
{ "goldenEvaluationMetricsThresholds": { object (GoldenEvaluationMetricsThresholds) }, "hallucinationMetricBehavior": enum (HallucinationMetricBehavior), "goldenHallucinationMetricBehavior": enum (HallucinationMetricBehavior), "scenarioHallucinationMetricBehavior": enum (HallucinationMetricBehavior) }

Champs
goldenEvaluationMetricsThresholds	object (GoldenEvaluationMetricsThresholds) Facultatif. Seuils des métriques d'évaluation privilégiées.
hallucinationMetricBehavior (deprecated)	enum (HallucinationMetricBehavior) Cet élément est obsolète. Facultatif. Obsolète : utilisez plutôt golden_hallucination_metric_behavior. Le comportement de la métrique d'hallucination est actuellement utilisé pour les évaluations de référence.
goldenHallucinationMetricBehavior	enum (HallucinationMetricBehavior) Facultatif. Comportement de la métrique d'hallucination pour les évaluations de référence.
scenarioHallucinationMetricBehavior	enum (HallucinationMetricBehavior) Facultatif. Comportement de la métrique d'hallucination pour les évaluations de scénarios.

GoldenEvaluationMetricsThresholds

Représentation JSON
{ "turnLevelMetricsThresholds": { object (TurnLevelMetricsThresholds) }, "expectationLevelMetricsThresholds": { object (ExpectationLevelMetricsThresholds) }, "toolMatchingSettings": { object (ToolMatchingSettings) } }

Champs
turnLevelMetricsThresholds	object (TurnLevelMetricsThresholds) Facultatif. Seuils des métriques au niveau du tour.
expectationLevelMetricsThresholds	object (ExpectationLevelMetricsThresholds) Facultatif. Seuils des métriques de niveau d'attente.
toolMatchingSettings	object (ToolMatchingSettings) Facultatif. Paramètres de correspondance de l'outil. Un appel d'outil supplémentaire est un appel d'outil présent dans l'exécution, mais qui ne correspond à aucun appel d'outil dans l'attente de référence.

TurnLevelMetricsThresholds

Représentation JSON

{ "semanticSimilarityChannel": enum (SemanticSimilarityChannel), // Union field _semantic_similarity_success_threshold can be only one of the // following: "semanticSimilaritySuccessThreshold": integer // End of list of possible types for union field // _semantic_similarity_success_threshold. // Union field _overall_tool_invocation_correctness_threshold can be only one // of the following: "overallToolInvocationCorrectnessThreshold": number // End of list of possible types for union field // _overall_tool_invocation_correctness_threshold. }

Champs
semanticSimilarityChannel	enum (SemanticSimilarityChannel) Facultatif. Canal de similarité sémantique à utiliser pour l'évaluation.
Champ d'union _semantic_similarity_success_threshold. _semantic_similarity_success_threshold ne peut être qu'un des éléments suivants :
semanticSimilaritySuccessThreshold	integer Facultatif. Seuil de réussite pour la similarité sémantique. Veuillez saisir un nombre entier compris entre 0 et 4. La valeur par défaut est >= 3.
Champ d'union _overall_tool_invocation_correctness_threshold. _overall_tool_invocation_correctness_threshold ne peut être qu'un des éléments suivants :
overallToolInvocationCorrectnessThreshold	number Facultatif. Seuil de réussite pour la correction globale de l'appel d'outil. Doit être un nombre à virgule flottante compris entre 0 et 1. La valeur par défaut est 1.0.

ExpectationLevelMetricsThresholds

Représentation JSON
{ // Union field _tool_invocation_parameter_correctness_threshold can be only one // of the following: "toolInvocationParameterCorrectnessThreshold": number // End of list of possible types for union field // _tool_invocation_parameter_correctness_threshold. }

Champs
Champ d'union _tool_invocation_parameter_correctness_threshold. _tool_invocation_parameter_correctness_threshold ne peut être qu'un des éléments suivants :
toolInvocationParameterCorrectnessThreshold	number Facultatif. Seuil de réussite pour la justesse des paramètres d'appel d'outil individuel. Doit être un nombre à virgule flottante compris entre 0 et 1. La valeur par défaut est 1.0.

ToolMatchingSettings

Représentation JSON
{ "extraToolCallBehavior": enum (ExtraToolCallBehavior) }

Champs
extraToolCallBehavior	enum (ExtraToolCallBehavior) Facultatif. Comportement pour les appels d'outils supplémentaires. La valeur par défaut est "FAIL".

VariableDeclaration

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

Champs
name	string Obligatoire. Nom de la variable. Le nom doit commencer par une lettre ou un trait de soulignement, et ne peut contenir que des lettres, des chiffres ou des traits de soulignement.
description	string Obligatoire. Description de la variable.
schema	object (Schema) Obligatoire. Schéma de la variable.

Schéma

Représentation JSON

{ "type": enum (Type), "properties": { string: { object (Schema) }, ... }, "required": [ string ], "description": string, "items": { object (Schema) }, "nullable": boolean, "uniqueItems": boolean, "prefixItems": [ { object (Schema) } ], "additionalProperties": { object (Schema) }, "anyOf": [ { object (Schema) } ], "enum": [ string ], "default": value, "ref": string, "defs": { string: { object (Schema) }, ... }, "title": string, "minItems": string, "maxItems": string, // Union field _minimum can be only one of the following: "minimum": number // End of list of possible types for union field _minimum. // Union field _maximum can be only one of the following: "maximum": number // End of list of possible types for union field _maximum. }

Champs
type	enum (Type) Obligatoire. Type des données.
properties	map (key: string, value: object (Schema)) Facultatif. Propriétés de Type.OBJECT. Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
required[]	string Facultatif. Propriétés requises de Type.OBJECT.
description	string Facultatif. Description des données.
items	object (Schema) Facultatif. Schéma des éléments de Type.ARRAY.
nullable	boolean Facultatif. Indique si la valeur peut être nulle.
uniqueItems	boolean Facultatif. Indique que les éléments du tableau doivent être uniques. Ne s'applique qu'à TYPE.ARRAY.
prefixItems[]	object (Schema) Facultatif. Schémas des éléments initiaux de Type.ARRAY.
additionalProperties	object (Schema) Facultatif. Peut être une valeur booléenne ou un objet. Contrôle la présence de propriétés supplémentaires.
anyOf[]	object (Schema) Facultatif. La valeur doit être validée par rapport à l'un ou plusieurs des sous-schémas de la liste.
enum[]	string Facultatif. Valeurs possibles de l'élément de type primitif avec le format enum. Exemples : 1. Nous pouvons définir la direction comme suit : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. Nous pouvons définir le numéro d'appartement comme suit : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default	value (Value format) Facultatif. Valeur par défaut des données.
ref	string Facultatif. Permet les références indirectes entre les nœuds de schéma. La valeur doit être une référence valide à un enfant de la racine defs. Par exemple, le schéma suivant définit une référence à un nœud de schéma nommé "Pet" : type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string La valeur de la propriété "pet" est une référence au nœud de schéma nommé "Pet". Pour en savoir plus, consultez https://json-schema.org/understanding-json-schema/structuring.
defs	map (key: string, value: object (Schema)) Facultatif. Carte des définitions à utiliser par ref. Uniquement autorisé à la racine du schéma. Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
title	string Facultatif. Titre du schéma.
minItems	string (int64 format) Facultatif. Nombre minimal d'éléments pour Type.ARRAY.
maxItems	string (int64 format) Facultatif. Nombre maximal d'éléments pour Type.ARRAY.
Champ d'union _minimum. _minimum ne peut être qu'un des éléments suivants :
minimum	number Facultatif. Valeur minimale pour Type.INTEGER et Type.NUMBER.
Champ d'union _maximum. _maximum ne peut être qu'un des éléments suivants :
maximum	number Facultatif. Valeur maximale pour Type.INTEGER et Type.NUMBER.

PropertiesEntry

Représentation JSON
{ "key": string, "value": { object (Schema) } }

Champs
key	string
value	object (Schema)

Valeur

Représentation JSON
{ // Union field kind can be only one of the following: "nullValue": null, "numberValue": number, "stringValue": string, "boolValue": boolean, "structValue": { object }, "listValue": array // End of list of possible types for union field kind. }

Champs
Champ d'union kind. Type de valeur. kind ne peut être qu'un des éléments suivants :
nullValue	null Représente un null JSON.
numberValue	number Représente un nombre JSON. Ne doit pas être NaN, Infinity ni -Infinity, car ces valeurs ne sont pas acceptées dans JSON. Il ne peut pas non plus représenter de grandes valeurs Int64, car le format JSON ne les accepte généralement pas dans son type numérique.
stringValue	string Représente une chaîne JSON.
boolValue	boolean Représente une valeur booléenne JSON (littéral true ou false en JSON).
structValue	object (Struct format) Représente un objet JSON.
listValue	array (ListValue format) Représente un tableau JSON.

Struct

Représentation JSON
{ "fields": { string: value, ... } }

Champs
fields	map (key: string, value: value (Value format)) Carte non ordonnée de valeurs typées dynamiquement. Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

Représentation JSON
{ "key": string, "value": value }

Champs
key	string
value	value (Value format)

ListValue

Représentation JSON
{ "values": [ value ] }

Champs
values[]	value (Value format) Champ répété de valeurs typées de manière dynamique.

DefsEntry

Représentation JSON
{ "key": string, "value": { object (Schema) } }

Champs
key	string
value	object (Schema)

DataStoreSettings

Représentation JSON
{ "engines": [ { object (Engine) } ] }

Champs
engines[]	object (Engine) Uniquement en sortie. Moteurs de l'application.

Moteur

Représentation JSON
{ "name": string, "type": enum (Type) }

Champs
name	string Uniquement en sortie. Nom de ressource du moteur. Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type	enum (Type) Uniquement en sortie. Type de moteur.

ChannelProfile

Représentation JSON

{ "profileId": string, "channelType": enum (ChannelType), "personaProperty": { object (PersonaProperty) }, "webWidgetConfig": { object (WebWidgetConfig) }, "whatsappConfig": { object (WhatsAppConfig) }, "instagramConfig": { object (InstagramConfig) }, // Union field _disable_dtmf can be only one of the following: "disableDtmf": boolean // End of list of possible types for union field _disable_dtmf. // Union field _disable_barge_in_control can be only one of the following: "disableBargeInControl": boolean // End of list of possible types for union field _disable_barge_in_control. // Union field _noise_suppression_level can be only one of the following: "noiseSuppressionLevel": string // End of list of possible types for union field _noise_suppression_level. }

Champs
profileId	string Facultatif. Identifiant unique du profil de chaîne.
channelType	enum (ChannelType) Facultatif. Type de profil de chaîne.
personaProperty	object (PersonaProperty) Facultatif. Propriété "persona" du profil de la chaîne.
webWidgetConfig	object (WebWidgetConfig) Facultatif. Configuration du widget Web.
whatsappConfig	object (WhatsAppConfig) Facultatif. Configuration spécifique aux déploiements WhatsApp.
instagramConfig	object (InstagramConfig) Facultatif. Configuration spécifique aux déploiements Instagram.
Champ d'union _disable_dtmf. _disable_dtmf ne peut être qu'un des éléments suivants :
disableDtmf	boolean Facultatif. Indique si le DTMF (double fréquence) doit être désactivé.
Champ d'union _disable_barge_in_control. _disable_barge_in_control ne peut être qu'un des éléments suivants :
disableBargeInControl	boolean Facultatif. Indique si le contrôle de l'interruption par l'utilisateur doit être désactivé dans la conversation. - true : les interruptions de l'utilisateur sont désactivées pendant que l'agent parle. - false : l'agent conserve le contrôle automatique sur le moment où l'utilisateur peut interrompre.
Champ d'union _noise_suppression_level. _noise_suppression_level ne peut être qu'un des éléments suivants :
noiseSuppressionLevel	string Facultatif. Niveau de suppression du bruit du profil de chaîne. Les valeurs disponibles sont "low", "moderate", "high" et "very_high".

PersonaProperty

Représentation JSON
{ "persona": enum (Persona) }

Champs
persona	enum (Persona) Facultatif. Personnalité de la chaîne.

WebWidgetConfig

Représentation JSON
{ "modality": enum (Modality), "theme": enum (Theme), "webWidgetTitle": string, "securitySettings": { object (SecuritySettings) } }

Champs
modality	enum (Modality) Facultatif. Modalité du widget Web.
theme	enum (Theme) Facultatif. Thème du widget Web.
webWidgetTitle	string Facultatif. Titre du widget Web.
securitySettings	object (SecuritySettings) Facultatif. Paramètres de sécurité du widget Web.

SecuritySettings

Représentation JSON
{ "enablePublicAccess": boolean, "enableOriginCheck": boolean, "allowedOrigins": [ string ], "enableRecaptcha": boolean }

Champs
enablePublicAccess	boolean Facultatif. Indique si l'accès public au widget Web est activé. Si la valeur est true, le widget Web sera accessible au public. Si la valeur est false, le widget Web doit être intégré à votre propre système d'authentification et d'autorisation pour renvoyer des identifiants valides permettant d'accéder à l'agent CES.
enableOriginCheck	boolean Facultatif. Indique si la vérification de l'origine du widget Web est activée. Si la valeur est true, le widget Web vérifie l'origine du site Web qui charge le widget Web et n'autorise le chargement que dans la même origine ou dans l'une des origines autorisées.
allowedOrigins[]	string Facultatif. Origines autorisées à héberger le widget Web. Une origine est définie par la norme RFC 6454. Si ce champ est vide, toutes les origines sont autorisées. Vous ne pouvez pas inclure plus de 100 origines. Exemple : "https://example.com"
enableRecaptcha	boolean Facultatif. Indique si la validation reCAPTCHA pour le widget Web est activée.

WhatsAppConfig

Représentation JSON
{ "wabaId": string, "phoneNumberId": string, "phoneNumber": string, "displayName": string, "thumbnailUrl": string, "description": string }

Champs
wabaId	string Obligatoire. ID de compte WhatsApp Business.
phoneNumberId	string Obligatoire. ID du numéro de téléphone Meta.
phoneNumber	string Facultatif. Numéro de téléphone au format E.164.
displayName	string Uniquement en sortie. Nom de la page Facebook récupérée.
thumbnailUrl	string Uniquement en sortie. URL de la vignette de la fiche d'établissement Meta récupérée.
description	string Uniquement en sortie. Description de la page ou du profil Meta de l'entreprise.

InstagramConfig

Représentation JSON
{ "instagramAccountId": string, "displayName": string, "thumbnailUrl": string, "description": string }

Champs
instagramAccountId	string Obligatoire. ID du compte Instagram.
displayName	string Uniquement en sortie. Nom de la page Facebook récupérée.
thumbnailUrl	string Uniquement en sortie. URL de la vignette de la fiche d'établissement Meta récupérée.
description	string Uniquement en sortie. Description de la page ou du profil Meta de l'entreprise.

MetadataEntry

Représentation JSON
{ "key": string, "value": string }

Champs
key	string
value	string

ClientCertificateSettings

Représentation JSON
{ "tlsCertificate": string, "privateKey": string, "passphrase": string }

Champs
tlsCertificate	string Obligatoire. Certificat TLS encodé au format PEM. Cette chaîne doit inclure les lignes d'en-tête de début et de pied de page de fin.
privateKey	string Obligatoire. Nom de la ressource de version du secret Secret Manager stockant la clé privée encodée au format PEM. Format : projects/{project}/secrets/{secret}/versions/{version}
passphrase	string Facultatif. Nom de la ressource de version du secret Secret Manager stockant la phrase secrète permettant de déchiffrer la clé privée. Doit être laissé vide si la clé privée n'est pas chiffrée. Format : projects/{project}/secrets/{secret}/versions/{version}

VpcScSettings

Représentation JSON
{ "allowedOrigins": [ string ] }

Champs

allowedOrigins[]

string Facultatif. Origines HTTP(S) autorisées que les outils OpenAPI de l'application peuvent appeler directement lorsque VPC Service Controls est activé. Ces chaînes doivent correspondre exactement à l'origine, y compris le port si spécifié. (par exemple, "https://example.com" ou "https://example.com:443"). Cette liste ne s'applique pas encore aux outils Python qui peuvent effectuer des appels HTTP directs.

DashboardSettings

Représentation JSON
{ "defaultDashboard": string }

Champs
defaultDashboard	string Facultatif. Nom de ressource du tableau de bord Contact Center Insights par défaut associé à l'application. Il s'agit du tableau de bord qui s'affiche lorsque les utilisateurs accèdent à la vue "Surveillance" de l'application. Format : projects/{project}/locations/{location}/dashboards/{dashboard}

Agent

Représentation JSON

{ "name": string, "displayName": string, "description": string, "modelSettings": { object (ModelSettings) }, "instruction": string, "tools": [ string ], "childAgents": [ string ], "beforeAgentCallbacks": [ { object (Callback) } ], "afterAgentCallbacks": [ { object (Callback) } ], "beforeModelCallbacks": [ { object (Callback) } ], "afterModelCallbacks": [ { object (Callback) } ], "beforeToolCallbacks": [ { object (Callback) } ], "afterToolCallbacks": [ { object (Callback) } ], "createTime": string, "updateTime": string, "guardrails": [ string ], "etag": string, "toolsets": [ { object (AgentToolset) } ], "generatedSummary": string, "transferRules": [ { object (TransferRule) } ], "validationErrors": [ string ], // Union field agent_type can be only one of the following: "llmAgent": { object (LlmAgent) }, "remoteDialogflowAgent": { object (RemoteDialogflowAgent) } // End of list of possible types for union field agent_type. }

Champs
name	string Identifiant. Identifiant unique de l'agent. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
displayName	string Obligatoire. Nom à afficher de l'agent.
description	string Facultatif. Description de l'agent lisible par l'humain.
modelSettings	object (ModelSettings) Facultatif. Configurations du modèle LLM.
instruction	string Facultatif. Instructions pour le modèle LLM afin de guider le comportement de l'agent.
tools[]	string Facultatif. Liste des outils disponibles pour l'agent. Format : projects/{project}/locations/{location}/apps/{app}/tools/{tool}
childAgents[]	string Facultatif. Liste des agents enfants dans l'arborescence des agents. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
beforeAgentCallbacks[]	object (Callback) Facultatif. Rappels à exécuter avant l'appel de l'agent. Les rappels fournis sont exécutés de manière séquentielle dans l'ordre exact dans lequel ils sont fournis dans la liste. Si un rappel renvoie une réponse remplacée, l'exécution s'arrête et les rappels restants sont ignorés.
afterAgentCallbacks[]	object (Callback) Facultatif. Rappels à exécuter après l'appel de l'agent. Les rappels fournis sont exécutés de manière séquentielle dans l'ordre exact dans lequel ils sont fournis dans la liste. Si un rappel renvoie une réponse remplacée, l'exécution s'arrête et les rappels restants sont ignorés.
beforeModelCallbacks[]	object (Callback) Facultatif. Rappels à exécuter avant l'appel du modèle. Si le modèle est appelé plusieurs fois, le rappel sera exécuté plusieurs fois. Les rappels fournis sont exécutés de manière séquentielle dans l'ordre exact dans lequel ils sont fournis dans la liste. Si un rappel renvoie une réponse remplacée, l'exécution s'arrête et les rappels restants sont ignorés.
afterModelCallbacks[]	object (Callback) Facultatif. Rappels à exécuter après l'appel du modèle. Si le modèle est appelé plusieurs fois, le rappel sera exécuté plusieurs fois. Les rappels fournis sont exécutés de manière séquentielle dans l'ordre exact dans lequel ils sont fournis dans la liste. Si un rappel renvoie une réponse remplacée, l'exécution s'arrête et les rappels restants sont ignorés.
beforeToolCallbacks[]	object (Callback) Facultatif. Rappels à exécuter avant l'appel de l'outil. Si plusieurs outils sont appelés, le rappel sera exécuté plusieurs fois. Les rappels fournis sont exécutés de manière séquentielle dans l'ordre exact dans lequel ils sont fournis dans la liste. Si un rappel renvoie une réponse remplacée, l'exécution s'arrête et les rappels restants sont ignorés.
afterToolCallbacks[]	object (Callback) Facultatif. Rappels à exécuter après l'appel de l'outil. Si plusieurs outils sont appelés, le rappel sera exécuté plusieurs fois. Les rappels fournis sont exécutés de manière séquentielle dans l'ordre exact dans lequel ils sont fournis dans la liste. Si un rappel renvoie une réponse remplacée, l'exécution s'arrête et les rappels restants sont ignorés.
createTime	string (Timestamp format) Uniquement en sortie. Code temporel de la création de l'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 l'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".
guardrails[]	string Facultatif. Liste des garde-fous pour l'agent. Format : projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
etag	string Etag utilisé pour s'assurer que l'objet n'a pas été modifié lors d'une opération de lecture/modification/écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.
toolsets[]	object (AgentToolset) Facultatif. Liste des ensembles d'outils pour l'agent.
generatedSummary	string Uniquement en sortie. Si l'agent est généré par l'assistant LLM, ce champ contient un résumé descriptif de la génération.
transferRules[]	object (TransferRule) Facultatif. Règles de transfert d'agent. Si plusieurs règles correspondent, la première de la liste sera utilisée.
validationErrors[]	string Uniquement en sortie. Erreurs ou configurations incorrectes dans l'agent pouvant affecter sa qualité.
Champ d'union agent_type. Type d'agent. agent_type ne peut être qu'un des éléments suivants :
llmAgent	object (LlmAgent) Facultatif. Type d'agent par défaut.
remoteDialogflowAgent	object (RemoteDialogflowAgent) Facultatif. Agent Dialogflow distant à utiliser pour l'exécution de l'agent. Si ce champ est défini, toutes les autres propriétés au niveau de l'agent seront ignorées. Remarque : Si l'agent Dialogflow se trouve dans un projet différent de celui de l'application, vous devez accorder roles/dialogflow.client à l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

RemoteDialogflowAgent

Représentation JSON
{ "agent": string, "flowId": string, "environmentId": string, "inputVariableMapping": { string: string, ... }, "outputVariableMapping": { string: string, ... }, "respectResponseInterruptionSettings": boolean, "languageCodeVariable": string }

Champs
agent	string Obligatoire. Nom de ressource de l'agent Dialogflow. Format : projects/{project}/locations/{location}/agents/{agent}
flowId	string Facultatif. ID du flux dans l'agent Dialogflow.
environmentId	string Facultatif. ID de l'environnement de l'agent Dialogflow à utiliser pour l'exécution de l'agent. Si aucune valeur n'est spécifiée, l'environnement brouillon est utilisé.
inputVariableMapping	map (key: string, value: string) Facultatif. Mappage des noms des variables d'application avec les noms des paramètres de session Dialogflow à envoyer à l'agent Dialogflow en tant qu'entrée. Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
outputVariableMapping	map (key: string, value: string) Facultatif. Mappage des noms de paramètres de session Dialogflow aux noms de variables d'application à renvoyer à l'agent CES une fois l'exécution de l'agent Dialogflow terminée. Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
respectResponseInterruptionSettings	boolean Facultatif. Indique s'il faut respecter les paramètres d'interruption au niveau du message configurés dans l'agent Dialogflow. Si la valeur est "false", tous les messages de réponse de l'agent Dialogflow suivent les paramètres d'interruption au niveau de l'application. Si la valeur est "true", seuls les messages de réponse dont la valeur allow_playback_interruption est définie sur "true" peuvent être interrompus. Tous les autres messages suivent les paramètres d'interruption au niveau de l'application.
languageCodeVariable	string Facultatif. Nom de la variable contenant le code de langue à utiliser pour la session Dialogflow. Si aucune valeur n'est spécifiée, le code de langue par défaut de l'agent Dialogflow sera utilisé.

InputVariableMappingEntry

Représentation JSON
{ "key": string, "value": string }

Champs
key	string
value	string

OutputVariableMappingEntry

Représentation JSON
{ "key": string, "value": string }

Champs
key	string
value	string

Rappel

Représentation JSON
{ "description": string, "disabled": boolean, "proactiveExecutionEnabled": boolean, // Union field callback can be only one of the following: "pythonCode": string // End of list of possible types for union field callback. }

Champs
description	string Facultatif. Description lisible du rappel.
disabled	boolean Facultatif. Indique si le rappel est désactivé. Les rappels désactivés sont ignorés par l'agent.
proactiveExecutionEnabled	boolean Facultatif. Si elle est activée, le rappel sera également exécuté sur les sorties de modèle intermédiaires. Ce paramètre ne s'applique qu'au rappel "Après le modèle". ACTIVEZ AVEC PRÉCAUTION. Le rappel "Après le modèle" ne doit généralement être exécuté qu'après avoir reçu toutes les réponses du modèle. L'activation de l'exécution proactive peut avoir des conséquences négatives sur le coût et la latence de l'exécution. Elle ne doit être activée que dans de rares cas.
Champ d'union callback. Rappel à exécuter. callback ne peut être qu'un des éléments suivants :
pythonCode	string Obligatoire. Code Python à exécuter pour le rappel.

AgentToolset

Représentation JSON
{ "toolset": string, "toolIds": [ string ] }

Champs
toolset	string Obligatoire. Nom de ressource de l'ensemble d'outils. Format : projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
toolIds[]	string Facultatif. ID des outils permettant de filtrer l'ensemble d'outils.

TransferRule

Représentation JSON
{ "childAgent": string, "direction": enum (Direction), // Union field rule_type can be only one of the following: "deterministicTransfer": { object (DeterministicTransfer) }, "disablePlannerTransfer": { object (DisablePlannerTransfer) } // End of list of possible types for union field rule_type. }

Champs
childAgent	string Obligatoire. Nom de ressource de l'agent enfant auquel s'applique la règle. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
direction	enum (Direction) Obligatoire. Sens du transfert.
Champ d'union rule_type. Type de règle. rule_type ne peut être qu'un des éléments suivants :
deterministicTransfer	object (DeterministicTransfer) Facultatif. Règle qui transfère immédiatement la demande à l'agent cible lorsque la condition est remplie.
disablePlannerTransfer	object (DisablePlannerTransfer) Facultatif. Règle qui empêche le planificateur d'être transféré à l'agent cible.

DeterministicTransfer

Représentation JSON
{ // Union field condition_type can be only one of the following: "expressionCondition": { object (ExpressionCondition) }, "pythonCodeCondition": { object (PythonCodeCondition) } // End of list of possible types for union field condition_type. }

Champs
Champ d'union condition_type. Condition à évaluer. condition_type ne peut être qu'un des éléments suivants :
expressionCondition	object (ExpressionCondition) Facultatif. Règle qui évalue une condition d'état de session. Si la condition renvoie la valeur "true", le transfert a lieu.
pythonCodeCondition	object (PythonCodeCondition) Facultatif. Une règle qui utilise un bloc de code Python pour évaluer les conditions. Si la condition renvoie la valeur "true", le transfert a lieu.

ExpressionCondition

Représentation JSON
{ "expression": string }

Champs
expression	string Obligatoire. Représentation sous forme de chaîne de la condition cloud.api.Expression.

PythonCodeCondition

Représentation JSON
{ "pythonCode": string }

Champs
pythonCode	string Obligatoire. Code Python à exécuter.

DisablePlannerTransfer

Représentation JSON
{ "expressionCondition": { object (ExpressionCondition) } }

Champs
expressionCondition	object (ExpressionCondition) Obligatoire. Si la condition renvoie "true", le planificateur ne sera pas autorisé à transférer la requête à l'agent cible.

Outil

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, basé sur 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 été modifié 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 OpenAPI.
googleSearchTool	object (GoogleSearchTool) Facultatif. Outil de recherche Google.
connectorTool	object (ConnectorTool) Facultatif. L'outil Integration Connectors.
dataStoreTool	object (DataStoreTool) Facultatif. Outil de data store.
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 d'agent.
widgetTool	object (WidgetTool) Facultatif. L'outil Widget.
remoteAgentTool	object (RemoteAgentTool) Facultatif. L'outil d'agent distant.

ClientFunction

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

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.

ApiAuthentication

Représentation JSON

{ // Union field auth_config can be only one of the following: "apiKeyConfig": { object (ApiKeyConfig) }, "oauthConfig": { object (OAuthConfig) }, "serviceAgentIdTokenAuthConfig": { object (ServiceAgentIdTokenAuthConfig) }, "serviceAccountAuthConfig": { object (ServiceAccountAuthConfig) }, "bearerTokenConfig": { object (BearerTokenConfig) } // End of list of possible types for union field auth_config. }

Champs
Champ d'union auth_config. Configuration de l'authentification. auth_config ne peut être qu'un des éléments suivants :
apiKeyConfig	object (ApiKeyConfig) Facultatif. Configuration pour l'authentification par clé API.
oauthConfig	object (OAuthConfig) Facultatif. Configuration pour OAuth.
serviceAgentIdTokenAuthConfig	object (ServiceAgentIdTokenAuthConfig) Facultatif. Configuration pour l'authentification par jeton d'identification générée à partir de l'agent de service CES.
serviceAccountAuthConfig	object (ServiceAccountAuthConfig) Facultatif. Configuration pour l'authentification du compte de service.
bearerTokenConfig	object (BearerTokenConfig) Facultatif. Configuration pour l'authentification par jeton du porteur.

ApiKeyConfig

Représentation JSON
{ "keyName": string, "apiKeySecretVersion": string, "requestLocation": enum (RequestLocation) }

Champs
keyName	string Obligatoire. Nom du paramètre ou de l'en-tête de la clé API. Exemple : Si la requête API est "https://example.com/act?X-Api-Key=", "X-Api-Key" est le nom du paramètre.
apiKeySecretVersion	string Obligatoire. Nom de la ressource de version secrète Secret Manager stockant la clé API. Format : projects/{project}/secrets/{secret}/versions/{version} Remarque : Vous devez attribuer le rôle roles/secretmanager.secretAccessor à l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
requestLocation	enum (RequestLocation) Obligatoire. Emplacement de la clé dans la requête.

OAuthConfig

Représentation JSON
{ "oauthGrantType": enum (OauthGrantType), "clientId": string, "clientSecretVersion": string, "tokenEndpoint": string, "scopes": [ string ] }

Champs
oauthGrantType	enum (OauthGrantType) Obligatoire. Types d'attribution OAuth.
clientId	string Obligatoire. ID client du fournisseur OAuth.
clientSecretVersion	string Obligatoire. Nom de la ressource de version du secret Secret Manager stockant le code secret du client. Format : projects/{project}/secrets/{secret}/versions/{version} Remarque : Vous devez attribuer le rôle roles/secretmanager.secretAccessor à l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
tokenEndpoint	string Obligatoire. Point de terminaison du jeton dans le fournisseur OAuth à échanger contre un jeton d'accès.
scopes[]	string Facultatif. Champs d'application OAuth à accorder.

ServiceAccountAuthConfig

Représentation JSON
{ "serviceAccount": string, "scopes": [ string ] }

Champs
serviceAccount	string Obligatoire. Adresse e-mail du compte de service utilisé pour l'authentification. CES utilise ce compte de service pour échanger un jeton d'accès, qui est ensuite envoyé dans l'en-tête Authorization de la requête. Le compte de service doit disposer du rôle roles/iam.serviceAccountTokenCreator attribué à l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
scopes[]	string Facultatif. Champs d'application OAuth à accorder. Si aucune valeur n'est spécifiée, le champ d'application par défaut https://www.googleapis.com/auth/cloud-platform est utilisé.

BearerTokenConfig

Représentation JSON
{ "token": string }

Champs
token	string Obligatoire. Jeton de support. Il doit respecter le format $context.variables.<name_of_variable>.

TlsConfig

Représentation JSON
{ "caCerts": [ { object (CaCert) } ] }

Champs
caCerts[]	object (CaCert) Obligatoire. Indique une liste de certificats CA personnalisés autorisés pour la validation HTTPS.

CaCert

Représentation JSON
{ "displayName": string, "cert": string }

Champs
displayName	string Obligatoire. Nom des certificats CA personnalisés autorisés. Cela permet de lever toute ambiguïté concernant les certificats d'autorité de certification personnalisés.
cert	string (bytes format) Obligatoire. Certificats CA personnalisés autorisés (au format DER) pour la validation HTTPS. Cela remplace le magasin de confiance SSL par défaut. Si ce champ est vide ou n'est pas spécifié, CES utilisera le magasin de confiance par défaut de Google pour valider les certificats. Remarque : Assurez-vous que les certificats de serveur HTTPS sont signés avec "subject alt name". Par exemple, un certificat peut être autosigné à l'aide de la commande suivante : openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") Chaîne encodée en base64.

ServiceDirectoryConfig

Représentation JSON
{ "service": string }

Champs
service	string Obligatoire. Nom du service Annuaire des services. Format : projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. L'emplacement de l'annuaire des services doit être identique à celui de l'application.

GoogleSearchTool

Représentation JSON
{ "name": string, "description": string, "contextUrls": [ string ], "preferredDomains": [ string ], "excludeDomains": [ string ], "promptConfig": { object (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 récupéré directement à partir 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 (PromptConfig) Facultatif. Instructions transmises au planificateur sur la façon dont les résultats de recherche doivent être traités pour le texte et la voix.

PromptConfig

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 des interactions 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

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éterminer s'il doit appeler ConnectorTool.
description	string Facultatif. Description de l'outil que l'agent peut utiliser pour déterminer s'il doit appeler ConnectorTool.

Action

Représentation JSON
{ "inputFields": [ string ], "outputFields": [ string ], // Union field action_spec can be only one of the following: "connectionActionId": string, "entityOperation": { object (EntityOperation) } // End of list of possible types for union field action_spec. }

Champs
inputFields[]	string Facultatif. Champs d'entité à utiliser comme entrées pour l'opération. Si aucun champ n'est spécifié, tous les champs de l'entité seront utilisés.
outputFields[]	string Facultatif. Champs d'entité à renvoyer à partir de l'opération. Si aucun champ n'est spécifié, tous les champs de l'entité sont renvoyés.
Champ d'union action_spec. Spécification d'une action à configurer pour que l'outil l'utilise. action_spec ne peut être qu'un des éléments suivants :
connectionActionId	string ID d'une action de connexion que l'outil doit utiliser.
entityOperation	object (EntityOperation) Configuration de l'opération d'entité à utiliser par l'outil.

EntityOperation

Représentation JSON
{ "entityId": string, "operation": enum (OperationType) }

Champs
entityId	string Obligatoire. ID de l'entité.
operation	enum (OperationType) Obligatoire. Opération à effectuer sur l'entité.

EndUserAuthConfig

Représentation JSON
{ // Union field auth_config can be only one of the following: "oauth2AuthCodeConfig": { object (Oauth2AuthCodeConfig) }, "oauth2JwtBearerConfig": { object (Oauth2JwtBearerConfig) } // End of list of possible types for union field auth_config. }

Champs
Champ d'union auth_config. Configuration de l'authentification. auth_config ne peut être qu'un des éléments suivants :
oauth2AuthCodeConfig	object (Oauth2AuthCodeConfig) Authentification avec un code d'autorisation OAuth 2.0.
oauth2JwtBearerConfig	object (Oauth2JwtBearerConfig) Authentification par attribution d'autorisation OAuth 2.0 avec profil JWT.

Oauth2AuthCodeConfig

Représentation JSON
{ "oauthToken": string }

Champs
oauthToken	string Obligatoire. Nom du paramètre de jeton OAuth à transmettre. Il doit respecter le format $context.variables.<name_of_variable>.

Oauth2JwtBearerConfig

Représentation JSON
{ "issuer": string, "subject": string, "clientKey": string }

Champs
issuer	string Obligatoire. Nom du paramètre de l'émetteur à transmettre. Il doit respecter le format $context.variables.<name_of_variable>.
subject	string Obligatoire. Nom du paramètre de sujet à transmettre. Il doit respecter le format $context.variables.<name_of_variable>.
clientKey	string Obligatoire. Nom du paramètre client à transmettre. Il doit respecter le format $context.variables.<name_of_variable>.

DataStoreTool

Représentation JSON

{ "name": string, "description": string, "boostSpecs": [ { object (BoostSpecs) } ], "modalityConfigs": [ { object (ModalityConfig) } ], "filterParameterBehavior": enum (FilterParameterBehavior), // Union field search_source can be only one of the following: "dataStoreSource": { object (DataStoreSource) }, "engineSource": { object (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 (BoostSpecs) Facultatif. Booster les spécifications pour mettre en avant certains documents.
modalityConfigs[]	object (ModalityConfig) Facultatif. Configurations de modalités pour le data store.
filterParameterBehavior	enum (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 (DataStoreSource) Facultatif. Recherchez dans un seul DataStore spécifique.
engineSource	object (EngineSource) Facultatif. Rechercher dans un moteur (potentiellement dans plusieurs DataStores).

DataStoreSource

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

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

Champs
name	string Obligatoire. Nom complet de la ressource DataStore. Format : projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
type	enum (DataStoreType) Uniquement en sortie. Type du data store. Ce champ est en lecture seule et renseigné par le serveur.
documentProcessingMode	enum (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 (ConnectorConfig) Uniquement en sortie. Configuration du connecteur pour la connexion au data store.

ConnectorConfig

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.

EngineSource

Représentation JSON
{ "engine": string, "dataStoreSources": [ { object (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 (DataStoreSource) Facultatif. Utilisez-le pour cibler des DataStores spécifiques dans le moteur. Si ce champ est vide, la recherche s'applique à tous les DataStores associés au moteur.
filter	string Facultatif. Filtre appliqué à la recherche dans le moteur. Sans intérêt et non utilisé si "data_store_sources" est fourni. Consultez https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata.

BoostSpecs

Représentation JSON
{ "dataStores": [ string ], "spec": [ { object (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 (BoostSpec) Obligatoire. Liste des spécifications de boosting.

BoostSpec

Représentation JSON
{ "conditionBoostSpecs": [ { object (ConditionBoostSpec) } ] }

Champs
conditionBoostSpecs[]	object (ConditionBoostSpec) Obligatoire. Liste des spécifications de boosting.

ConditionBoostSpec

Représentation JSON
{ "condition": string, "boost": number, "boostControlSpec": { object (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. Actuellement, 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 (BoostControlSpec) Facultatif. Spécification complexe pour le classement personnalisé basé sur la valeur de l'attribut définie par le client.

BoostControlSpec

Représentation JSON
{ "fieldName": string, "attributeType": enum (AttributeType), "interpolationType": enum (InterpolationType), "controlPoints": [ { object (ControlPoint) } ] }

Champs
fieldName	string Facultatif. Nom du champ dont la valeur sera utilisée pour déterminer le montant du boost.
attributeType	enum (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 spécifié par field_name. Dans le cas d'une valeur numérique, c'est simple : attribute_value = numerical_field_value. Dans le cas de la fraîcheur, attribute_value = (time.now() - datetime_field_value).
interpolationType	enum (InterpolationType) Facultatif. Type d'interpolation à appliquer pour relier les points de contrôle listés ci-dessous.
controlPoints[]	object (ControlPoint) Facultatif. Points de contrôle utilisés pour définir la courbe. La fonction monotone (définie par le biais de l'interpolation_type ci-dessus) passe par les points de contrôle listés ici.

ControlPoint

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.

ModalityConfig

Représentation JSON
{ "modalityType": enum (ModalityType), "rewriterConfig": { object (RewriterConfig) }, "summarizationConfig": { object (SummarizationConfig) }, "groundingConfig": { object (GroundingConfig) }, "snippetsConfig": { object (SnippetsConfig) } }

Champs
modalityType	enum (ModalityType) Obligatoire. Type de modalité.
rewriterConfig	object (RewriterConfig) Facultatif. Configuration du réécriveur.
summarizationConfig	object (SummarizationConfig) Facultatif. Configuration de la synthèse.
groundingConfig	object (GroundingConfig) Facultatif. Configuration de l'ancrage.
snippetsConfig	object (SnippetsConfig) Facultatif. Configuration des extraits.

RewriterConfig

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

SummarizationConfig

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.

GroundingConfig

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 d'ancrage de la réponse. Cela signifie que toutes les réponses dont le score d'ancrage est inférieur au seuil seront remplacées par des extraits pertinents uniquement. 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é.

SnippetsConfig

Représentation JSON
{ "enableSnippets": boolean, "maxSnippets": integer }

Champs
enableSnippets	boolean Facultatif. Indique si les extraits sont activés.
maxSnippets	integer Facultatif. Nombre d'extraits à renvoyer par requête. Si elle n'est pas définie, renvoie tous les extraits du service par défaut.

PythonFunction

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

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 (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 à server_address 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 (State) Uniquement en sortie. État de disponibilité dynamique de l'outil sur le serveur externe.

CustomHeadersEntry

Représentation JSON
{ "key": string, "value": string }

Champs
key	string
value	string

FileSearchTool

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

Champs
corpusType	enum (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}

SystemTool

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ésentation JSON
{ "name": string, "description": string, "agent": string }

Champs
name	string Obligatoire. Nom de l'outil de l'agent.
description	string Facultatif. Description de l'objectif de l'outil.
agent	string Facultatif. Nom de ressource de l'agent qui est le point d'entrée de l'outil. Format : projects/{project}/locations/{location}/agents/{agent}

WidgetTool

Représentation JSON
{ "name": string, "description": string, "widgetType": enum (WidgetType), "uiConfig": { object }, "dataMapping": { object (DataMapping) }, "textResponseConfig": { object (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 (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 (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 (TextResponseConfig) Facultatif. Configuration pour les 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.

DataMapping

Représentation JSON
{ "sourceToolName": string, "fieldMappings": { string: string, ... }, "pythonFunction": { object (PythonFunction) }, "mode": enum (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 (Mode) Facultatif. Mode du mappage de données.
pythonScript (deprecated)	string Cet élément est obsolète. Obsolète : utilisez plutôt python_function.

FieldMappingsEntry

Représentation JSON
{ "key": string, "value": string }

Champs
key	string
value	string

TextResponseConfig

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

Champs
type	enum (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.

RemoteAgentTool

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

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.
apiAuthentication	object (ApiAuthentication) Facultatif. Configuration de l'authentification pour appeler l'agent distant.

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

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

Champs
url	string Obligatoire. URL où cette interface est disponible. Vous devez saisir 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é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 compétence.
examples[]	string Exemples de requêtes ou de scénarios que cette compétence peut traiter.
inputModes[]	string Ensemble de types de supports d'entrée acceptés pour cette compétence, qui remplace les valeurs par défaut de l'agent.
outputModes[]	string Ensemble de types de supports de sortie acceptés pour cette compétence, qui remplace les valeurs par défaut de l'agent.

ToolFakeConfig

Représentation JSON
{ "enableFakeMode": boolean, // Union field tool_response can be only one of the following: "codeBlock": { object (CodeBlock) } // End of list of possible types for union field tool_response. }

Champs
enableFakeMode	boolean Facultatif. Indique si l'outil utilise le mode factice.
Champ d'union tool_response. La réponse est statique ou fournie par une fonction Python. tool_response ne peut être qu'un des éléments suivants :
codeBlock	object (CodeBlock) Facultatif. Bloc de code qui sera exécuté à la place d'un véritable appel d'outil.

CodeBlock

Représentation JSON
{ "pythonCode": string }

Champs

pythonCode

string Obligatoire. Code Python qui sera appelé en mode faux outil. Signature de la fonction Python attendue : pour intercepter tous les appels d'outil : def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: pour intercepter un appel d'outil spécifique : def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: si la fonction renvoie "None", le véritable outil sera appelé à la place.

Exemple

Représentation JSON
{ "name": string, "displayName": string, "description": string, "entryAgent": string, "messages": [ { object (Message) } ], "createTime": string, "updateTime": string, "invalid": boolean, "etag": string }

Champs
name	string Identifiant. Identifiant unique de l'exemple. Format : projects/{project}/locations/{location}/apps/{app}/examples/{example}
displayName	string Obligatoire. Nom à afficher de l'exemple.
description	string Facultatif. Description de l'exemple dans un format lisible.
entryAgent	string Facultatif. Agent qui gère initialement la conversation. Si aucune valeur n'est spécifiée, l'exemple représente une conversation gérée par l'agent racine. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
messages[]	object (Message) Facultatif. Ensemble des messages qui composent la conversation.
createTime	string (Timestamp format) Uniquement en sortie. Code temporel de la création de l'exemple. 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'exemple. 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".
invalid	boolean Uniquement en sortie. L'exemple peut devenir non valide si les ressources référencées sont supprimées. Les exemples non valides ne seront pas utilisés comme exemples few-shot.
etag	string Etag utilisé pour s'assurer que l'objet n'a pas été modifié lors d'une opération de lecture/modification/écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.

Message

Représentation JSON
{ "role": string, "chunks": [ { object (Chunk) } ], "eventTime": string }

Champs
role	string Facultatif. Rôle dans la conversation (utilisateur, agent, etc.).
chunks[]	object (Chunk) Facultatif. Contenu du message sous forme de série de blocs.
eventTime	string (Timestamp format) Facultatif. Code temporel de l'envoi ou de la réception du message. Ne doit pas être utilisé si le message fait partie d'un example. 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".

Bloc

Représentation JSON

{ // Union field data can be only one of the following: "text": string, "transcript": string, "blob": { object (Blob) }, "payload": { object }, "image": { object (Image) }, "toolCall": { object (ToolCall) }, "toolResponse": { object (ToolResponse) }, "agentTransfer": { object (AgentTransfer) }, "updatedVariables": { object }, "defaultVariables": { object } // End of list of possible types for union field data. }

Champs
Champ d'union data. Regroupez les données. data ne peut être qu'un des éléments suivants :
text	string Facultatif. Données textuelles.
transcript	string Facultatif. Transcription associée à l'élément audio.
blob	object (Blob) Facultatif. Données blob.
payload	object (Struct format) Facultatif. Données de charge utile personnalisées.
image	object (Image) Facultatif. Données d'image.
toolCall	object (ToolCall) Facultatif. Requête d'exécution d'outil.
toolResponse	object (ToolResponse) Facultatif. Réponse à l'exécution de l'outil.
agentTransfer	object (AgentTransfer) Facultatif. Événement de transfert d'agent.
updatedVariables	object (Struct format) Une structure représente les variables qui ont été mises à jour dans la conversation, avec les noms de variables comme clés.
defaultVariables	object (Struct format) Une structure représente les variables par défaut au début de la conversation, avec les noms de variables comme clés.

Blob

Représentation JSON
{ "mimeType": string, "data": string }

Champs
mimeType	string Obligatoire. Type MIME standard IANA des données sources.
data	string (bytes format) Obligatoire. Octets bruts du blob. Chaîne encodée en base64.

Image

Représentation JSON
{ "mimeType": string, "data": string }

Champs
mimeType	string Obligatoire. Type MIME standard IANA des données sources. Les types d'images acceptés sont les suivants : * image/png * image/jpeg * image/webp
data	string (bytes format) Obligatoire. Octets bruts de l'image. Chaîne encodée en base64.

ToolCall

Représentation JSON
{ "id": string, "displayName": string, "args": { object }, "parentToolCallId": string, "agentName": string, // Union field tool_identifier can be only one of the following: "tool": string, "toolsetTool": { object (ToolsetTool) } // End of list of possible types for union field tool_identifier. }

Champs
id	string Facultatif. Identifiant unique de l'appel d'outil. Si cette valeur est renseignée, le client doit renvoyer le résultat de l'exécution avec l'identifiant de mise en correspondance dans ToolResponse.
displayName	string Uniquement en sortie. Nom à afficher de l'outil.
args	object (Struct format) Facultatif. Paramètres et valeurs d'entrée de l'outil au format d'objet JSON.
parentToolCallId	string Uniquement en sortie. ID de l'appel d'outil qui a déclenché celui-ci, lorsqu'il a été émis par un sous-agent travaillant pour le compte d'un appel parent. Vide pour les appels de premier niveau. Permet à un client de regrouper le travail d'un sous-agent sous l'appel qui l'a déclenché au lieu de rendre chaque étape en tant que frère.
agentName	string Uniquement en sortie. Nom lisible de l'agent qui a émis cet appel, par exemple "Architecte de contrat". Vide lorsque l'agent racine l'a émis.
Champ d'union tool_identifier. Identifiant de l'outil à exécuter. Il peut s'agir d'un outil persistant ou d'un outil d'un ensemble d'outils. tool_identifier ne peut être qu'un des éléments suivants :
tool	string Facultatif. Nom de l'outil à exécuter. Format : projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool	object (ToolsetTool) Facultatif. Outil de l'ensemble d'outils à exécuter.

ToolsetTool

Représentation JSON
{ "toolset": string, "toolId": string }

Champs
toolset	string Obligatoire. Nom de ressource de l'ensemble d'outils à partir duquel cet outil est dérivé. Format : projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
toolId	string Facultatif. ID de l'outil permettant de filtrer les outils pour récupérer le schéma.

ToolResponse

Représentation JSON
{ "id": string, "displayName": string, "response": { object }, "parentToolCallId": string, "agentName": string, // Union field tool_identifier can be only one of the following: "tool": string, "toolsetTool": { object (ToolsetTool) } // End of list of possible types for union field tool_identifier. }

Champs
id	string Facultatif. ID correspondant du tool call auquel la réponse se rapporte.
displayName	string Uniquement en sortie. Nom à afficher de l'outil.
response	object (Struct format) Obligatoire. Résultat de l'exécution de l'outil au format d'objet JSON. Utilisez la clé "output" pour spécifier la réponse de l'outil et la clé "error" pour spécifier les détails de l'erreur (le cas échéant). Si les clés "output" et "error" ne sont pas spécifiées, l'ensemble de la "response" est traité comme le résultat de l'exécution de l'outil.
parentToolCallId	string Uniquement en sortie. ID de l'appel d'outil qui a déclenché celui-ci, lorsqu'il a été émis par un sous-agent travaillant pour le compte d'un appel parent. Vide pour les appels de premier niveau. Permet à un client de regrouper le travail d'un sous-agent sous l'appel qui l'a déclenché au lieu de rendre chaque étape en tant que frère.
agentName	string Uniquement en sortie. Nom lisible de l'agent qui a émis cet appel, par exemple "Architecte de contrat". Vide lorsque l'agent racine l'a émis.
Champ d'union tool_identifier. Identifiant de l'outil qui a été exécuté. Il peut s'agir d'un outil persistant ou d'un outil d'un ensemble d'outils. tool_identifier ne peut être qu'un des éléments suivants :
tool	string Facultatif. Nom de l'outil à exécuter. Format : projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool	object (ToolsetTool) Facultatif. Outil de l'ensemble d'outils qui a été exécuté.

AgentTransfer

Représentation JSON
{ "targetAgent": string, "displayName": string }

Champs
targetAgent	string Obligatoire. Agent auquel la conversation est transférée. L'agent prendra le relais à partir de ce moment. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
displayName	string Uniquement en sortie. Nom à afficher de l'agent.

Garde-fou

Représentation JSON

{ "name": string, "displayName": string, "description": string, "enabled": boolean, "action": { object (TriggerAction) }, "createTime": string, "updateTime": string, "etag": string, // Union field guardrail_type can be only one of the following: "contentFilter": { object (ContentFilter) }, "llmPromptSecurity": { object (LlmPromptSecurity) }, "llmPolicy": { object (LlmPolicy) }, "modelSafety": { object (ModelSafety) }, "codeCallback": { object (CodeCallback) } // End of list of possible types for union field guardrail_type. }

Champs
name	string Identifiant. Identifiant unique du garde-fou. Format : projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
displayName	string Obligatoire. Nom à afficher de la barrière de sécurité.
description	string Facultatif. Description du garde-fou.
enabled	boolean Facultatif. Indique si le garde-fou est activé.
action	object (TriggerAction) Facultatif. Action à effectuer lorsque le garde-fou est déclenché.
createTime	string (Timestamp format) Uniquement en sortie. Code temporel de la création du garde-fou. 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 du garde-fou. 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 été modifié lors d'une opération de lecture/modification/écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.
Champ d'union guardrail_type. Type de garde-fou. guardrail_type ne peut être qu'un des éléments suivants :
contentFilter	object (ContentFilter) Facultatif. Garde-fou qui interdit l'utilisation de certains contenus dans la conversation.
llmPromptSecurity	object (LlmPromptSecurity) Facultatif. Garde-fou qui bloque la conversation si la requête est considérée comme non sécurisée en fonction de la classification du LLM.
llmPolicy	object (LlmPolicy) Facultatif. Garde-fou qui bloque la conversation si la réponse du LLM est considérée comme enfreignant le règlement en fonction de la classification du LLM.
modelSafety	object (ModelSafety) Facultatif. Garde-fou qui bloque la conversation si la réponse du LLM est considérée comme non sécurisée en fonction des paramètres de sécurité du modèle.
codeCallback	object (CodeCallback) Facultatif. Garde-fou qui bloque potentiellement la conversation en fonction du résultat de l'exécution du rappel.

ContentFilter

Représentation JSON
{ "bannedContents": [ string ], "bannedContentsInUserInput": [ string ], "bannedContentsInAgentResponse": [ string ], "matchType": enum (MatchType), "disregardDiacritics": boolean }

Champs
bannedContents[]	string Facultatif. Liste des expressions interdites. S'applique aux entrées utilisateur et aux réponses de l'agent.
bannedContentsInUserInput[]	string Facultatif. Liste des expressions interdites. Ne s'applique qu'aux entrées utilisateur.
bannedContentsInAgentResponse[]	string Facultatif. Liste des expressions interdites. Ne s'applique qu'aux réponses des agents.
matchType	enum (MatchType) Obligatoire. Type de correspondance pour le filtre de contenu.
disregardDiacritics	boolean Facultatif. Si la valeur est "true", les signes diacritiques sont ignorés lors de la mise en correspondance.

LlmPromptSecurity

Représentation JSON
{ "failOpen": boolean, // Union field security_config can be only one of the following: "defaultSettings": { object (DefaultSecuritySettings) }, "customPolicy": { object (LlmPolicy) } // End of list of possible types for union field security_config. }

Champs
failOpen	boolean Facultatif. Détermine le comportement lorsque le garde-fou rencontre une erreur LLM. - Si la valeur est "true", le garde-fou est contourné. - Si la valeur est "false" (par défaut), la barrière de sécurité se déclenche/bloque. Remarque : Si une règle personnalisée est fournie, ce champ est ignoré au profit de la configuration "fail_open" de la règle.
Champ d'union security_config. Définit le mode de configuration de la sécurité. L'utilisateur doit choisir l'une des configurations suivantes. security_config ne peut être qu'un des éléments suivants :
defaultSettings	object (DefaultSecuritySettings) Facultatif. Utilisez les paramètres de sécurité par défaut prédéfinis du système. Pour sélectionner ce mode, incluez un message "default_settings" vide dans la requête. Le champ "default_prompt_template" sera renseigné par le serveur dans la réponse.
customPolicy	object (LlmPolicy) Facultatif. Utilisez une LlmPolicy définie par l'utilisateur pour configurer le garde-fou de sécurité.

DefaultSecuritySettings

Représentation JSON
{ "defaultPromptTemplate": string }

Champs
defaultPromptTemplate	string Uniquement en sortie. Modèle de prompt par défaut utilisé par le système. Ce champ est destiné à afficher l'invite que le système utilise par défaut. OUTPUT_ONLY.

LlmPolicy

Représentation JSON
{ "maxConversationMessages": integer, "modelSettings": { object (ModelSettings) }, "prompt": string, "policyScope": enum (PolicyScope), "failOpen": boolean, "allowShortUtterance": boolean }

Champs
maxConversationMessages	integer Facultatif. Lorsque vous vérifiez cette règle, tenez compte des "n" derniers messages de la conversation. Si aucune valeur n'est définie, la valeur par défaut de 10 sera utilisée.
modelSettings	object (ModelSettings) Facultatif. Paramètres du modèle.
prompt	string Obligatoire. Invite concernant les règles.
policyScope	enum (PolicyScope) Obligatoire. Définit le moment où la vérification des règles doit être appliquée pendant la conversation. Si elle est définie sur POLICY_SCOPE_UNSPECIFIED, la règle s'applique à l'entrée utilisateur. Lorsque vous appliquez la règle à la réponse de l'agent, une latence supplémentaire est introduite avant que l'agent puisse répondre.
failOpen	boolean Facultatif. Si une erreur se produit lors de la vérification des règles, ouvrez le système et ne déclenchez pas le garde-fou.
allowShortUtterance	boolean Facultatif. Par défaut, la vérification des règles LLM est ignorée pour les énoncés courts. Si vous activez ce paramètre, la vérification des règles s'applique à toutes les expressions, y compris celles qui seraient normalement ignorées.

ModelSafety

Représentation JSON
{ "safetySettings": [ { object (SafetySetting) } ] }

Champs
safetySettings[]	object (SafetySetting) Obligatoire. Liste des paramètres de sécurité.

SafetySetting

Représentation JSON
{ "category": enum (HarmCategory), "threshold": enum (HarmBlockThreshold) }

Champs
category	enum (HarmCategory) Obligatoire. Catégorie de préjudice.
threshold	enum (HarmBlockThreshold) Obligatoire. Seuil de blocage de préjudice.

CodeCallback

Représentation JSON
{ "beforeAgentCallback": { object (Callback) }, "afterAgentCallback": { object (Callback) }, "beforeModelCallback": { object (Callback) }, "afterModelCallback": { object (Callback) } }

Champs
beforeAgentCallback	object (Callback) Facultatif. Rappel à exécuter avant l'appel de l'agent. Chaque fonction de rappel doit renvoyer une structure (par exemple, un dict ou un objet) contenant au moins : - "decision" : "OK" ou "TRIGGER". - "reason" : chaîne expliquant la décision. Une décision "DÉCLENCHEMENT" peut interrompre le traitement.
afterAgentCallback	object (Callback) Facultatif. Rappel à exécuter après l'appel de l'agent. Chaque fonction de rappel doit renvoyer une structure (par exemple, un dict ou un objet) contenant au moins : - "decision" : "OK" ou "TRIGGER". - "reason" : chaîne expliquant la décision. Une décision "DÉCLENCHEMENT" peut interrompre le traitement.
beforeModelCallback	object (Callback) Facultatif. Rappel à exécuter avant l'appel du modèle. Si le modèle est appelé plusieurs fois, le rappel sera exécuté plusieurs fois. Chaque fonction de rappel doit renvoyer une structure (par exemple, un dict ou un objet) contenant au moins : - "decision" : "OK" ou "TRIGGER". - "reason" : chaîne expliquant la décision. Une décision "DÉCLENCHEMENT" peut interrompre le traitement.
afterModelCallback	object (Callback) Facultatif. Rappel à exécuter après l'appel du modèle. Si le modèle est appelé plusieurs fois, le rappel sera exécuté plusieurs fois. Chaque fonction de rappel doit renvoyer une structure (par exemple, un dict ou un objet) contenant au moins : - "decision" : "OK" ou "TRIGGER". - "reason" : chaîne expliquant la décision. Une décision "DÉCLENCHEMENT" peut interrompre le traitement.

TriggerAction

Représentation JSON
{ // Union field action can be only one of the following: "respondImmediately": { object (RespondImmediately) }, "transferAgent": { object (TransferAgent) }, "generativeAnswer": { object (GenerativeAnswer) } // End of list of possible types for union field action. }

Champs
Champ d'union action. Action à effectuer. action ne peut être qu'un des éléments suivants :
respondImmediately	object (RespondImmediately) Facultatif. Répondez immédiatement avec une réponse préconfigurée.
transferAgent	object (TransferAgent) Facultatif. transférer la conversation à un autre agent ;
generativeAnswer	object (GenerativeAnswer) Facultatif. Répondez avec une réponse générative.

RespondImmediately

Représentation JSON
{ "responses": [ { object (Response) } ] }

Champs
responses[]	object (Response) Obligatoire. Réponses standardisées parmi lesquelles l'agent peut choisir. La réponse est choisie au hasard.

Réponse

Représentation JSON
{ "text": string, "disabled": boolean }

Champs
text	string Obligatoire. Texte auquel l'agent doit répondre.
disabled	boolean Facultatif. Indique si la réponse est désactivée. L'agent n'utilise pas les réponses désactivées.

TransferAgent

Représentation JSON
{ "agent": string }

Champs
agent	string Obligatoire. Nom de l'agent vers lequel transférer la conversation. L'agent doit se trouver dans la même application que l'agent actuel. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}

GenerativeAnswer

Représentation JSON
{ "prompt": string }

Champs
prompt	string Obligatoire. Requête à utiliser pour la réponse générative.

Ensemble d'outils

Représentation JSON

{ "name": string, "displayName": string, "description": string, "timeout": string, "createTime": string, "updateTime": string, "etag": string, "executionType": enum (ExecutionType), "toolFakeConfig": { object (ToolFakeConfig) }, // Union field toolset_type can be only one of the following: "mcpToolset": { object (McpToolset) }, "openApiToolset": { object (OpenApiToolset) }, "connectorToolset": { object (ConnectorToolset) } // End of list of possible types for union field toolset_type. }

Champs
name	string Identifiant. Identifiant unique de l'ensemble d'outils. Format : projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
displayName	string Facultatif. Nom à afficher de l'ensemble d'outils. Doit être unique dans la même application.
description	string Facultatif. Description de l'ensemble d'outils.
timeout	string (Duration format) Facultatif. Délai d'exécution de l'ensemble d'outils. Si ce paramètre n'est pas défini, le délai d'inactivité par défaut est de 30 secondes pour les ensembles d'outils SYNCHRONOUS et de 60 secondes pour les ensembles d'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'ensemble d'outils. 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'ensemble d'outils. 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 été modifié lors d'une opération de lecture/modification/écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.
executionType	enum (ExecutionType) Facultatif. Type d'exécution des outils dans l'ensemble d'outils.
toolFakeConfig	object (ToolFakeConfig) Facultatif. Configuration du comportement des outils en mode simulation.
Champ d'union toolset_type. Type de l'ensemble d'outils. toolset_type ne peut être qu'un des éléments suivants :
mcpToolset	object (McpToolset) Facultatif. Ensemble d'outils contenant une liste d'outils proposés par le serveur MCP.
openApiToolset	object (OpenApiToolset) Facultatif. Ensemble d'outils contenant une liste d'outils définis par un schéma OpenAPI.
connectorToolset	object (ConnectorToolset) Facultatif. Ensemble d'outils qui génère des outils à partir d'une connexion Integration Connectors.

McpToolset

Représentation JSON
{ "serverAddress": string, "apiAuthentication": { object (ApiAuthentication) }, "serviceDirectoryConfig": { object (ServiceDirectoryConfig) }, "tlsConfig": { object (TlsConfig) }, "customHeaders": { string: string, ... }, "toolOverrides": [ { object (McpToolOverride) } ] }

Champs
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. 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 accéder aux outils et exécuter un 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.
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.
tlsConfig	object (TlsConfig) Facultatif. Configuration TLS. Inclut les certificats de serveur personnalisés auxquels le client doit faire confiance.
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" }.
toolOverrides[]	object (McpToolOverride) Facultatif. Remplacements pour les outils individuels de cet ensemble d'outils. Cela permet de remplacer des détails spécifiques tels que les descriptions ou les noms, ou d'épingler les états des outils afin qu'ils ne soient pas entièrement dynamiques.

CustomHeadersEntry

Représentation JSON
{ "key": string, "value": string }

Champs
key	string
value	string

McpToolOverride

Représentation JSON
{ "tool": string, "nameOverride": string, "descriptionOverride": string, "snapshot": { object (McpToolDefinition) } }

Champs
tool	string Obligatoire. Nom d'origine de l'outil tel qu'il est émis par le serveur MCP.
nameOverride	string Facultatif. Si ce nom est présent, l'outil l'utilise dans l'agent au lieu du nom d'origine. Il est principalement utilisé comme alias si le serveur MCP propose des outils mal nommés.
descriptionOverride	string Facultatif. Si elle est présente, cet outil utilise cette description au lieu de la description d'origine du serveur.
snapshot	object (McpToolDefinition) Uniquement en sortie. Si cet outil est présent, il est "épinglé" et utilise les valeurs du snapshot comme valeurs de remplacement si le serveur devient temporairement indisponible ou si aucun remplacement n'est présent.

McpToolDefinition

Représentation JSON
{ "description": string, "inputSchema": { object (Schema) }, "outputSchema": { object (Schema) } }

Champs
description	string Uniquement en sortie. Description de l'outil MCP. Cette valeur peut être remplacée par description_override dans McpToolOverride.
inputSchema	object (Schema) Uniquement en sortie. Schéma des arguments d'entrée de l'outil MCP.
outputSchema	object (Schema) Uniquement en sortie. Schéma des arguments de sortie de l'outil MCP.

OpenApiToolset

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

Champs
openApiSchema	string Obligatoire. Schéma OpenAPI de l'ensemble d'outils.
apiAuthentication	object (ApiAuthentication) Facultatif. Informations d'authentification requises par l'API.
tlsConfig	object (TlsConfig) Facultatif. Configuration TLS. Inclut les certificats de serveur personnalisés
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 pour toutes les opérations définies dans le schéma OpenAPI.
url	string Facultatif. URL du serveur du schéma Open API. Ce champ n'est défini dans les ensembles d'outils que dans les dépendances d'environnement lors du processus d'exportation 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.

ConnectorToolset

Représentation JSON
{ "connection": string, "authConfig": { object (EndUserAuthConfig) }, "connectorActions": [ { object (Action) } ] }

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}
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 l'ensemble d'outils échouera. Consultez https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override.
connectorActions[]	object (Action) Obligatoire. Liste des actions de connecteur/opérations d'entité pour lesquelles générer des outils.

PrebuiltAmbientNoise

Bruit ambiant prédéfini.

Enums
PREBUILT_AMBIENT_NOISE_UNSPECIFIED	Non spécifié.
RETAIL_STORE	Bruit ambiant d'un magasin.
CONVENTION_HALL	Bruit ambiant d'une salle de congrès.
OUTDOOR	Bruit ambiant d'une rue.

ErrorHandlingStrategy

Définit la stratégie de gestion des erreurs.

Enums
ERROR_HANDLING_STRATEGY_UNSPECIFIED	Stratégie de gestion des exceptions non spécifiée.
NONE	Aucune gestion spécifique n'est activée.
FALLBACK_RESPONSE	Un message de secours sera renvoyé à l'utilisateur en cas d'erreur système (par exemple, erreur de LLM).
END_SESSION	Un signal EndSession sera émis en cas d'erreur système (par exemple, erreur LLM).

ToolExecutionMode

Définit le comportement d'exécution de l'outil si l'agent sélectionne plusieurs outils en même temps.

Enums
TOOL_EXECUTION_MODE_UNSPECIFIED	Mode d'exécution de l'outil non spécifié. La valeur par défaut est "PARALLEL".
PARALLEL	Si plusieurs outils sont sélectionnés, ils seront exécutés en parallèle, avec le même ToolContext.
SEQUENTIAL	Si plusieurs outils sont sélectionnés, ils seront exécutés séquentiellement. L'outil suivant ne sera exécuté qu'une fois l'outil précédent terminé et pourra voir le ToolContext mis à jour de l'outil précédent.

SemanticSimilarityChannel

Canal de similarité sémantique à utiliser.

Enums
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED	Métrique non spécifiée. La valeur par défaut est TEXT.
TEXT	Utilisez la similarité sémantique du texte.
AUDIO	Utilisez la similarité sémantique audio.

ExtraToolCallBehavior

Définit le comportement lorsqu'un appel d'outil supplémentaire est rencontré. Un appel d'outil supplémentaire est un appel d'outil présent dans l'exécution, mais qui ne correspond à aucun appel d'outil dans l'attente de référence.

Enums
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED	Comportement non spécifié. La valeur par défaut est "FAIL".
FAIL	Échoue l'évaluation si un appel d'outil supplémentaire est rencontré.
ALLOW	Autorisez l'appel d'outil supplémentaire.

HallucinationMetricBehavior

Comportement de la métrique d'hallucination. Quel que soit le comportement, la métrique sera toujours calculée. La différence est que, lorsqu'elle est désactivée, la métrique n'est pas utilisée pour calculer le score d'évaluation global.

Enums
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED	Comportement non spécifié de la métrique d'hallucination.
DISABLED	Désactivez la métrique d'hallucination.
ENABLED	Activez la métrique d'hallucination.

Type

Types de données OpenAPI.

Enums
TYPE_UNSPECIFIED	Type non spécifié
STRING	Type de chaîne.
INTEGER	Type entier.
NUMBER	Type de nombre.
BOOLEAN	Type booléen.
OBJECT	Type d'objet.
ARRAY	Type de tableau.

NullValue

Représente un null JSON.

NullValue est une sentinelle qui utilise une énumération avec une seule valeur pour représenter la valeur nulle de l'union de type Value.

Un champ de type NullValue avec une valeur autre que 0 est considéré comme non valide. La plupart des sérialiseurs ProtoJSON émettent un Value avec un null_value défini comme null JSON, quelle que soit la valeur entière, et effectuent donc un aller-retour vers une valeur 0.

Enums
NULL_VALUE	Valeur nulle.

Type

Type de moteur. Consultez la documentation disponible sur https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType et https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

Enums
TYPE_UNSPECIFIED	Type de moteur non spécifié.
ENGINE_TYPE_SEARCH	Moteur SOLUTION_TYPE_SEARCH pour l'application. Tous les datastores de connecteurs ajoutés à l'application seront ajoutés à ce moteur.
ENGINE_TYPE_CHAT	Type de moteur de chat. Moteur SOLUTION_TYPE_CHAT pour l'application. Tous les data stores de connecteurs ajoutés à l'application seront ajoutés à ce moteur.

ChannelType

Type de profil de chaîne.

Enums
UNKNOWN	Type de canal inconnu.
WEB_UI	Canal de l'UI Web.
API	Canal API.
TWILIO	Canal Twilio.
GOOGLE_TELEPHONY_PLATFORM	Chaîne de la plate-forme de téléphonie Google.
CONTACT_CENTER_AS_A_SERVICE	Canal Contact Center as a Service (CCaaS).
CONTACT_CENTER_AS_A_SERVICE_CHAT	Canal Contact Center as a Service (CCaaS Chat).
FIVE9	Canal Five9.
CONTACT_CENTER_INTEGRATION	Canal d'intégration de centre de contact tiers.
WHATSAPP	Canal WhatsApp.
INSTAGRAM	Canal Instagram.

Persona

Personnalité de la chaîne.

Enums
UNKNOWN	Persona UNKNOWN.
CONCISE	L'agent fournit des réponses concises et précises.
CHATTY	L'agent fournit du contexte, des explications et des détails supplémentaires.

Modalité

Modalité du widget Web.

Enums
MODALITY_UNSPECIFIED	Modalité inconnue.
CHAT_AND_VOICE	Le widget est compatible avec la saisie par chat et vocale.
VOICE_ONLY	Le widget n'accepte que la saisie vocale.
CHAT_ONLY	Le widget n'accepte que les entrées de chat.
CHAT_VOICE_AND_VIDEO	Le widget accepte les entrées de chat, vocales et vidéo.

Thème

Thème du widget Web.

Enums
THEME_UNSPECIFIED	Thème inconnu.
LIGHT	Thème clair.
DARK	le thème sombre.

Direction

Sens du transfert.

Enums
DIRECTION_UNSPECIFIED	Direction non spécifiée.
PARENT_TO_CHILD	Transférez l'agent parent vers l'agent enfant.
CHILD_TO_PARENT	Transférez l'agent enfant vers l'agent parent.

RequestLocation

l'emplacement de la clé API dans la requête ;

Enums
REQUEST_LOCATION_UNSPECIFIED	Non spécifié. Cette valeur ne doit pas être utilisée.
HEADER	Représente la clé dans l'en-tête HTTP.
QUERY_STRING	Représente la clé dans la chaîne de requête.

OauthGrantType

Types d'attribution OAuth. Seule l'attribution d'identifiants client est acceptée.

Enums
OAUTH_GRANT_TYPE_UNSPECIFIED	Non spécifié. La valeur par défaut est CLIENT_CREDENTIAL.
CLIENT_CREDENTIAL	Représente le flux d'identifiants client.

OperationType

Opération à effectuer sur l'entité.

Enums
OPERATION_TYPE_UNSPECIFIED	Type d'opération non spécifié. Non valide. La création ou la mise à jour de ConnectorTool échouera.
LIST	Opération de liste.
GET	Obtenir une opération.
CREATE	Opération de création.
UPDATE	Opération de mise à jour.
DELETE	Supprimer une opération.

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

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.

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 sera la valeur réelle du champ numérique pour lequel boost_amount 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 indiqué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.

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.

ModalityType

Type de modalité.

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

FilterParameterBehavior

Comportement des paramètres de filtre.

Enums
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED	Comportement par défaut du filtre. Incluez le paramètre de filtre pour les data stores du connecteur. Pour les autres types de magasins de données, le paramètre d'entrée du filtre est omis.
ALWAYS_INCLUDE	Incluez toujours un 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.

État

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 sur le serveur.

CorpusType

Type de 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.

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_CAROUSEL	Widget de carrousel de produits.
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 avancées 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 de rendez-vous.
CONTACT_FORM	Widget de formulaire de contact.

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 field_mappings pour transformer les données.
PYTHON_SCRIPT	Utilisez python_script pour transformer les données.

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.

ExecutionType

Type d'exécution de l'outil ou de l'ensemble d'outils.

Enums
EXECUTION_TYPE_UNSPECIFIED	Le type d'exécution n'est pas spécifié. Prend la valeur SYNCHRONOUS par défaut s'il n'est pas spécifié.
SYNCHRONOUS	L'outil est exécuté de manière synchrone. La session est bloquée jusqu'à ce que l'outil renvoie une réponse.
ASYNCHRONOUS	L'outil est exécuté de manière asynchrone. La session se poursuivra pendant l'exécution de l'outil.

MatchType

Type de correspondance pour le filtre de contenu.

Enums
MATCH_TYPE_UNSPECIFIED	Le type de correspondance n'est pas spécifié.
SIMPLE_STRING_MATCH	Le contenu est mis en correspondance pour les sous-chaînes caractère par caractère.
WORD_BOUNDARY_STRING_MATCH	Le contenu ne correspond que si le motif trouvé dans le texte est entouré de délimiteurs de mots. Les expressions interdites peuvent également contenir des délimiteurs de mots.
REGEXP_MATCH	Le contenu est mis en correspondance à l'aide de la syntaxe d'expression régulière.

PolicyScope

Définit le moment où la vérification des règles doit être appliquée pendant la conversation.

Enums
POLICY_SCOPE_UNSPECIFIED	Le champ d'application de la règle n'est pas spécifié.
USER_QUERY	La vérification des règles est déclenchée par l'entrée utilisateur.
AGENT_RESPONSE	La vérification des règles est déclenchée par la réponse de l'agent. L'application de ce champ d'application de la règle entraînera une latence supplémentaire avant que l'agent puisse répondre.
USER_QUERY_AND_AGENT_RESPONSE	La vérification des règles est déclenchée à la fois par les entrées utilisateur et par les réponses de l'agent. L'application de ce champ d'application de la règle entraînera une latence supplémentaire avant que l'agent puisse répondre.

HarmCategory

Catégorie de préjudice.

Enums
HARM_CATEGORY_UNSPECIFIED	La catégorie de préjudice n'est pas spécifiée.
HARM_CATEGORY_HATE_SPEECH	La catégorie de préjudice est "incitation à la haine".
HARM_CATEGORY_DANGEROUS_CONTENT	La catégorie de préjudice est "contenu dangereux".
HARM_CATEGORY_HARASSMENT	La catégorie de préjudice est "harcèlement".
HARM_CATEGORY_SEXUALLY_EXPLICIT	La catégorie de préjudice est "contenu à caractère sexuel explicite".
HARM_CATEGORY_PROFANITY	La catégorie de préjudice est "propos obscènes".
HARM_CATEGORY_TOXIC	La catégorie de préjudice est "contenu toxique".

HarmBlockThreshold

Niveaux de seuil de probabilité pour le blocage.

Enums
HARM_BLOCK_THRESHOLD_UNSPECIFIED	Seuil de blocage de préjudice non spécifié.
BLOCK_LOW_AND_ABOVE	Bloquer les seuils faibles et supérieurs (augmenter le nombre de blocages).
BLOCK_MEDIUM_AND_ABOVE	Bloquer les seuils moyens et supérieurs.
BLOCK_ONLY_HIGH	Bloquer uniquement les seuils élevés (réduire le nombre de blocage).
BLOCK_NONE	Ne rien bloquer.
OFF	Désactivez le filtre de sécurité.

Schéma de sortie

Dans la Customer Engagement Suite (CES), une version d'application est un instantané de l'application à un moment précis. Il est immuable et ne peut pas être modifié une fois créé.

AppVersion

Représentation JSON
{ "name": string, "displayName": string, "description": string, "creator": string, "createTime": string, "snapshot": { object (AppSnapshot) }, "etag": string }

Champs
name	string Identifiant. Identifiant unique de la version de l'application. Format : projects/{project}/locations/{location}/apps/{app}/versions/{version}
displayName	string Facultatif. Nom à afficher de la version de l'application.
description	string Facultatif. Description de la version de l'application.
creator	string Uniquement en sortie. Adresse e-mail de l'utilisateur qui a créé la version de l'application.
createTime	string (Timestamp format) Uniquement en sortie. Code temporel de la création de la version de l'application. 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".
snapshot	object (AppSnapshot) Uniquement en sortie. Instantané de l'application lors de la création de la version.
etag	string Uniquement en sortie. Etag utilisé pour s'assurer que l'objet n'a pas été modifié lors d'une opération de lecture/modification/écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.

Horodatage

Représentation JSON
{ "seconds": string, "nanos": integer }

Champs
seconds	string (int64 format) Représente les secondes de l'heure UTC à partir de l'epoch Unix 1970-01-01T00:00:00Z. La valeur doit être comprise entre -62135596800 et 253402300799 inclus (ce qui correspond à 0001-01-01T00:00:00Z et 9999-12-31T23:59:59Z).
nanos	integer Fractions de secondes non négatives avec une précision de l'ordre de la nanoseconde. Ce champ correspond à la partie en nanosecondes de la durée, et non à une alternative aux secondes. Les valeurs de secondes négatives avec des fractions doivent toujours comporter des valeurs de nanosecondes non négatives comptabilisées dans le temps. La valeur doit être comprise entre 0 et 999 999 999 inclus.

AppSnapshot

Représentation JSON
{ "app": { object (App) }, "agents": [ { object (Agent) } ], "tools": [ { object (Tool) } ], "examples": [ { object (Example) } ], "guardrails": [ { object (Guardrail) } ], "toolsets": [ { object (Toolset) } ] }

Champs
app	object (App) Facultatif. Paramètres de base de l'application.
agents[]	object (Agent) Facultatif. Liste des agents dans l'application.
tools[]	object (Tool) Facultatif. Liste des outils de l'application.
examples[]	object (Example) Facultatif. Liste d'exemples dans l'application.
guardrails[]	object (Guardrail) Facultatif. Liste des mesures de protection dans l'application.
toolsets[]	object (Toolset) Facultatif. Liste des ensembles d'outils dans l'application.

Application

Représentation JSON

{ "name": string, "displayName": string, "description": string, "pinned": boolean, "rootAgent": string, "languageSettings": { object (LanguageSettings) }, "timeZoneSettings": { object (TimeZoneSettings) }, "audioProcessingConfig": { object (AudioProcessingConfig) }, "loggingSettings": { object (LoggingSettings) }, "errorHandlingSettings": { object (ErrorHandlingSettings) }, "modelSettings": { object (ModelSettings) }, "toolExecutionMode": enum (ToolExecutionMode), "evaluationMetricsThresholds": { object (EvaluationMetricsThresholds) }, "variableDeclarations": [ { object (VariableDeclaration) } ], "predefinedVariableDeclarations": [ { object (VariableDeclaration) } ], "globalInstruction": string, "guardrails": [ string ], "dataStoreSettings": { object (DataStoreSettings) }, "defaultChannelProfile": { object (ChannelProfile) }, "metadata": { string: string, ... }, "createTime": string, "updateTime": string, "etag": string, "deploymentCount": integer, "clientCertificateSettings": { object (ClientCertificateSettings) }, "vpcScSettings": { object (VpcScSettings) }, "locked": boolean, "validationErrors": [ string ], "dashboardSettings": { object (DashboardSettings) } }

Champs
name	string Identifiant. Identifiant unique de l'application. Format : projects/{project}/locations/{location}/apps/{app}
displayName	string Obligatoire. Nom à afficher de l'application.
description	string Facultatif. Description de l'application dans un format lisible.
pinned	boolean Facultatif. Indique si l'application est épinglée dans la liste des applications.
rootAgent	string Facultatif. L'agent racine est le point d'entrée de l'application. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
languageSettings	object (LanguageSettings) Facultatif. Paramètres de langue de l'application.
timeZoneSettings	object (TimeZoneSettings) Facultatif. Paramètres de fuseau horaire de l'application.
audioProcessingConfig	object (AudioProcessingConfig) Facultatif. Configuration du traitement audio de l'application.
loggingSettings	object (LoggingSettings) Facultatif. Paramètres de journalisation de l'application.
errorHandlingSettings	object (ErrorHandlingSettings) Facultatif. Paramètres de gestion des exceptions de l'application.
modelSettings	object (ModelSettings) Facultatif. Paramètres de modèle LLM par défaut pour l'application. Les ressources individuelles (par exemple, les agents et les garde-fous) peuvent remplacer ces configurations si nécessaire.
toolExecutionMode	enum (ToolExecutionMode) Facultatif. Mode d'exécution de l'outil pour l'application. Si aucune valeur n'est fournie, la valeur par défaut est "PARALLEL".
evaluationMetricsThresholds	object (EvaluationMetricsThresholds) Facultatif. Seuils d'évaluation pour l'application.
variableDeclarations[]	object (VariableDeclaration) Facultatif. Déclarations des variables.
predefinedVariableDeclarations[]	object (VariableDeclaration) Uniquement en sortie. Déclarations des variables prédéfinies pour l'application.
globalInstruction	string Facultatif. Instructions pour tous les agents de l'application. Vous pouvez utiliser ces instructions pour configurer une identité ou une personnalité stable pour tous les agents.
guardrails[]	string Facultatif. Liste des garde-fous pour l'application. Format : projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
dataStoreSettings	object (DataStoreSettings) Facultatif. Paramètres du data store pour l'application.
defaultChannelProfile	object (ChannelProfile) Facultatif. Profil de chaîne par défaut utilisé par l'application.
metadata	map (key: string, value: string) Facultatif. Métadonnées sur l'application. Ce champ peut être utilisé pour stocker des informations supplémentaires concernant les détails ou les utilisations prévues de l'application. Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime	string (Timestamp format) Uniquement en sortie. Code temporel de la création de l'application. 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'application. 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 Uniquement en sortie. Etag utilisé pour s'assurer que l'objet n'a pas été modifié lors d'une opération de lecture/modification/écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.
deploymentCount	integer Uniquement en sortie. Nombre de déploiements dans l'application.
clientCertificateSettings	object (ClientCertificateSettings) Facultatif. Paramètres par défaut du certificat client pour l'application.
vpcScSettings	object (VpcScSettings) Facultatif. Paramètres VPC-SC de l'application.
locked	boolean Facultatif. Indique si l'application est verrouillée pour les modifications. Si l'application est verrouillée, les modifications apportées à ses ressources seront refusées.
validationErrors[]	string Uniquement en sortie. Mauvaise configuration ou avertissements dans l'application.
dashboardSettings	object (DashboardSettings) Facultatif. Paramètres de tableau de bord spécifiques à l'application pour associer et configurer les tableaux de bord Contact Center Insights.

LanguageSettings

Représentation JSON
{ "defaultLanguageCode": string, "supportedLanguageCodes": [ string ], "enableMultilingualSupport": boolean, "fallbackAction": string }

Champs
defaultLanguageCode	string Facultatif. Code de langue par défaut de l'application.
supportedLanguageCodes[]	string Facultatif. Liste des codes de langue acceptés par l'application, en plus de default_language_code.
enableMultilingualSupport	boolean Facultatif. Active la compatibilité multilingue. Si la valeur est "true", les agents de l'application utiliseront des instructions prédéfinies pour mieux gérer les entrées multilingues.
fallbackAction (deprecated)	string Cet élément est obsolète. Facultatif. Obsolète : cette fonctionnalité n'est plus disponible. Utilisez plutôt enable_multilingual_support pour améliorer la gestion des entrées multilingues. Action à effectuer lorsqu'un agent reçoit une entrée dans une langue non acceptée. Il peut s'agir d'une action prédéfinie ou d'un appel d'outil personnalisé. Les valeurs valides sont les suivantes : - Nom complet de la ressource d'un outil, qui déclenche l'exécution d'un outil spécifique. - Une action système prédéfinie, telle que "escalade" ou "quitter", qui déclenche un signal EndSession avec le metadata correspondant pour mettre fin à la conversation.

TimeZoneSettings

Représentation JSON
{ "timeZone": string }

Champs
timeZone	string Facultatif. Fuseau horaire de l'application, issu de la base de données des fuseaux horaires (par exemple, Amérique du Nord/Los_Angeles, Europe/Paris).

AudioProcessingConfig

Représentation JSON
{ "synthesizeSpeechConfigs": { string: { object (SynthesizeSpeechConfig) }, ... }, "bargeInConfig": { object (BargeInConfig) }, "inactivityTimeout": string, "ambientSoundConfig": { object (AmbientSoundConfig) } }

Champs
synthesizeSpeechConfigs	map (key: string, value: object (SynthesizeSpeechConfig)) Facultatif. Configuration de la synthèse de la réponse de l'agent, mappage du code de langue à SynthesizeSpeechConfig. Si la configuration pour le code de langue spécifié est introuvable, celle du code de langue racine sera utilisée. Par exemple, si la carte contient "en-us" et "en", et que le code de langue spécifié est "en-gb", la configuration "en" sera utilisée. Remarque : Le code de langue n'est pas sensible à la casse. Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
bargeInConfig	object (BargeInConfig) Facultatif. Configure le comportement de l'agent pour les activités d'interruption par l'utilisateur.
inactivityTimeout	string (Duration format) Facultatif. Durée d'inactivité de l'utilisateur (pas de parole ni d'interaction) avant que l'agent ne l'invite à réagir. Si ce paramètre n'est pas défini, l'agent ne demandera pas à l'utilisateur de réengager la conversation. Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
ambientSoundConfig	object (AmbientSoundConfig) Facultatif. Configuration du son ambiant à lire avec la réponse de l'agent synthétisée, pour rendre la conversation plus naturelle.

SynthesizeSpeechConfigsEntry

Représentation JSON
{ "key": string, "value": { object (SynthesizeSpeechConfig) } }

Champs
key	string
value	object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

Représentation JSON
{ "voice": string, "voiceSampleGcsUri": string, "speakingRate": number, "model": string, "instruction": string, "consentAudioGcsUri": string }

Champs
voice	string Facultatif. Nom de la voix. Si ce paramètre n'est pas défini, le service choisit une voix en fonction des autres paramètres, tels que language_code. Pour obtenir la liste des voix disponibles, veuillez consulter Voix et langues disponibles dans Cloud Text-to-Speech.
voiceSampleGcsUri (deprecated)	string Cet élément est obsolète. Facultatif. Obsolète : utilisez plutôt custom_voice_samples dans AudioProcessingConfig. URI Cloud Storage de l'échantillon audio pour le clonage de voix. L'échantillon audio doit être un fichier WAV mono-canal de 24 kHz. Remarque : Veuillez vous assurer que l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com dispose de l'autorisation storage.objects.get pour l'objet Cloud Storage.
speakingRate	number Facultatif. Taux/vitesse de l'énoncé. Valeur comprise dans la plage [0,25, 2,0]. La valeur 1,0 correspond à la vitesse native normale compatible avec la voix spécifique. La valeur 2,0 est deux fois plus rapide et la valeur 0,5 est deux fois moins rapide. Les valeurs en dehors de la plage [0,25, 2,0] renvoient une erreur.
model	string Facultatif. Modèle utilisé pour synthétiser l'audio. Valeurs actuellement acceptées : "gemini-3.1-flash-tts-preview". Si ce champ est vide, Chirp3-HD est utilisé.
instruction	string Facultatif. Instruction utilisée pour synthétiser la parole lors de l'utilisation d'un modèle génératif.
consentAudioGcsUri (deprecated)	string Cet élément est obsolète. Facultatif. Obsolète : utilisez plutôt custom_voice_samples dans AudioProcessingConfig. URI Cloud Storage de l'audio d'autorisation pour le clonage de voix.

BargeInConfig

Représentation JSON
{ "disableBargeIn": boolean, "bargeInAwareness": boolean }

Champs
disableBargeIn (deprecated)	boolean Cet élément est obsolète. Facultatif. Obsolète : disable_barge_in est obsolète et remplacé par disable_barge_in_control dans ChannelProfile. Désactive l'interruption par l'utilisateur pendant que l'agent parle. Si la valeur est "true", les entrées utilisateur pendant la lecture de la réponse de l'agent seront ignorées.
bargeInAwareness	boolean Facultatif. Si cette option est activée, l'agent adaptera sa prochaine réponse en partant du principe que l'utilisateur n'a pas entendu l'intégralité du message précédent de l'agent. Cette méthode ne doit pas être utilisée dans les scénarios où les réponses de l'agent sont affichées visuellement.

Durée

Représentation JSON
{ "seconds": string, "nanos": integer }

Champs
seconds	string (int64 format) Secondes signées de la période. La valeur doit être comprise entre -315 576 000 000 et [phone] (inclus). Remarque : Ces limites sont calculées à partir de : 60 s/min * 60 min/h * 24 h/jour * 365,25 jours/an * 10 000 ans
nanos	integer Fractions de secondes signées avec une précision de l'ordre de la nanoseconde pour la durée. Les durées inférieures à une seconde sont représentées par un champ seconds égal à 0 et un champ nanos positif ou négatif. Pour les durées d'une seconde ou plus, une valeur non nulle pour le champ nanos doit avoir le même signe que le champ seconds. La valeur doit être comprise entre -999 999 999 et [phone] inclus.

AmbientSoundConfig

Représentation JSON
{ "volumeGainDb": number, // Union field source can be only one of the following: "prebuiltAmbientNoise": enum (PrebuiltAmbientNoise), "gcsUri": string, "prebuiltAmbientSound": string // End of list of possible types for union field source. }

Champs
volumeGainDb	number Facultatif. Gain de volume (en dB) du volume natif normal compatible avec le bruit ambiant, compris entre -96 et 16. Si la valeur n'est pas définie ou si elle est définie sur une valeur de zéro (dB), elle est lue à une amplitude de signal natif normal. Une valeur de -6 (dB) est lue avec environ la moitié de l'amplitude du signal natif normal. Une valeur de +6 (dB) est lue avec environ deux fois plus d'amplitude que le signal natif normal. Nous vous recommandons vivement de ne pas dépasser +10 (dB), car il n'y a généralement pas d'augmentation efficace du volume pour une valeur supérieure à cette valeur.
Champ d'union source. Bruit ambiant à lire avec la réponse de l'agent synthétisée, pour rendre la conversation plus naturelle. source ne peut être qu'un des éléments suivants :
prebuiltAmbientNoise (deprecated)	enum (PrebuiltAmbientNoise) Cet élément est obsolète. Facultatif. Obsolète : prebuilt_ambient_noise est obsolète et remplacé par prebuilt_ambient_sound.
gcsUri	string Facultatif. Bruit ambiant sous forme de fichier WAV mono-canal à 16 kHz stocké dans Cloud Storage. Remarque : Veuillez vous assurer que l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com dispose de l'autorisation storage.objects.get pour l'objet Cloud Storage.
prebuiltAmbientSound	string Facultatif. Nom du son ambiant prédéfini. Les valeurs valides sont : "coffee_shop", "keyboard", "keypad", "hum", "office_1", "office_2", "office_3", "room_1", "room_2", "room_3", "room_4", "room_5", "air_conditioner".

LoggingSettings

Représentation JSON

{ "redactionConfig": { object (RedactionConfig) }, "audioRecordingConfig": { object (AudioRecordingConfig) }, "unredactedAudioRecordingConfig": { object (AudioRecordingConfig) }, "bigqueryExportSettings": { object (BigQueryExportSettings) }, "unredactedBigqueryExportSettings": { object (BigQueryExportSettings) }, "cloudLoggingSettings": { object (CloudLoggingSettings) }, "conversationLoggingSettings": { object (ConversationLoggingSettings) }, "evaluationAudioRecordingConfig": { object (AudioRecordingConfig) }, "metricAnalysisSettings": { object (MetricAnalysisSettings) } }

Champs
redactionConfig	object (RedactionConfig) Facultatif. Configuration du masquage des données sensibles.
audioRecordingConfig	object (AudioRecordingConfig) Facultatif. Configuration de l'enregistrement des interactions audio. L'audio est soumis à masquage, comme configuré dans RedactionConfig.
unredactedAudioRecordingConfig	object (AudioRecordingConfig) Facultatif. Configure un enregistrement supplémentaire de l'audio non masqué. Cette option peut être utilisée pour conserver une copie audio brute lorsque la censure audio est définie sur enabled, généralement à des fins d'audit ou de surveillance.
bigqueryExportSettings	object (BigQueryExportSettings) Facultatif. Configure les comportements d'exportation BigQuery pour l'application. Les données de conversation sont soumises à la censure configurée dans RedactionConfig.
unredactedBigqueryExportSettings	object (BigQueryExportSettings) Facultatif. Configure les comportements d'exportation BigQuery pour l'application. Les données de conversation non masquées seront exportées vers les tables BigQuery si cette option est activée.
cloudLoggingSettings	object (CloudLoggingSettings) Facultatif. Paramètres permettant de décrire les comportements de Cloud Logging pour l'application.
conversationLoggingSettings	object (ConversationLoggingSettings) Facultatif. Paramètres permettant de décrire les comportements de journalisation des conversations pour l'application.
evaluationAudioRecordingConfig	object (AudioRecordingConfig) Facultatif. Configuration de l'enregistrement des interactions audio pour l'évaluation. Par défaut, l'enregistrement audio n'est pas activé pour les sessions d'évaluation.
metricAnalysisSettings	object (MetricAnalysisSettings) Facultatif. Paramètres permettant de décrire les comportements de collecte de données de conversation pour le pipeline d'analyse LLM de l'application.

RedactionConfig

Représentation JSON
{ "enableRedaction": boolean, "inspectTemplate": string, "deidentifyTemplate": string }

Champs
enableRedaction	boolean Facultatif. Si la valeur est "true", le masquage sera appliqué dans différents scénarios de journalisation, y compris l'historique des conversations, Cloud Logging et l'enregistrement audio.
inspectTemplate	string Facultatif. Nom du modèle d'inspection DLP permettant de configurer la détection des types de données sensibles. Format : projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
deidentifyTemplate	string Facultatif. Nom du modèle d'anonymisation DLP pour indiquer comment anonymiser le contenu. Format : projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

AudioRecordingConfig

Représentation JSON
{ "gcsBucket": string, "gcsPathPrefix": string }

Champs
gcsBucket	string Facultatif. Bucket Cloud Storage pour stocker les enregistrements audio des sessions. L'URI doit commencer par "gs://". Veuillez choisir un emplacement de bucket qui répond à vos exigences de résidence des données. Remarque : Si le bucket Cloud Storage se trouve dans un projet différent de celui de l'application, vous devez accorder l'autorisation storage.objects.create à l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
gcsPathPrefix	string Facultatif. Préfixe du chemin d'accès Cloud Storage pour les enregistrements audio. Ce préfixe peut inclure les espaces réservés suivants, qui seront remplacés de manière dynamique au moment de la diffusion : - $project : ID du projet - $location : emplacement de l'application - $app : ID de l'application - $date : date de la session au format AAAA-MM-JJ - $session : ID de la session Si le préfixe de chemin n'est pas spécifié, le préfixe par défaut $project/$location/$app/$date/$session/ est utilisé.

BigQueryExportSettings

Représentation JSON
{ "enabled": boolean, "project": string, "dataset": string }

Champs
enabled	boolean Facultatif. Indique si l'exportation BigQuery est activée.
project	string Facultatif. L'ID du projet de l'ensemble de données BigQuery vers lequel exporter les données. Remarque : Si l'ensemble de données BigQuery se trouve dans un projet différent de celui de l'application, vous devez attribuer le rôle roles/bigquery.admin à l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
dataset	string Facultatif. L'ID de l'ensemble de données BigQuery vers lequel exporter les données.

CloudLoggingSettings

Représentation JSON
{ "enableCloudLogging": boolean }

Champs
enableCloudLogging	boolean Facultatif. Indique si Cloud Logging doit être activé pour les sessions.

ConversationLoggingSettings

Représentation JSON
{ "disableConversationLogging": boolean, "retentionWindow": string }

Champs
disableConversationLogging	boolean Facultatif. Indique si la journalisation des conversations doit être désactivée pour les sessions.
retentionWindow	string (Duration format) Facultatif. Contrôle la période de conservation de la conversation. Si elle n'est pas définie, la conversation sera conservée pendant 365 jours. Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

MetricAnalysisSettings

Représentation JSON
{ "llmMetricsOptedOut": boolean }

Champs
llmMetricsOptedOut	boolean Facultatif. Indique si les données de conversation doivent être collectées pour les métriques d'analyse des LLM. Si la valeur est "true", les données de conversation ne seront pas collectées pour les métriques d'analyse LLM. Dans le cas contraire, elles le seront.

ErrorHandlingSettings

Représentation JSON
{ "errorHandlingStrategy": enum (ErrorHandlingStrategy), "fallbackResponseConfig": { object (FallbackResponseConfig) }, "endSessionConfig": { object (EndSessionConfig) } }

Champs
errorHandlingStrategy	enum (ErrorHandlingStrategy) Facultatif. Stratégie à utiliser pour la gestion des exceptions.
fallbackResponseConfig	object (FallbackResponseConfig) Facultatif. Configuration pour la gestion des réponses de remplacement.
endSessionConfig	object (EndSessionConfig) Facultatif. Configuration pour mettre fin à la session en cas d'erreurs système (par exemple, erreurs LLM).

FallbackResponseConfig

Représentation JSON
{ "customFallbackMessages": { string: string, ... }, "maxFallbackAttempts": integer }

Champs
customFallbackMessages	map (key: string, value: string) Facultatif. Messages de remplacement en cas d'erreurs système (par exemple, erreurs LLM), mappés par code de langue compatible. Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
maxFallbackAttempts	integer Facultatif. Nombre maximal de tentatives de secours à effectuer avant que l'agent n'émette le signal EndSession.

CustomFallbackMessagesEntry

Représentation JSON
{ "key": string, "value": string }

Champs
key	string
value	string

EndSessionConfig

Représentation JSON
{ // Union field _escalate_session can be only one of the following: "escalateSession": boolean // End of list of possible types for union field _escalate_session. }

Champs
Champ d'union _escalate_session. _escalate_session ne peut être qu'un des éléments suivants :
escalateSession	boolean Facultatif. Indique si la session doit être escaladée dans EndSession. Si la session est escaladée, metadata in EndSession contient session_escalated = true. Pour en savoir plus, consultez https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent.

ModelSettings

Représentation JSON
{ "model": string, // Union field _temperature can be only one of the following: "temperature": number // End of list of possible types for union field _temperature. }

Champs
model	string Facultatif. Modèle LLM que l'agent doit utiliser. Si aucune valeur n'est définie, l'agent hérite du modèle de son agent parent.
Champ d'union _temperature. _temperature ne peut être qu'un des éléments suivants :
temperature	number Facultatif. Si cette option est définie, cette température sera utilisée pour le modèle LLM. La température contrôle le caractère aléatoire des réponses du modèle. Les températures plus basses produisent des réponses plus prévisibles. Les températures plus élevées génèrent des réponses plus créatives.

EvaluationMetricsThresholds

Représentation JSON
{ "goldenEvaluationMetricsThresholds": { object (GoldenEvaluationMetricsThresholds) }, "hallucinationMetricBehavior": enum (HallucinationMetricBehavior), "goldenHallucinationMetricBehavior": enum (HallucinationMetricBehavior), "scenarioHallucinationMetricBehavior": enum (HallucinationMetricBehavior) }

Champs
goldenEvaluationMetricsThresholds	object (GoldenEvaluationMetricsThresholds) Facultatif. Seuils des métriques d'évaluation privilégiées.
hallucinationMetricBehavior (deprecated)	enum (HallucinationMetricBehavior) Cet élément est obsolète. Facultatif. Obsolète : utilisez plutôt golden_hallucination_metric_behavior. Le comportement de la métrique d'hallucination est actuellement utilisé pour les évaluations de référence.
goldenHallucinationMetricBehavior	enum (HallucinationMetricBehavior) Facultatif. Comportement de la métrique d'hallucination pour les évaluations de référence.
scenarioHallucinationMetricBehavior	enum (HallucinationMetricBehavior) Facultatif. Comportement de la métrique d'hallucination pour les évaluations de scénarios.

GoldenEvaluationMetricsThresholds

Représentation JSON
{ "turnLevelMetricsThresholds": { object (TurnLevelMetricsThresholds) }, "expectationLevelMetricsThresholds": { object (ExpectationLevelMetricsThresholds) }, "toolMatchingSettings": { object (ToolMatchingSettings) } }

Champs
turnLevelMetricsThresholds	object (TurnLevelMetricsThresholds) Facultatif. Seuils des métriques au niveau du tour.
expectationLevelMetricsThresholds	object (ExpectationLevelMetricsThresholds) Facultatif. Seuils des métriques de niveau d'attente.
toolMatchingSettings	object (ToolMatchingSettings) Facultatif. Paramètres de correspondance de l'outil. Un appel d'outil supplémentaire est un appel d'outil présent dans l'exécution, mais qui ne correspond à aucun appel d'outil dans l'attente de référence.

TurnLevelMetricsThresholds

Représentation JSON

{ "semanticSimilarityChannel": enum (SemanticSimilarityChannel), // Union field _semantic_similarity_success_threshold can be only one of the // following: "semanticSimilaritySuccessThreshold": integer // End of list of possible types for union field // _semantic_similarity_success_threshold. // Union field _overall_tool_invocation_correctness_threshold can be only one // of the following: "overallToolInvocationCorrectnessThreshold": number // End of list of possible types for union field // _overall_tool_invocation_correctness_threshold. }

Champs
semanticSimilarityChannel	enum (SemanticSimilarityChannel) Facultatif. Canal de similarité sémantique à utiliser pour l'évaluation.
Champ d'union _semantic_similarity_success_threshold. _semantic_similarity_success_threshold ne peut être qu'un des éléments suivants :
semanticSimilaritySuccessThreshold	integer Facultatif. Seuil de réussite pour la similarité sémantique. Veuillez saisir un nombre entier compris entre 0 et 4. La valeur par défaut est >= 3.
Champ d'union _overall_tool_invocation_correctness_threshold. _overall_tool_invocation_correctness_threshold ne peut être qu'un des éléments suivants :
overallToolInvocationCorrectnessThreshold	number Facultatif. Seuil de réussite pour la correction globale de l'appel d'outil. Doit être un nombre à virgule flottante compris entre 0 et 1. La valeur par défaut est 1.0.

ExpectationLevelMetricsThresholds

Représentation JSON
{ // Union field _tool_invocation_parameter_correctness_threshold can be only one // of the following: "toolInvocationParameterCorrectnessThreshold": number // End of list of possible types for union field // _tool_invocation_parameter_correctness_threshold. }

Champs
Champ d'union _tool_invocation_parameter_correctness_threshold. _tool_invocation_parameter_correctness_threshold ne peut être qu'un des éléments suivants :
toolInvocationParameterCorrectnessThreshold	number Facultatif. Seuil de réussite pour la justesse des paramètres d'appel d'outil individuel. Doit être un nombre à virgule flottante compris entre 0 et 1. La valeur par défaut est 1.0.

ToolMatchingSettings

Représentation JSON
{ "extraToolCallBehavior": enum (ExtraToolCallBehavior) }

Champs
extraToolCallBehavior	enum (ExtraToolCallBehavior) Facultatif. Comportement pour les appels d'outils supplémentaires. La valeur par défaut est "FAIL".

VariableDeclaration

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

Champs
name	string Obligatoire. Nom de la variable. Le nom doit commencer par une lettre ou un trait de soulignement, et ne peut contenir que des lettres, des chiffres ou des traits de soulignement.
description	string Obligatoire. Description de la variable.
schema	object (Schema) Obligatoire. Schéma de la variable.

Schéma

Représentation JSON

{ "type": enum (Type), "properties": { string: { object (Schema) }, ... }, "required": [ string ], "description": string, "items": { object (Schema) }, "nullable": boolean, "uniqueItems": boolean, "prefixItems": [ { object (Schema) } ], "additionalProperties": { object (Schema) }, "anyOf": [ { object (Schema) } ], "enum": [ string ], "default": value, "ref": string, "defs": { string: { object (Schema) }, ... }, "title": string, "minItems": string, "maxItems": string, // Union field _minimum can be only one of the following: "minimum": number // End of list of possible types for union field _minimum. // Union field _maximum can be only one of the following: "maximum": number // End of list of possible types for union field _maximum. }

Champs
type	enum (Type) Obligatoire. Type des données.
properties	map (key: string, value: object (Schema)) Facultatif. Propriétés de Type.OBJECT. Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
required[]	string Facultatif. Propriétés requises de Type.OBJECT.
description	string Facultatif. Description des données.
items	object (Schema) Facultatif. Schéma des éléments de Type.ARRAY.
nullable	boolean Facultatif. Indique si la valeur peut être nulle.
uniqueItems	boolean Facultatif. Indique que les éléments du tableau doivent être uniques. Ne s'applique qu'à TYPE.ARRAY.
prefixItems[]	object (Schema) Facultatif. Schémas des éléments initiaux de Type.ARRAY.
additionalProperties	object (Schema) Facultatif. Peut être une valeur booléenne ou un objet. Contrôle la présence de propriétés supplémentaires.
anyOf[]	object (Schema) Facultatif. La valeur doit être validée par rapport à l'un ou plusieurs des sous-schémas de la liste.
enum[]	string Facultatif. Valeurs possibles de l'élément de type primitif avec le format enum. Exemples : 1. Nous pouvons définir la direction comme suit : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. Nous pouvons définir le numéro d'appartement comme suit : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default	value (Value format) Facultatif. Valeur par défaut des données.
ref	string Facultatif. Permet les références indirectes entre les nœuds de schéma. La valeur doit être une référence valide à un enfant de la racine defs. Par exemple, le schéma suivant définit une référence à un nœud de schéma nommé "Pet" : type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string La valeur de la propriété "pet" est une référence au nœud de schéma nommé "Pet". Pour en savoir plus, consultez https://json-schema.org/understanding-json-schema/structuring.
defs	map (key: string, value: object (Schema)) Facultatif. Carte des définitions à utiliser par ref. Uniquement autorisé à la racine du schéma. Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
title	string Facultatif. Titre du schéma.
minItems	string (int64 format) Facultatif. Nombre minimal d'éléments pour Type.ARRAY.
maxItems	string (int64 format) Facultatif. Nombre maximal d'éléments pour Type.ARRAY.
Champ d'union _minimum. _minimum ne peut être qu'un des éléments suivants :
minimum	number Facultatif. Valeur minimale pour Type.INTEGER et Type.NUMBER.
Champ d'union _maximum. _maximum ne peut être qu'un des éléments suivants :
maximum	number Facultatif. Valeur maximale pour Type.INTEGER et Type.NUMBER.

PropertiesEntry

Représentation JSON
{ "key": string, "value": { object (Schema) } }

Champs
key	string
value	object (Schema)

Valeur

Représentation JSON
{ // Union field kind can be only one of the following: "nullValue": null, "numberValue": number, "stringValue": string, "boolValue": boolean, "structValue": { object }, "listValue": array // End of list of possible types for union field kind. }

Champs
Champ d'union kind. Type de valeur. kind ne peut être qu'un des éléments suivants :
nullValue	null Représente un null JSON.
numberValue	number Représente un nombre JSON. Ne doit pas être NaN, Infinity ni -Infinity, car ces valeurs ne sont pas acceptées dans JSON. Il ne peut pas non plus représenter de grandes valeurs Int64, car le format JSON ne les accepte généralement pas dans son type numérique.
stringValue	string Représente une chaîne JSON.
boolValue	boolean Représente une valeur booléenne JSON (littéral true ou false en JSON).
structValue	object (Struct format) Représente un objet JSON.
listValue	array (ListValue format) Représente un tableau JSON.

Struct

Représentation JSON
{ "fields": { string: value, ... } }

Champs
fields	map (key: string, value: value (Value format)) Carte non ordonnée de valeurs typées dynamiquement. Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

Représentation JSON
{ "key": string, "value": value }

Champs
key	string
value	value (Value format)

ListValue

Représentation JSON
{ "values": [ value ] }

Champs
values[]	value (Value format) Champ répété de valeurs typées de manière dynamique.

DefsEntry

Représentation JSON
{ "key": string, "value": { object (Schema) } }

Champs
key	string
value	object (Schema)

DataStoreSettings

Représentation JSON
{ "engines": [ { object (Engine) } ] }

Champs
engines[]	object (Engine) Uniquement en sortie. Moteurs de l'application.

Moteur

Représentation JSON
{ "name": string, "type": enum (Type) }

Champs
name	string Uniquement en sortie. Nom de ressource du moteur. Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type	enum (Type) Uniquement en sortie. Type de moteur.

ChannelProfile

Représentation JSON

{ "profileId": string, "channelType": enum (ChannelType), "personaProperty": { object (PersonaProperty) }, "webWidgetConfig": { object (WebWidgetConfig) }, "whatsappConfig": { object (WhatsAppConfig) }, "instagramConfig": { object (InstagramConfig) }, // Union field _disable_dtmf can be only one of the following: "disableDtmf": boolean // End of list of possible types for union field _disable_dtmf. // Union field _disable_barge_in_control can be only one of the following: "disableBargeInControl": boolean // End of list of possible types for union field _disable_barge_in_control. // Union field _noise_suppression_level can be only one of the following: "noiseSuppressionLevel": string // End of list of possible types for union field _noise_suppression_level. }

Champs
profileId	string Facultatif. Identifiant unique du profil de chaîne.
channelType	enum (ChannelType) Facultatif. Type de profil de chaîne.
personaProperty	object (PersonaProperty) Facultatif. Propriété "persona" du profil de la chaîne.
webWidgetConfig	object (WebWidgetConfig) Facultatif. Configuration du widget Web.
whatsappConfig	object (WhatsAppConfig) Facultatif. Configuration spécifique aux déploiements WhatsApp.
instagramConfig	object (InstagramConfig) Facultatif. Configuration spécifique aux déploiements Instagram.
Champ d'union _disable_dtmf. _disable_dtmf ne peut être qu'un des éléments suivants :
disableDtmf	boolean Facultatif. Indique si le DTMF (double fréquence) doit être désactivé.
Champ d'union _disable_barge_in_control. _disable_barge_in_control ne peut être qu'un des éléments suivants :
disableBargeInControl	boolean Facultatif. Indique si le contrôle de l'interruption par l'utilisateur doit être désactivé dans la conversation. - true : les interruptions de l'utilisateur sont désactivées pendant que l'agent parle. - false : l'agent conserve le contrôle automatique sur le moment où l'utilisateur peut interrompre.
Champ d'union _noise_suppression_level. _noise_suppression_level ne peut être qu'un des éléments suivants :
noiseSuppressionLevel	string Facultatif. Niveau de suppression du bruit du profil de chaîne. Les valeurs disponibles sont "low", "moderate", "high" et "very_high".

PersonaProperty

Représentation JSON
{ "persona": enum (Persona) }

Champs
persona	enum (Persona) Facultatif. Personnalité de la chaîne.

WebWidgetConfig

Représentation JSON
{ "modality": enum (Modality), "theme": enum (Theme), "webWidgetTitle": string, "securitySettings": { object (SecuritySettings) } }

Champs
modality	enum (Modality) Facultatif. Modalité du widget Web.
theme	enum (Theme) Facultatif. Thème du widget Web.
webWidgetTitle	string Facultatif. Titre du widget Web.
securitySettings	object (SecuritySettings) Facultatif. Paramètres de sécurité du widget Web.

SecuritySettings

Représentation JSON
{ "enablePublicAccess": boolean, "enableOriginCheck": boolean, "allowedOrigins": [ string ], "enableRecaptcha": boolean }

Champs
enablePublicAccess	boolean Facultatif. Indique si l'accès public au widget Web est activé. Si la valeur est true, le widget Web sera accessible au public. Si la valeur est false, le widget Web doit être intégré à votre propre système d'authentification et d'autorisation pour renvoyer des identifiants valides permettant d'accéder à l'agent CES.
enableOriginCheck	boolean Facultatif. Indique si la vérification de l'origine du widget Web est activée. Si la valeur est true, le widget Web vérifie l'origine du site Web qui charge le widget Web et n'autorise le chargement que dans la même origine ou dans l'une des origines autorisées.
allowedOrigins[]	string Facultatif. Origines autorisées à héberger le widget Web. Une origine est définie par la norme RFC 6454. Si ce champ est vide, toutes les origines sont autorisées. Vous ne pouvez pas inclure plus de 100 origines. Exemple : "https://example.com"
enableRecaptcha	boolean Facultatif. Indique si la validation reCAPTCHA pour le widget Web est activée.

WhatsAppConfig

Représentation JSON
{ "wabaId": string, "phoneNumberId": string, "phoneNumber": string, "displayName": string, "thumbnailUrl": string, "description": string }

Champs
wabaId	string Obligatoire. ID de compte WhatsApp Business.
phoneNumberId	string Obligatoire. ID du numéro de téléphone Meta.
phoneNumber	string Facultatif. Numéro de téléphone au format E.164.
displayName	string Uniquement en sortie. Nom de la page Facebook récupérée.
thumbnailUrl	string Uniquement en sortie. URL de la vignette de la fiche d'établissement Meta récupérée.
description	string Uniquement en sortie. Description de la page ou du profil Meta de l'entreprise.

InstagramConfig

Représentation JSON
{ "instagramAccountId": string, "displayName": string, "thumbnailUrl": string, "description": string }

Champs
instagramAccountId	string Obligatoire. ID du compte Instagram.
displayName	string Uniquement en sortie. Nom de la page Facebook récupérée.
thumbnailUrl	string Uniquement en sortie. URL de la vignette de la fiche d'établissement Meta récupérée.
description	string Uniquement en sortie. Description de la page ou du profil Meta de l'entreprise.

MetadataEntry

Représentation JSON
{ "key": string, "value": string }

Champs
key	string
value	string

ClientCertificateSettings

Représentation JSON
{ "tlsCertificate": string, "privateKey": string, "passphrase": string }

Champs
tlsCertificate	string Obligatoire. Certificat TLS encodé au format PEM. Cette chaîne doit inclure les lignes d'en-tête de début et de pied de page de fin.
privateKey	string Obligatoire. Nom de la ressource de version du secret Secret Manager stockant la clé privée encodée au format PEM. Format : projects/{project}/secrets/{secret}/versions/{version}
passphrase	string Facultatif. Nom de la ressource de version du secret Secret Manager stockant la phrase secrète permettant de déchiffrer la clé privée. Doit être laissé vide si la clé privée n'est pas chiffrée. Format : projects/{project}/secrets/{secret}/versions/{version}

VpcScSettings

Représentation JSON
{ "allowedOrigins": [ string ] }

Champs

allowedOrigins[]

string Facultatif. Origines HTTP(S) autorisées que les outils OpenAPI de l'application peuvent appeler directement lorsque VPC Service Controls est activé. Ces chaînes doivent correspondre exactement à l'origine, y compris le port si spécifié. (par exemple, "https://example.com" ou "https://example.com:443"). Cette liste ne s'applique pas encore aux outils Python qui peuvent effectuer des appels HTTP directs.

DashboardSettings

Représentation JSON
{ "defaultDashboard": string }

Champs
defaultDashboard	string Facultatif. Nom de ressource du tableau de bord Contact Center Insights par défaut associé à l'application. Il s'agit du tableau de bord qui s'affiche lorsque les utilisateurs accèdent à la vue "Surveillance" de l'application. Format : projects/{project}/locations/{location}/dashboards/{dashboard}

Agent

Représentation JSON

{ "name": string, "displayName": string, "description": string, "modelSettings": { object (ModelSettings) }, "instruction": string, "tools": [ string ], "childAgents": [ string ], "beforeAgentCallbacks": [ { object (Callback) } ], "afterAgentCallbacks": [ { object (Callback) } ], "beforeModelCallbacks": [ { object (Callback) } ], "afterModelCallbacks": [ { object (Callback) } ], "beforeToolCallbacks": [ { object (Callback) } ], "afterToolCallbacks": [ { object (Callback) } ], "createTime": string, "updateTime": string, "guardrails": [ string ], "etag": string, "toolsets": [ { object (AgentToolset) } ], "generatedSummary": string, "transferRules": [ { object (TransferRule) } ], "validationErrors": [ string ], // Union field agent_type can be only one of the following: "llmAgent": { object (LlmAgent) }, "remoteDialogflowAgent": { object (RemoteDialogflowAgent) } // End of list of possible types for union field agent_type. }

Champs
name	string Identifiant. Identifiant unique de l'agent. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
displayName	string Obligatoire. Nom à afficher de l'agent.
description	string Facultatif. Description de l'agent lisible par l'humain.
modelSettings	object (ModelSettings) Facultatif. Configurations du modèle LLM.
instruction	string Facultatif. Instructions pour le modèle LLM afin de guider le comportement de l'agent.
tools[]	string Facultatif. Liste des outils disponibles pour l'agent. Format : projects/{project}/locations/{location}/apps/{app}/tools/{tool}
childAgents[]	string Facultatif. Liste des agents enfants dans l'arborescence des agents. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
beforeAgentCallbacks[]	object (Callback) Facultatif. Rappels à exécuter avant l'appel de l'agent. Les rappels fournis sont exécutés de manière séquentielle dans l'ordre exact dans lequel ils sont fournis dans la liste. Si un rappel renvoie une réponse remplacée, l'exécution s'arrête et les rappels restants sont ignorés.
afterAgentCallbacks[]	object (Callback) Facultatif. Rappels à exécuter après l'appel de l'agent. Les rappels fournis sont exécutés de manière séquentielle dans l'ordre exact dans lequel ils sont fournis dans la liste. Si un rappel renvoie une réponse remplacée, l'exécution s'arrête et les rappels restants sont ignorés.
beforeModelCallbacks[]	object (Callback) Facultatif. Rappels à exécuter avant l'appel du modèle. Si le modèle est appelé plusieurs fois, le rappel sera exécuté plusieurs fois. Les rappels fournis sont exécutés de manière séquentielle dans l'ordre exact dans lequel ils sont fournis dans la liste. Si un rappel renvoie une réponse remplacée, l'exécution s'arrête et les rappels restants sont ignorés.
afterModelCallbacks[]	object (Callback) Facultatif. Rappels à exécuter après l'appel du modèle. Si le modèle est appelé plusieurs fois, le rappel sera exécuté plusieurs fois. Les rappels fournis sont exécutés de manière séquentielle dans l'ordre exact dans lequel ils sont fournis dans la liste. Si un rappel renvoie une réponse remplacée, l'exécution s'arrête et les rappels restants sont ignorés.
beforeToolCallbacks[]	object (Callback) Facultatif. Rappels à exécuter avant l'appel de l'outil. Si plusieurs outils sont appelés, le rappel sera exécuté plusieurs fois. Les rappels fournis sont exécutés de manière séquentielle dans l'ordre exact dans lequel ils sont fournis dans la liste. Si un rappel renvoie une réponse remplacée, l'exécution s'arrête et les rappels restants sont ignorés.
afterToolCallbacks[]	object (Callback) Facultatif. Rappels à exécuter après l'appel de l'outil. Si plusieurs outils sont appelés, le rappel sera exécuté plusieurs fois. Les rappels fournis sont exécutés de manière séquentielle dans l'ordre exact dans lequel ils sont fournis dans la liste. Si un rappel renvoie une réponse remplacée, l'exécution s'arrête et les rappels restants sont ignorés.
createTime	string (Timestamp format) Uniquement en sortie. Code temporel de la création de l'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 l'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".
guardrails[]	string Facultatif. Liste des garde-fous pour l'agent. Format : projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
etag	string Etag utilisé pour s'assurer que l'objet n'a pas été modifié lors d'une opération de lecture/modification/écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.
toolsets[]	object (AgentToolset) Facultatif. Liste des ensembles d'outils pour l'agent.
generatedSummary	string Uniquement en sortie. Si l'agent est généré par l'assistant LLM, ce champ contient un résumé descriptif de la génération.
transferRules[]	object (TransferRule) Facultatif. Règles de transfert d'agent. Si plusieurs règles correspondent, la première de la liste sera utilisée.
validationErrors[]	string Uniquement en sortie. Erreurs ou configurations incorrectes dans l'agent pouvant affecter sa qualité.
Champ d'union agent_type. Type d'agent. agent_type ne peut être qu'un des éléments suivants :
llmAgent	object (LlmAgent) Facultatif. Type d'agent par défaut.
remoteDialogflowAgent	object (RemoteDialogflowAgent) Facultatif. Agent Dialogflow distant à utiliser pour l'exécution de l'agent. Si ce champ est défini, toutes les autres propriétés au niveau de l'agent seront ignorées. Remarque : Si l'agent Dialogflow se trouve dans un projet différent de celui de l'application, vous devez accorder roles/dialogflow.client à l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

RemoteDialogflowAgent

Représentation JSON
{ "agent": string, "flowId": string, "environmentId": string, "inputVariableMapping": { string: string, ... }, "outputVariableMapping": { string: string, ... }, "respectResponseInterruptionSettings": boolean, "languageCodeVariable": string }

Champs
agent	string Obligatoire. Nom de ressource de l'agent Dialogflow. Format : projects/{project}/locations/{location}/agents/{agent}
flowId	string Facultatif. ID du flux dans l'agent Dialogflow.
environmentId	string Facultatif. ID de l'environnement de l'agent Dialogflow à utiliser pour l'exécution de l'agent. Si aucune valeur n'est spécifiée, l'environnement brouillon est utilisé.
inputVariableMapping	map (key: string, value: string) Facultatif. Mappage des noms des variables d'application avec les noms des paramètres de session Dialogflow à envoyer à l'agent Dialogflow en tant qu'entrée. Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
outputVariableMapping	map (key: string, value: string) Facultatif. Mappage des noms de paramètres de session Dialogflow aux noms de variables d'application à renvoyer à l'agent CES une fois l'exécution de l'agent Dialogflow terminée. Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
respectResponseInterruptionSettings	boolean Facultatif. Indique s'il faut respecter les paramètres d'interruption au niveau du message configurés dans l'agent Dialogflow. Si la valeur est "false", tous les messages de réponse de l'agent Dialogflow suivent les paramètres d'interruption au niveau de l'application. Si la valeur est "true", seuls les messages de réponse dont la valeur allow_playback_interruption est définie sur "true" peuvent être interrompus. Tous les autres messages suivent les paramètres d'interruption au niveau de l'application.
languageCodeVariable	string Facultatif. Nom de la variable contenant le code de langue à utiliser pour la session Dialogflow. Si aucune valeur n'est spécifiée, le code de langue par défaut de l'agent Dialogflow sera utilisé.

InputVariableMappingEntry

Représentation JSON
{ "key": string, "value": string }

Champs
key	string
value	string

OutputVariableMappingEntry

Représentation JSON
{ "key": string, "value": string }

Champs
key	string
value	string

Rappel

Représentation JSON
{ "description": string, "disabled": boolean, "proactiveExecutionEnabled": boolean, // Union field callback can be only one of the following: "pythonCode": string // End of list of possible types for union field callback. }

Champs
description	string Facultatif. Description lisible du rappel.
disabled	boolean Facultatif. Indique si le rappel est désactivé. Les rappels désactivés sont ignorés par l'agent.
proactiveExecutionEnabled	boolean Facultatif. Si elle est activée, le rappel sera également exécuté sur les sorties de modèle intermédiaires. Ce paramètre ne s'applique qu'au rappel "Après le modèle". ACTIVEZ AVEC PRÉCAUTION. Le rappel "Après le modèle" ne doit généralement être exécuté qu'après avoir reçu toutes les réponses du modèle. L'activation de l'exécution proactive peut avoir des conséquences négatives sur le coût et la latence de l'exécution. Elle ne doit être activée que dans de rares cas.
Champ d'union callback. Rappel à exécuter. callback ne peut être qu'un des éléments suivants :
pythonCode	string Obligatoire. Code Python à exécuter pour le rappel.

AgentToolset

Représentation JSON
{ "toolset": string, "toolIds": [ string ] }

Champs
toolset	string Obligatoire. Nom de ressource de l'ensemble d'outils. Format : projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
toolIds[]	string Facultatif. ID des outils permettant de filtrer l'ensemble d'outils.

TransferRule

Représentation JSON
{ "childAgent": string, "direction": enum (Direction), // Union field rule_type can be only one of the following: "deterministicTransfer": { object (DeterministicTransfer) }, "disablePlannerTransfer": { object (DisablePlannerTransfer) } // End of list of possible types for union field rule_type. }

Champs
childAgent	string Obligatoire. Nom de ressource de l'agent enfant auquel s'applique la règle. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
direction	enum (Direction) Obligatoire. Sens du transfert.
Champ d'union rule_type. Type de règle. rule_type ne peut être qu'un des éléments suivants :
deterministicTransfer	object (DeterministicTransfer) Facultatif. Règle qui transfère immédiatement la demande à l'agent cible lorsque la condition est remplie.
disablePlannerTransfer	object (DisablePlannerTransfer) Facultatif. Règle qui empêche le planificateur d'être transféré à l'agent cible.

DeterministicTransfer

Représentation JSON
{ // Union field condition_type can be only one of the following: "expressionCondition": { object (ExpressionCondition) }, "pythonCodeCondition": { object (PythonCodeCondition) } // End of list of possible types for union field condition_type. }

Champs
Champ d'union condition_type. Condition à évaluer. condition_type ne peut être qu'un des éléments suivants :
expressionCondition	object (ExpressionCondition) Facultatif. Règle qui évalue une condition d'état de session. Si la condition renvoie la valeur "true", le transfert a lieu.
pythonCodeCondition	object (PythonCodeCondition) Facultatif. Une règle qui utilise un bloc de code Python pour évaluer les conditions. Si la condition renvoie la valeur "true", le transfert a lieu.

ExpressionCondition

Représentation JSON
{ "expression": string }

Champs
expression	string Obligatoire. Représentation sous forme de chaîne de la condition cloud.api.Expression.

PythonCodeCondition

Représentation JSON
{ "pythonCode": string }

Champs
pythonCode	string Obligatoire. Code Python à exécuter.

DisablePlannerTransfer

Représentation JSON
{ "expressionCondition": { object (ExpressionCondition) } }

Champs
expressionCondition	object (ExpressionCondition) Obligatoire. Si la condition renvoie "true", le planificateur ne sera pas autorisé à transférer la requête à l'agent cible.

Outil

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, basé sur 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 été modifié 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 OpenAPI.
googleSearchTool	object (GoogleSearchTool) Facultatif. Outil de recherche Google.
connectorTool	object (ConnectorTool) Facultatif. L'outil Integration Connectors.
dataStoreTool	object (DataStoreTool) Facultatif. Outil de data store.
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 d'agent.
widgetTool	object (WidgetTool) Facultatif. L'outil Widget.
remoteAgentTool	object (RemoteAgentTool) Facultatif. L'outil d'agent distant.

ClientFunction

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

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.

ApiAuthentication

Représentation JSON

{ // Union field auth_config can be only one of the following: "apiKeyConfig": { object (ApiKeyConfig) }, "oauthConfig": { object (OAuthConfig) }, "serviceAgentIdTokenAuthConfig": { object (ServiceAgentIdTokenAuthConfig) }, "serviceAccountAuthConfig": { object (ServiceAccountAuthConfig) }, "bearerTokenConfig": { object (BearerTokenConfig) } // End of list of possible types for union field auth_config. }

Champs
Champ d'union auth_config. Configuration de l'authentification. auth_config ne peut être qu'un des éléments suivants :
apiKeyConfig	object (ApiKeyConfig) Facultatif. Configuration pour l'authentification par clé API.
oauthConfig	object (OAuthConfig) Facultatif. Configuration pour OAuth.
serviceAgentIdTokenAuthConfig	object (ServiceAgentIdTokenAuthConfig) Facultatif. Configuration pour l'authentification par jeton d'identification générée à partir de l'agent de service CES.
serviceAccountAuthConfig	object (ServiceAccountAuthConfig) Facultatif. Configuration pour l'authentification du compte de service.
bearerTokenConfig	object (BearerTokenConfig) Facultatif. Configuration pour l'authentification par jeton du porteur.

ApiKeyConfig

Représentation JSON
{ "keyName": string, "apiKeySecretVersion": string, "requestLocation": enum (RequestLocation) }

Champs
keyName	string Obligatoire. Nom du paramètre ou de l'en-tête de la clé API. Exemple : Si la requête API est "https://example.com/act?X-Api-Key=", "X-Api-Key" est le nom du paramètre.
apiKeySecretVersion	string Obligatoire. Nom de la ressource de version secrète Secret Manager stockant la clé API. Format : projects/{project}/secrets/{secret}/versions/{version} Remarque : Vous devez attribuer le rôle roles/secretmanager.secretAccessor à l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
requestLocation	enum (RequestLocation) Obligatoire. Emplacement de la clé dans la requête.

OAuthConfig

Représentation JSON
{ "oauthGrantType": enum (OauthGrantType), "clientId": string, "clientSecretVersion": string, "tokenEndpoint": string, "scopes": [ string ] }

Champs
oauthGrantType	enum (OauthGrantType) Obligatoire. Types d'attribution OAuth.
clientId	string Obligatoire. ID client du fournisseur OAuth.
clientSecretVersion	string Obligatoire. Nom de la ressource de version du secret Secret Manager stockant le code secret du client. Format : projects/{project}/secrets/{secret}/versions/{version} Remarque : Vous devez attribuer le rôle roles/secretmanager.secretAccessor à l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
tokenEndpoint	string Obligatoire. Point de terminaison du jeton dans le fournisseur OAuth à échanger contre un jeton d'accès.
scopes[]	string Facultatif. Champs d'application OAuth à accorder.

ServiceAccountAuthConfig

Représentation JSON
{ "serviceAccount": string, "scopes": [ string ] }

Champs
serviceAccount	string Obligatoire. Adresse e-mail du compte de service utilisé pour l'authentification. CES utilise ce compte de service pour échanger un jeton d'accès, qui est ensuite envoyé dans l'en-tête Authorization de la requête. Le compte de service doit disposer du rôle roles/iam.serviceAccountTokenCreator attribué à l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
scopes[]	string Facultatif. Champs d'application OAuth à accorder. Si aucune valeur n'est spécifiée, le champ d'application par défaut https://www.googleapis.com/auth/cloud-platform est utilisé.

BearerTokenConfig

Représentation JSON
{ "token": string }

Champs
token	string Obligatoire. Jeton de support. Il doit respecter le format $context.variables.<name_of_variable>.

TlsConfig

Représentation JSON
{ "caCerts": [ { object (CaCert) } ] }

Champs
caCerts[]	object (CaCert) Obligatoire. Indique une liste de certificats CA personnalisés autorisés pour la validation HTTPS.

CaCert

Représentation JSON
{ "displayName": string, "cert": string }

Champs
displayName	string Obligatoire. Nom des certificats CA personnalisés autorisés. Cela permet de lever toute ambiguïté concernant les certificats d'autorité de certification personnalisés.
cert	string (bytes format) Obligatoire. Certificats CA personnalisés autorisés (au format DER) pour la validation HTTPS. Cela remplace le magasin de confiance SSL par défaut. Si ce champ est vide ou n'est pas spécifié, CES utilisera le magasin de confiance par défaut de Google pour valider les certificats. Remarque : Assurez-vous que les certificats de serveur HTTPS sont signés avec "subject alt name". Par exemple, un certificat peut être autosigné à l'aide de la commande suivante : openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") Chaîne encodée en base64.

ServiceDirectoryConfig

Représentation JSON
{ "service": string }

Champs
service	string Obligatoire. Nom du service Annuaire des services. Format : projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. L'emplacement de l'annuaire des services doit être identique à celui de l'application.

GoogleSearchTool

Représentation JSON
{ "name": string, "description": string, "contextUrls": [ string ], "preferredDomains": [ string ], "excludeDomains": [ string ], "promptConfig": { object (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 récupéré directement à partir 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 (PromptConfig) Facultatif. Instructions transmises au planificateur sur la façon dont les résultats de recherche doivent être traités pour le texte et la voix.

PromptConfig

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 des interactions 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

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éterminer s'il doit appeler ConnectorTool.
description	string Facultatif. Description de l'outil que l'agent peut utiliser pour déterminer s'il doit appeler ConnectorTool.

Action

Représentation JSON
{ "inputFields": [ string ], "outputFields": [ string ], // Union field action_spec can be only one of the following: "connectionActionId": string, "entityOperation": { object (EntityOperation) } // End of list of possible types for union field action_spec. }

Champs
inputFields[]	string Facultatif. Champs d'entité à utiliser comme entrées pour l'opération. Si aucun champ n'est spécifié, tous les champs de l'entité seront utilisés.
outputFields[]	string Facultatif. Champs d'entité à renvoyer à partir de l'opération. Si aucun champ n'est spécifié, tous les champs de l'entité sont renvoyés.
Champ d'union action_spec. Spécification d'une action à configurer pour que l'outil l'utilise. action_spec ne peut être qu'un des éléments suivants :
connectionActionId	string ID d'une action de connexion que l'outil doit utiliser.
entityOperation	object (EntityOperation) Configuration de l'opération d'entité à utiliser par l'outil.

EntityOperation

Représentation JSON
{ "entityId": string, "operation": enum (OperationType) }

Champs
entityId	string Obligatoire. ID de l'entité.
operation	enum (OperationType) Obligatoire. Opération à effectuer sur l'entité.

EndUserAuthConfig

Représentation JSON
{ // Union field auth_config can be only one of the following: "oauth2AuthCodeConfig": { object (Oauth2AuthCodeConfig) }, "oauth2JwtBearerConfig": { object (Oauth2JwtBearerConfig) } // End of list of possible types for union field auth_config. }

Champs
Champ d'union auth_config. Configuration de l'authentification. auth_config ne peut être qu'un des éléments suivants :
oauth2AuthCodeConfig	object (Oauth2AuthCodeConfig) Authentification avec un code d'autorisation OAuth 2.0.
oauth2JwtBearerConfig	object (Oauth2JwtBearerConfig) Authentification par attribution d'autorisation OAuth 2.0 avec profil JWT.

Oauth2AuthCodeConfig

Représentation JSON
{ "oauthToken": string }

Champs
oauthToken	string Obligatoire. Nom du paramètre de jeton OAuth à transmettre. Il doit respecter le format $context.variables.<name_of_variable>.

Oauth2JwtBearerConfig

Représentation JSON
{ "issuer": string, "subject": string, "clientKey": string }

Champs
issuer	string Obligatoire. Nom du paramètre de l'émetteur à transmettre. Il doit respecter le format $context.variables.<name_of_variable>.
subject	string Obligatoire. Nom du paramètre de sujet à transmettre. Il doit respecter le format $context.variables.<name_of_variable>.
clientKey	string Obligatoire. Nom du paramètre client à transmettre. Il doit respecter le format $context.variables.<name_of_variable>.

DataStoreTool

Représentation JSON

{ "name": string, "description": string, "boostSpecs": [ { object (BoostSpecs) } ], "modalityConfigs": [ { object (ModalityConfig) } ], "filterParameterBehavior": enum (FilterParameterBehavior), // Union field search_source can be only one of the following: "dataStoreSource": { object (DataStoreSource) }, "engineSource": { object (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 (BoostSpecs) Facultatif. Booster les spécifications pour mettre en avant certains documents.
modalityConfigs[]	object (ModalityConfig) Facultatif. Configurations de modalités pour le data store.
filterParameterBehavior	enum (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 (DataStoreSource) Facultatif. Recherchez dans un seul DataStore spécifique.
engineSource	object (EngineSource) Facultatif. Rechercher dans un moteur (potentiellement dans plusieurs DataStores).

DataStoreSource

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

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

Champs
name	string Obligatoire. Nom complet de la ressource DataStore. Format : projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
type	enum (DataStoreType) Uniquement en sortie. Type du data store. Ce champ est en lecture seule et renseigné par le serveur.
documentProcessingMode	enum (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 (ConnectorConfig) Uniquement en sortie. Configuration du connecteur pour la connexion au data store.

ConnectorConfig

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.

EngineSource

Représentation JSON
{ "engine": string, "dataStoreSources": [ { object (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 (DataStoreSource) Facultatif. Utilisez-le pour cibler des DataStores spécifiques dans le moteur. Si ce champ est vide, la recherche s'applique à tous les DataStores associés au moteur.
filter	string Facultatif. Filtre appliqué à la recherche dans le moteur. Sans intérêt et non utilisé si "data_store_sources" est fourni. Consultez https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata.

BoostSpecs

Représentation JSON
{ "dataStores": [ string ], "spec": [ { object (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 (BoostSpec) Obligatoire. Liste des spécifications de boosting.

BoostSpec

Représentation JSON
{ "conditionBoostSpecs": [ { object (ConditionBoostSpec) } ] }

Champs
conditionBoostSpecs[]	object (ConditionBoostSpec) Obligatoire. Liste des spécifications de boosting.

ConditionBoostSpec

Représentation JSON
{ "condition": string, "boost": number, "boostControlSpec": { object (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. Actuellement, 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 (BoostControlSpec) Facultatif. Spécification complexe pour le classement personnalisé basé sur la valeur de l'attribut définie par le client.

BoostControlSpec

Représentation JSON
{ "fieldName": string, "attributeType": enum (AttributeType), "interpolationType": enum (InterpolationType), "controlPoints": [ { object (ControlPoint) } ] }

Champs
fieldName	string Facultatif. Nom du champ dont la valeur sera utilisée pour déterminer le montant du boost.
attributeType	enum (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 spécifié par field_name. Dans le cas d'une valeur numérique, c'est simple : attribute_value = numerical_field_value. Dans le cas de la fraîcheur, attribute_value = (time.now() - datetime_field_value).
interpolationType	enum (InterpolationType) Facultatif. Type d'interpolation à appliquer pour relier les points de contrôle listés ci-dessous.
controlPoints[]	object (ControlPoint) Facultatif. Points de contrôle utilisés pour définir la courbe. La fonction monotone (définie par le biais de l'interpolation_type ci-dessus) passe par les points de contrôle listés ici.

ControlPoint

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.

ModalityConfig

Représentation JSON
{ "modalityType": enum (ModalityType), "rewriterConfig": { object (RewriterConfig) }, "summarizationConfig": { object (SummarizationConfig) }, "groundingConfig": { object (GroundingConfig) }, "snippetsConfig": { object (SnippetsConfig) } }

Champs
modalityType	enum (ModalityType) Obligatoire. Type de modalité.
rewriterConfig	object (RewriterConfig) Facultatif. Configuration du réécriveur.
summarizationConfig	object (SummarizationConfig) Facultatif. Configuration de la synthèse.
groundingConfig	object (GroundingConfig) Facultatif. Configuration de l'ancrage.
snippetsConfig	object (SnippetsConfig) Facultatif. Configuration des extraits.

RewriterConfig

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

SummarizationConfig

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.

GroundingConfig

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 d'ancrage de la réponse. Cela signifie que toutes les réponses dont le score d'ancrage est inférieur au seuil seront remplacées par des extraits pertinents uniquement. 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é.

SnippetsConfig

Représentation JSON
{ "enableSnippets": boolean, "maxSnippets": integer }

Champs
enableSnippets	boolean Facultatif. Indique si les extraits sont activés.
maxSnippets	integer Facultatif. Nombre d'extraits à renvoyer par requête. Si elle n'est pas définie, renvoie tous les extraits du service par défaut.

PythonFunction

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

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 (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 à server_address 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 (State) Uniquement en sortie. État de disponibilité dynamique de l'outil sur le serveur externe.

CustomHeadersEntry

Représentation JSON
{ "key": string, "value": string }

Champs
key	string
value	string

FileSearchTool

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

Champs
corpusType	enum (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}

SystemTool

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ésentation JSON
{ "name": string, "description": string, "agent": string }

Champs
name	string Obligatoire. Nom de l'outil de l'agent.
description	string Facultatif. Description de l'objectif de l'outil.
agent	string Facultatif. Nom de ressource de l'agent qui est le point d'entrée de l'outil. Format : projects/{project}/locations/{location}/agents/{agent}

WidgetTool

Représentation JSON
{ "name": string, "description": string, "widgetType": enum (WidgetType), "uiConfig": { object }, "dataMapping": { object (DataMapping) }, "textResponseConfig": { object (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 (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 (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 (TextResponseConfig) Facultatif. Configuration pour les 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.

DataMapping

Représentation JSON
{ "sourceToolName": string, "fieldMappings": { string: string, ... }, "pythonFunction": { object (PythonFunction) }, "mode": enum (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 (Mode) Facultatif. Mode du mappage de données.
pythonScript (deprecated)	string Cet élément est obsolète. Obsolète : utilisez plutôt python_function.

FieldMappingsEntry

Représentation JSON
{ "key": string, "value": string }

Champs
key	string
value	string

TextResponseConfig

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

Champs
type	enum (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.

RemoteAgentTool

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

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.
apiAuthentication	object (ApiAuthentication) Facultatif. Configuration de l'authentification pour appeler l'agent distant.

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

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

Champs
url	string Obligatoire. URL où cette interface est disponible. Vous devez saisir 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é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 compétence.
examples[]	string Exemples de requêtes ou de scénarios que cette compétence peut traiter.
inputModes[]	string Ensemble de types de supports d'entrée acceptés pour cette compétence, qui remplace les valeurs par défaut de l'agent.
outputModes[]	string Ensemble de types de supports de sortie acceptés pour cette compétence, qui remplace les valeurs par défaut de l'agent.

ToolFakeConfig

Représentation JSON
{ "enableFakeMode": boolean, // Union field tool_response can be only one of the following: "codeBlock": { object (CodeBlock) } // End of list of possible types for union field tool_response. }

Champs
enableFakeMode	boolean Facultatif. Indique si l'outil utilise le mode factice.
Champ d'union tool_response. La réponse est statique ou fournie par une fonction Python. tool_response ne peut être qu'un des éléments suivants :
codeBlock	object (CodeBlock) Facultatif. Bloc de code qui sera exécuté à la place d'un véritable appel d'outil.

CodeBlock

Représentation JSON
{ "pythonCode": string }

Champs

pythonCode

string Obligatoire. Code Python qui sera appelé en mode faux outil. Signature de la fonction Python attendue : pour intercepter tous les appels d'outil : def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: pour intercepter un appel d'outil spécifique : def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: si la fonction renvoie "None", le véritable outil sera appelé à la place.

Exemple

Représentation JSON
{ "name": string, "displayName": string, "description": string, "entryAgent": string, "messages": [ { object (Message) } ], "createTime": string, "updateTime": string, "invalid": boolean, "etag": string }

Champs
name	string Identifiant. Identifiant unique de l'exemple. Format : projects/{project}/locations/{location}/apps/{app}/examples/{example}
displayName	string Obligatoire. Nom à afficher de l'exemple.
description	string Facultatif. Description de l'exemple dans un format lisible.
entryAgent	string Facultatif. Agent qui gère initialement la conversation. Si aucune valeur n'est spécifiée, l'exemple représente une conversation gérée par l'agent racine. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
messages[]	object (Message) Facultatif. Ensemble des messages qui composent la conversation.
createTime	string (Timestamp format) Uniquement en sortie. Code temporel de la création de l'exemple. 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'exemple. 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".
invalid	boolean Uniquement en sortie. L'exemple peut devenir non valide si les ressources référencées sont supprimées. Les exemples non valides ne seront pas utilisés comme exemples few-shot.
etag	string Etag utilisé pour s'assurer que l'objet n'a pas été modifié lors d'une opération de lecture/modification/écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.

Message

Représentation JSON
{ "role": string, "chunks": [ { object (Chunk) } ], "eventTime": string }

Champs
role	string Facultatif. Rôle dans la conversation (utilisateur, agent, etc.).
chunks[]	object (Chunk) Facultatif. Contenu du message sous forme de série de blocs.
eventTime	string (Timestamp format) Facultatif. Code temporel de l'envoi ou de la réception du message. Ne doit pas être utilisé si le message fait partie d'un example. 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".

Bloc

Représentation JSON

{ // Union field data can be only one of the following: "text": string, "transcript": string, "blob": { object (Blob) }, "payload": { object }, "image": { object (Image) }, "toolCall": { object (ToolCall) }, "toolResponse": { object (ToolResponse) }, "agentTransfer": { object (AgentTransfer) }, "updatedVariables": { object }, "defaultVariables": { object } // End of list of possible types for union field data. }

Champs
Champ d'union data. Regroupez les données. data ne peut être qu'un des éléments suivants :
text	string Facultatif. Données textuelles.
transcript	string Facultatif. Transcription associée à l'élément audio.
blob	object (Blob) Facultatif. Données blob.
payload	object (Struct format) Facultatif. Données de charge utile personnalisées.
image	object (Image) Facultatif. Données d'image.
toolCall	object (ToolCall) Facultatif. Requête d'exécution d'outil.
toolResponse	object (ToolResponse) Facultatif. Réponse à l'exécution de l'outil.
agentTransfer	object (AgentTransfer) Facultatif. Événement de transfert d'agent.
updatedVariables	object (Struct format) Une structure représente les variables qui ont été mises à jour dans la conversation, avec les noms de variables comme clés.
defaultVariables	object (Struct format) Une structure représente les variables par défaut au début de la conversation, avec les noms de variables comme clés.

Blob

Représentation JSON
{ "mimeType": string, "data": string }

Champs
mimeType	string Obligatoire. Type MIME standard IANA des données sources.
data	string (bytes format) Obligatoire. Octets bruts du blob. Chaîne encodée en base64.

Image

Représentation JSON
{ "mimeType": string, "data": string }

Champs
mimeType	string Obligatoire. Type MIME standard IANA des données sources. Les types d'images acceptés sont les suivants : * image/png * image/jpeg * image/webp
data	string (bytes format) Obligatoire. Octets bruts de l'image. Chaîne encodée en base64.

ToolCall

Représentation JSON
{ "id": string, "displayName": string, "args": { object }, "parentToolCallId": string, "agentName": string, // Union field tool_identifier can be only one of the following: "tool": string, "toolsetTool": { object (ToolsetTool) } // End of list of possible types for union field tool_identifier. }

Champs
id	string Facultatif. Identifiant unique de l'appel d'outil. Si cette valeur est renseignée, le client doit renvoyer le résultat de l'exécution avec l'identifiant de mise en correspondance dans ToolResponse.
displayName	string Uniquement en sortie. Nom à afficher de l'outil.
args	object (Struct format) Facultatif. Paramètres et valeurs d'entrée de l'outil au format d'objet JSON.
parentToolCallId	string Uniquement en sortie. ID de l'appel d'outil qui a déclenché celui-ci, lorsqu'il a été émis par un sous-agent travaillant pour le compte d'un appel parent. Vide pour les appels de premier niveau. Permet à un client de regrouper le travail d'un sous-agent sous l'appel qui l'a déclenché au lieu de rendre chaque étape en tant que frère.
agentName	string Uniquement en sortie. Nom lisible de l'agent qui a émis cet appel, par exemple "Architecte de contrat". Vide lorsque l'agent racine l'a émis.
Champ d'union tool_identifier. Identifiant de l'outil à exécuter. Il peut s'agir d'un outil persistant ou d'un outil d'un ensemble d'outils. tool_identifier ne peut être qu'un des éléments suivants :
tool	string Facultatif. Nom de l'outil à exécuter. Format : projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool	object (ToolsetTool) Facultatif. Outil de l'ensemble d'outils à exécuter.

ToolsetTool

Représentation JSON
{ "toolset": string, "toolId": string }

Champs
toolset	string Obligatoire. Nom de ressource de l'ensemble d'outils à partir duquel cet outil est dérivé. Format : projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
toolId	string Facultatif. ID de l'outil permettant de filtrer les outils pour récupérer le schéma.

ToolResponse

Représentation JSON
{ "id": string, "displayName": string, "response": { object }, "parentToolCallId": string, "agentName": string, // Union field tool_identifier can be only one of the following: "tool": string, "toolsetTool": { object (ToolsetTool) } // End of list of possible types for union field tool_identifier. }

Champs
id	string Facultatif. ID correspondant du tool call auquel la réponse se rapporte.
displayName	string Uniquement en sortie. Nom à afficher de l'outil.
response	object (Struct format) Obligatoire. Résultat de l'exécution de l'outil au format d'objet JSON. Utilisez la clé "output" pour spécifier la réponse de l'outil et la clé "error" pour spécifier les détails de l'erreur (le cas échéant). Si les clés "output" et "error" ne sont pas spécifiées, l'ensemble de la "response" est traité comme le résultat de l'exécution de l'outil.
parentToolCallId	string Uniquement en sortie. ID de l'appel d'outil qui a déclenché celui-ci, lorsqu'il a été émis par un sous-agent travaillant pour le compte d'un appel parent. Vide pour les appels de premier niveau. Permet à un client de regrouper le travail d'un sous-agent sous l'appel qui l'a déclenché au lieu de rendre chaque étape en tant que frère.
agentName	string Uniquement en sortie. Nom lisible de l'agent qui a émis cet appel, par exemple "Architecte de contrat". Vide lorsque l'agent racine l'a émis.
Champ d'union tool_identifier. Identifiant de l'outil qui a été exécuté. Il peut s'agir d'un outil persistant ou d'un outil d'un ensemble d'outils. tool_identifier ne peut être qu'un des éléments suivants :
tool	string Facultatif. Nom de l'outil à exécuter. Format : projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool	object (ToolsetTool) Facultatif. Outil de l'ensemble d'outils qui a été exécuté.

AgentTransfer

Représentation JSON
{ "targetAgent": string, "displayName": string }

Champs
targetAgent	string Obligatoire. Agent auquel la conversation est transférée. L'agent prendra le relais à partir de ce moment. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
displayName	string Uniquement en sortie. Nom à afficher de l'agent.

Garde-fou

Représentation JSON

{ "name": string, "displayName": string, "description": string, "enabled": boolean, "action": { object (TriggerAction) }, "createTime": string, "updateTime": string, "etag": string, // Union field guardrail_type can be only one of the following: "contentFilter": { object (ContentFilter) }, "llmPromptSecurity": { object (LlmPromptSecurity) }, "llmPolicy": { object (LlmPolicy) }, "modelSafety": { object (ModelSafety) }, "codeCallback": { object (CodeCallback) } // End of list of possible types for union field guardrail_type. }

Champs
name	string Identifiant. Identifiant unique du garde-fou. Format : projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
displayName	string Obligatoire. Nom à afficher de la barrière de sécurité.
description	string Facultatif. Description du garde-fou.
enabled	boolean Facultatif. Indique si le garde-fou est activé.
action	object (TriggerAction) Facultatif. Action à effectuer lorsque le garde-fou est déclenché.
createTime	string (Timestamp format) Uniquement en sortie. Code temporel de la création du garde-fou. 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 du garde-fou. 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 été modifié lors d'une opération de lecture/modification/écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.
Champ d'union guardrail_type. Type de garde-fou. guardrail_type ne peut être qu'un des éléments suivants :
contentFilter	object (ContentFilter) Facultatif. Garde-fou qui interdit l'utilisation de certains contenus dans la conversation.
llmPromptSecurity	object (LlmPromptSecurity) Facultatif. Garde-fou qui bloque la conversation si la requête est considérée comme non sécurisée en fonction de la classification du LLM.
llmPolicy	object (LlmPolicy) Facultatif. Garde-fou qui bloque la conversation si la réponse du LLM est considérée comme enfreignant le règlement en fonction de la classification du LLM.
modelSafety	object (ModelSafety) Facultatif. Garde-fou qui bloque la conversation si la réponse du LLM est considérée comme non sécurisée en fonction des paramètres de sécurité du modèle.
codeCallback	object (CodeCallback) Facultatif. Garde-fou qui bloque potentiellement la conversation en fonction du résultat de l'exécution du rappel.

ContentFilter

Représentation JSON
{ "bannedContents": [ string ], "bannedContentsInUserInput": [ string ], "bannedContentsInAgentResponse": [ string ], "matchType": enum (MatchType), "disregardDiacritics": boolean }

Champs
bannedContents[]	string Facultatif. Liste des expressions interdites. S'applique aux entrées utilisateur et aux réponses de l'agent.
bannedContentsInUserInput[]	string Facultatif. Liste des expressions interdites. Ne s'applique qu'aux entrées utilisateur.
bannedContentsInAgentResponse[]	string Facultatif. Liste des expressions interdites. Ne s'applique qu'aux réponses des agents.
matchType	enum (MatchType) Obligatoire. Type de correspondance pour le filtre de contenu.
disregardDiacritics	boolean Facultatif. Si la valeur est "true", les signes diacritiques sont ignorés lors de la mise en correspondance.

LlmPromptSecurity

Représentation JSON
{ "failOpen": boolean, // Union field security_config can be only one of the following: "defaultSettings": { object (DefaultSecuritySettings) }, "customPolicy": { object (LlmPolicy) } // End of list of possible types for union field security_config. }

Champs
failOpen	boolean Facultatif. Détermine le comportement lorsque le garde-fou rencontre une erreur LLM. - Si la valeur est "true", le garde-fou est contourné. - Si la valeur est "false" (par défaut), la barrière de sécurité se déclenche/bloque. Remarque : Si une règle personnalisée est fournie, ce champ est ignoré au profit de la configuration "fail_open" de la règle.
Champ d'union security_config. Définit le mode de configuration de la sécurité. L'utilisateur doit choisir l'une des configurations suivantes. security_config ne peut être qu'un des éléments suivants :
defaultSettings	object (DefaultSecuritySettings) Facultatif. Utilisez les paramètres de sécurité par défaut prédéfinis du système. Pour sélectionner ce mode, incluez un message "default_settings" vide dans la requête. Le champ "default_prompt_template" sera renseigné par le serveur dans la réponse.
customPolicy	object (LlmPolicy) Facultatif. Utilisez une LlmPolicy définie par l'utilisateur pour configurer le garde-fou de sécurité.

DefaultSecuritySettings

Représentation JSON
{ "defaultPromptTemplate": string }

Champs
defaultPromptTemplate	string Uniquement en sortie. Modèle de prompt par défaut utilisé par le système. Ce champ est destiné à afficher l'invite que le système utilise par défaut. OUTPUT_ONLY.

LlmPolicy

Représentation JSON
{ "maxConversationMessages": integer, "modelSettings": { object (ModelSettings) }, "prompt": string, "policyScope": enum (PolicyScope), "failOpen": boolean, "allowShortUtterance": boolean }

Champs
maxConversationMessages	integer Facultatif. Lorsque vous vérifiez cette règle, tenez compte des "n" derniers messages de la conversation. Si aucune valeur n'est définie, la valeur par défaut de 10 sera utilisée.
modelSettings	object (ModelSettings) Facultatif. Paramètres du modèle.
prompt	string Obligatoire. Invite concernant les règles.
policyScope	enum (PolicyScope) Obligatoire. Définit le moment où la vérification des règles doit être appliquée pendant la conversation. Si elle est définie sur POLICY_SCOPE_UNSPECIFIED, la règle s'applique à l'entrée utilisateur. Lorsque vous appliquez la règle à la réponse de l'agent, une latence supplémentaire est introduite avant que l'agent puisse répondre.
failOpen	boolean Facultatif. Si une erreur se produit lors de la vérification des règles, ouvrez le système et ne déclenchez pas le garde-fou.
allowShortUtterance	boolean Facultatif. Par défaut, la vérification des règles LLM est ignorée pour les énoncés courts. Si vous activez ce paramètre, la vérification des règles s'applique à toutes les expressions, y compris celles qui seraient normalement ignorées.

ModelSafety

Représentation JSON
{ "safetySettings": [ { object (SafetySetting) } ] }

Champs
safetySettings[]	object (SafetySetting) Obligatoire. Liste des paramètres de sécurité.

SafetySetting

Représentation JSON
{ "category": enum (HarmCategory), "threshold": enum (HarmBlockThreshold) }

Champs
category	enum (HarmCategory) Obligatoire. Catégorie de préjudice.
threshold	enum (HarmBlockThreshold) Obligatoire. Seuil de blocage de préjudice.

CodeCallback

Représentation JSON
{ "beforeAgentCallback": { object (Callback) }, "afterAgentCallback": { object (Callback) }, "beforeModelCallback": { object (Callback) }, "afterModelCallback": { object (Callback) } }

Champs
beforeAgentCallback	object (Callback) Facultatif. Rappel à exécuter avant l'appel de l'agent. Chaque fonction de rappel doit renvoyer une structure (par exemple, un dict ou un objet) contenant au moins : - "decision" : "OK" ou "TRIGGER". - "reason" : chaîne expliquant la décision. Une décision "DÉCLENCHEMENT" peut interrompre le traitement.
afterAgentCallback	object (Callback) Facultatif. Rappel à exécuter après l'appel de l'agent. Chaque fonction de rappel doit renvoyer une structure (par exemple, un dict ou un objet) contenant au moins : - "decision" : "OK" ou "TRIGGER". - "reason" : chaîne expliquant la décision. Une décision "DÉCLENCHEMENT" peut interrompre le traitement.
beforeModelCallback	object (Callback) Facultatif. Rappel à exécuter avant l'appel du modèle. Si le modèle est appelé plusieurs fois, le rappel sera exécuté plusieurs fois. Chaque fonction de rappel doit renvoyer une structure (par exemple, un dict ou un objet) contenant au moins : - "decision" : "OK" ou "TRIGGER". - "reason" : chaîne expliquant la décision. Une décision "DÉCLENCHEMENT" peut interrompre le traitement.
afterModelCallback	object (Callback) Facultatif. Rappel à exécuter après l'appel du modèle. Si le modèle est appelé plusieurs fois, le rappel sera exécuté plusieurs fois. Chaque fonction de rappel doit renvoyer une structure (par exemple, un dict ou un objet) contenant au moins : - "decision" : "OK" ou "TRIGGER". - "reason" : chaîne expliquant la décision. Une décision "DÉCLENCHEMENT" peut interrompre le traitement.

TriggerAction

Représentation JSON
{ // Union field action can be only one of the following: "respondImmediately": { object (RespondImmediately) }, "transferAgent": { object (TransferAgent) }, "generativeAnswer": { object (GenerativeAnswer) } // End of list of possible types for union field action. }

Champs
Champ d'union action. Action à effectuer. action ne peut être qu'un des éléments suivants :
respondImmediately	object (RespondImmediately) Facultatif. Répondez immédiatement avec une réponse préconfigurée.
transferAgent	object (TransferAgent) Facultatif. transférer la conversation à un autre agent ;
generativeAnswer	object (GenerativeAnswer) Facultatif. Répondez avec une réponse générative.

RespondImmediately

Représentation JSON
{ "responses": [ { object (Response) } ] }

Champs
responses[]	object (Response) Obligatoire. Réponses standardisées parmi lesquelles l'agent peut choisir. La réponse est choisie au hasard.

Réponse

Représentation JSON
{ "text": string, "disabled": boolean }

Champs
text	string Obligatoire. Texte auquel l'agent doit répondre.
disabled	boolean Facultatif. Indique si la réponse est désactivée. L'agent n'utilise pas les réponses désactivées.

TransferAgent

Représentation JSON
{ "agent": string }

Champs
agent	string Obligatoire. Nom de l'agent vers lequel transférer la conversation. L'agent doit se trouver dans la même application que l'agent actuel. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}

GenerativeAnswer

Représentation JSON
{ "prompt": string }

Champs
prompt	string Obligatoire. Requête à utiliser pour la réponse générative.

Ensemble d'outils

Représentation JSON

{ "name": string, "displayName": string, "description": string, "timeout": string, "createTime": string, "updateTime": string, "etag": string, "executionType": enum (ExecutionType), "toolFakeConfig": { object (ToolFakeConfig) }, // Union field toolset_type can be only one of the following: "mcpToolset": { object (McpToolset) }, "openApiToolset": { object (OpenApiToolset) }, "connectorToolset": { object (ConnectorToolset) } // End of list of possible types for union field toolset_type. }

Champs
name	string Identifiant. Identifiant unique de l'ensemble d'outils. Format : projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
displayName	string Facultatif. Nom à afficher de l'ensemble d'outils. Doit être unique dans la même application.
description	string Facultatif. Description de l'ensemble d'outils.
timeout	string (Duration format) Facultatif. Délai d'exécution de l'ensemble d'outils. Si ce paramètre n'est pas défini, le délai d'inactivité par défaut est de 30 secondes pour les ensembles d'outils SYNCHRONOUS et de 60 secondes pour les ensembles d'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'ensemble d'outils. 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'ensemble d'outils. 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 été modifié lors d'une opération de lecture/modification/écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.
executionType	enum (ExecutionType) Facultatif. Type d'exécution des outils dans l'ensemble d'outils.
toolFakeConfig	object (ToolFakeConfig) Facultatif. Configuration du comportement des outils en mode simulation.
Champ d'union toolset_type. Type de l'ensemble d'outils. toolset_type ne peut être qu'un des éléments suivants :
mcpToolset	object (McpToolset) Facultatif. Ensemble d'outils contenant une liste d'outils proposés par le serveur MCP.
openApiToolset	object (OpenApiToolset) Facultatif. Ensemble d'outils contenant une liste d'outils définis par un schéma OpenAPI.
connectorToolset	object (ConnectorToolset) Facultatif. Ensemble d'outils qui génère des outils à partir d'une connexion Integration Connectors.

McpToolset

Représentation JSON
{ "serverAddress": string, "apiAuthentication": { object (ApiAuthentication) }, "serviceDirectoryConfig": { object (ServiceDirectoryConfig) }, "tlsConfig": { object (TlsConfig) }, "customHeaders": { string: string, ... }, "toolOverrides": [ { object (McpToolOverride) } ] }

Champs
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. 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 accéder aux outils et exécuter un 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.
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.
tlsConfig	object (TlsConfig) Facultatif. Configuration TLS. Inclut les certificats de serveur personnalisés auxquels le client doit faire confiance.
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" }.
toolOverrides[]	object (McpToolOverride) Facultatif. Remplacements pour les outils individuels de cet ensemble d'outils. Cela permet de remplacer des détails spécifiques tels que les descriptions ou les noms, ou d'épingler les états des outils afin qu'ils ne soient pas entièrement dynamiques.

CustomHeadersEntry

Représentation JSON
{ "key": string, "value": string }

Champs
key	string
value	string

McpToolOverride

Représentation JSON
{ "tool": string, "nameOverride": string, "descriptionOverride": string, "snapshot": { object (McpToolDefinition) } }

Champs
tool	string Obligatoire. Nom d'origine de l'outil tel qu'il est émis par le serveur MCP.
nameOverride	string Facultatif. Si ce nom est présent, l'outil l'utilise dans l'agent au lieu du nom d'origine. Il est principalement utilisé comme alias si le serveur MCP propose des outils mal nommés.
descriptionOverride	string Facultatif. Si elle est présente, cet outil utilise cette description au lieu de la description d'origine du serveur.
snapshot	object (McpToolDefinition) Uniquement en sortie. Si cet outil est présent, il est "épinglé" et utilise les valeurs du snapshot comme valeurs de remplacement si le serveur devient temporairement indisponible ou si aucun remplacement n'est présent.

McpToolDefinition

Représentation JSON
{ "description": string, "inputSchema": { object (Schema) }, "outputSchema": { object (Schema) } }

Champs
description	string Uniquement en sortie. Description de l'outil MCP. Cette valeur peut être remplacée par description_override dans McpToolOverride.
inputSchema	object (Schema) Uniquement en sortie. Schéma des arguments d'entrée de l'outil MCP.
outputSchema	object (Schema) Uniquement en sortie. Schéma des arguments de sortie de l'outil MCP.

OpenApiToolset

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

Champs
openApiSchema	string Obligatoire. Schéma OpenAPI de l'ensemble d'outils.
apiAuthentication	object (ApiAuthentication) Facultatif. Informations d'authentification requises par l'API.
tlsConfig	object (TlsConfig) Facultatif. Configuration TLS. Inclut les certificats de serveur personnalisés
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 pour toutes les opérations définies dans le schéma OpenAPI.
url	string Facultatif. URL du serveur du schéma Open API. Ce champ n'est défini dans les ensembles d'outils que dans les dépendances d'environnement lors du processus d'exportation 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.

ConnectorToolset

Représentation JSON
{ "connection": string, "authConfig": { object (EndUserAuthConfig) }, "connectorActions": [ { object (Action) } ] }

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}
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 l'ensemble d'outils échouera. Consultez https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override.
connectorActions[]	object (Action) Obligatoire. Liste des actions de connecteur/opérations d'entité pour lesquelles générer des outils.

PrebuiltAmbientNoise

Bruit ambiant prédéfini.

Enums
PREBUILT_AMBIENT_NOISE_UNSPECIFIED	Non spécifié.
RETAIL_STORE	Bruit ambiant d'un magasin.
CONVENTION_HALL	Bruit ambiant d'une salle de congrès.
OUTDOOR	Bruit ambiant d'une rue.

ErrorHandlingStrategy

Définit la stratégie de gestion des erreurs.

Enums
ERROR_HANDLING_STRATEGY_UNSPECIFIED	Stratégie de gestion des exceptions non spécifiée.
NONE	Aucune gestion spécifique n'est activée.
FALLBACK_RESPONSE	Un message de secours sera renvoyé à l'utilisateur en cas d'erreur système (par exemple, erreur de LLM).
END_SESSION	Un signal EndSession sera émis en cas d'erreur système (par exemple, erreur LLM).

ToolExecutionMode

Définit le comportement d'exécution de l'outil si l'agent sélectionne plusieurs outils en même temps.

Enums
TOOL_EXECUTION_MODE_UNSPECIFIED	Mode d'exécution de l'outil non spécifié. La valeur par défaut est "PARALLEL".
PARALLEL	Si plusieurs outils sont sélectionnés, ils seront exécutés en parallèle, avec le même ToolContext.
SEQUENTIAL	Si plusieurs outils sont sélectionnés, ils seront exécutés séquentiellement. L'outil suivant ne sera exécuté qu'une fois l'outil précédent terminé et pourra voir le ToolContext mis à jour de l'outil précédent.

SemanticSimilarityChannel

Canal de similarité sémantique à utiliser.

Enums
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED	Métrique non spécifiée. La valeur par défaut est TEXT.
TEXT	Utilisez la similarité sémantique du texte.
AUDIO	Utilisez la similarité sémantique audio.

ExtraToolCallBehavior

Définit le comportement lorsqu'un appel d'outil supplémentaire est rencontré. Un appel d'outil supplémentaire est un appel d'outil présent dans l'exécution, mais qui ne correspond à aucun appel d'outil dans l'attente de référence.

Enums
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED	Comportement non spécifié. La valeur par défaut est "FAIL".
FAIL	Échoue l'évaluation si un appel d'outil supplémentaire est rencontré.
ALLOW	Autorisez l'appel d'outil supplémentaire.

HallucinationMetricBehavior

Comportement de la métrique d'hallucination. Quel que soit le comportement, la métrique sera toujours calculée. La différence est que, lorsqu'elle est désactivée, la métrique n'est pas utilisée pour calculer le score d'évaluation global.

Enums
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED	Comportement non spécifié de la métrique d'hallucination.
DISABLED	Désactivez la métrique d'hallucination.
ENABLED	Activez la métrique d'hallucination.

Type

Types de données OpenAPI.

Enums
TYPE_UNSPECIFIED	Type non spécifié
STRING	Type de chaîne.
INTEGER	Type entier.
NUMBER	Type de nombre.
BOOLEAN	Type booléen.
OBJECT	Type d'objet.
ARRAY	Type de tableau.

NullValue

Représente un null JSON.

NullValue est une sentinelle qui utilise une énumération avec une seule valeur pour représenter la valeur nulle de l'union de type Value.

Un champ de type NullValue avec une valeur autre que 0 est considéré comme non valide. La plupart des sérialiseurs ProtoJSON émettent un Value avec un null_value défini comme null JSON, quelle que soit la valeur entière, et effectuent donc un aller-retour vers une valeur 0.

Enums
NULL_VALUE	Valeur nulle.

Type

Type de moteur. Consultez la documentation disponible sur https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType et https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

Enums
TYPE_UNSPECIFIED	Type de moteur non spécifié.
ENGINE_TYPE_SEARCH	Moteur SOLUTION_TYPE_SEARCH pour l'application. Tous les datastores de connecteurs ajoutés à l'application seront ajoutés à ce moteur.
ENGINE_TYPE_CHAT	Type de moteur de chat. Moteur SOLUTION_TYPE_CHAT pour l'application. Tous les data stores de connecteurs ajoutés à l'application seront ajoutés à ce moteur.

ChannelType

Type de profil de chaîne.

Enums
UNKNOWN	Type de canal inconnu.
WEB_UI	Canal de l'UI Web.
API	Canal API.
TWILIO	Canal Twilio.
GOOGLE_TELEPHONY_PLATFORM	Chaîne de la plate-forme de téléphonie Google.
CONTACT_CENTER_AS_A_SERVICE	Canal Contact Center as a Service (CCaaS).
CONTACT_CENTER_AS_A_SERVICE_CHAT	Canal Contact Center as a Service (CCaaS Chat).
FIVE9	Canal Five9.
CONTACT_CENTER_INTEGRATION	Canal d'intégration de centre de contact tiers.
WHATSAPP	Canal WhatsApp.
INSTAGRAM	Canal Instagram.

Persona

Personnalité de la chaîne.

Enums
UNKNOWN	Persona UNKNOWN.
CONCISE	L'agent fournit des réponses concises et précises.
CHATTY	L'agent fournit du contexte, des explications et des détails supplémentaires.

Modalité

Modalité du widget Web.

Enums
MODALITY_UNSPECIFIED	Modalité inconnue.
CHAT_AND_VOICE	Le widget est compatible avec la saisie par chat et vocale.
VOICE_ONLY	Le widget n'accepte que la saisie vocale.
CHAT_ONLY	Le widget n'accepte que les entrées de chat.
CHAT_VOICE_AND_VIDEO	Le widget accepte les entrées de chat, vocales et vidéo.

Thème

Thème du widget Web.

Enums
THEME_UNSPECIFIED	Thème inconnu.
LIGHT	Thème clair.
DARK	le thème sombre.

Direction

Sens du transfert.

Enums
DIRECTION_UNSPECIFIED	Direction non spécifiée.
PARENT_TO_CHILD	Transférez l'agent parent vers l'agent enfant.
CHILD_TO_PARENT	Transférez l'agent enfant vers l'agent parent.

RequestLocation

l'emplacement de la clé API dans la requête ;

Enums
REQUEST_LOCATION_UNSPECIFIED	Non spécifié. Cette valeur ne doit pas être utilisée.
HEADER	Représente la clé dans l'en-tête HTTP.
QUERY_STRING	Représente la clé dans la chaîne de requête.

OauthGrantType

Types d'attribution OAuth. Seule l'attribution d'identifiants client est acceptée.

Enums
OAUTH_GRANT_TYPE_UNSPECIFIED	Non spécifié. La valeur par défaut est CLIENT_CREDENTIAL.
CLIENT_CREDENTIAL	Représente le flux d'identifiants client.

OperationType

Opération à effectuer sur l'entité.

Enums
OPERATION_TYPE_UNSPECIFIED	Type d'opération non spécifié. Non valide. La création ou la mise à jour de ConnectorTool échouera.
LIST	Opération de liste.
GET	Obtenir une opération.
CREATE	Opération de création.
UPDATE	Opération de mise à jour.
DELETE	Supprimer une opération.

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

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.

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 sera la valeur réelle du champ numérique pour lequel boost_amount 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 indiqué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.

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.

ModalityType

Type de modalité.

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

FilterParameterBehavior

Comportement des paramètres de filtre.

Enums
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED	Comportement par défaut du filtre. Incluez le paramètre de filtre pour les data stores du connecteur. Pour les autres types de magasins de données, le paramètre d'entrée du filtre est omis.
ALWAYS_INCLUDE	Incluez toujours un 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.

État

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 sur le serveur.

CorpusType

Type de 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.

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_CAROUSEL	Widget de carrousel de produits.
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 avancées 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 de rendez-vous.
CONTACT_FORM	Widget de formulaire de contact.

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 field_mappings pour transformer les données.
PYTHON_SCRIPT	Utilisez python_script pour transformer les données.

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.

ExecutionType

Type d'exécution de l'outil ou de l'ensemble d'outils.

Enums
EXECUTION_TYPE_UNSPECIFIED	Le type d'exécution n'est pas spécifié. Prend la valeur SYNCHRONOUS par défaut s'il n'est pas spécifié.
SYNCHRONOUS	L'outil est exécuté de manière synchrone. La session est bloquée jusqu'à ce que l'outil renvoie une réponse.
ASYNCHRONOUS	L'outil est exécuté de manière asynchrone. La session se poursuivra pendant l'exécution de l'outil.

MatchType

Type de correspondance pour le filtre de contenu.

Enums
MATCH_TYPE_UNSPECIFIED	Le type de correspondance n'est pas spécifié.
SIMPLE_STRING_MATCH	Le contenu est mis en correspondance pour les sous-chaînes caractère par caractère.
WORD_BOUNDARY_STRING_MATCH	Le contenu ne correspond que si le motif trouvé dans le texte est entouré de délimiteurs de mots. Les expressions interdites peuvent également contenir des délimiteurs de mots.
REGEXP_MATCH	Le contenu est mis en correspondance à l'aide de la syntaxe d'expression régulière.

PolicyScope

Définit le moment où la vérification des règles doit être appliquée pendant la conversation.

Enums
POLICY_SCOPE_UNSPECIFIED	Le champ d'application de la règle n'est pas spécifié.
USER_QUERY	La vérification des règles est déclenchée par l'entrée utilisateur.
AGENT_RESPONSE	La vérification des règles est déclenchée par la réponse de l'agent. L'application de ce champ d'application de la règle entraînera une latence supplémentaire avant que l'agent puisse répondre.
USER_QUERY_AND_AGENT_RESPONSE	La vérification des règles est déclenchée à la fois par les entrées utilisateur et par les réponses de l'agent. L'application de ce champ d'application de la règle entraînera une latence supplémentaire avant que l'agent puisse répondre.

HarmCategory

Catégorie de préjudice.

Enums
HARM_CATEGORY_UNSPECIFIED	La catégorie de préjudice n'est pas spécifiée.
HARM_CATEGORY_HATE_SPEECH	La catégorie de préjudice est "incitation à la haine".
HARM_CATEGORY_DANGEROUS_CONTENT	La catégorie de préjudice est "contenu dangereux".
HARM_CATEGORY_HARASSMENT	La catégorie de préjudice est "harcèlement".
HARM_CATEGORY_SEXUALLY_EXPLICIT	La catégorie de préjudice est "contenu à caractère sexuel explicite".
HARM_CATEGORY_PROFANITY	La catégorie de préjudice est "propos obscènes".
HARM_CATEGORY_TOXIC	La catégorie de préjudice est "contenu toxique".

HarmBlockThreshold

Niveaux de seuil de probabilité pour le blocage.

Enums
HARM_BLOCK_THRESHOLD_UNSPECIFIED	Seuil de blocage de préjudice non spécifié.
BLOCK_LOW_AND_ABOVE	Bloquer les seuils faibles et supérieurs (augmenter le nombre de blocages).
BLOCK_MEDIUM_AND_ABOVE	Bloquer les seuils moyens et supérieurs.
BLOCK_ONLY_HIGH	Bloquer uniquement les seuils élevés (réduire le nombre de blocage).
BLOCK_NONE	Ne rien bloquer.
OFF	Désactivez le filtre de sécurité.

Annotations d'outils

Les annotations d'outil sont envoyées aux clients MCP pour décrire le risque de base d'un outil donné. La plupart des clients traitent ces indices comme non fiables, mais ils peuvent être utilisés pour déterminer quand un message de confirmation peut être envoyé à un utilisateur.

En plus de la chaîne de titre, les indications booléennes suivantes sont définies comme suit :

• readOnlyHint : si la valeur est "true", l'outil ne modifie pas son environnement. Valeur par défaut : "false".
• destructiveHint : si la valeur est "true", l'outil peut effectuer des actions destructrices. Si la valeur est "false", l'outil ne peut effectuer que des actions d'ajout. Valeur par défaut : "true".
• idempotentHint : si la valeur est "true", appeler l'outil à plusieurs reprises avec les mêmes arguments n'aura aucun effet supplémentaire sur son environnement. Valeur par défaut : "false".
• openWorldHint : si la valeur est "true", l'outil peut interagir avec un "monde ouvert" d'entités externes. Si la valeur est "false", l'outil ne peut interagir qu'avec des entités internes. Par exemple, un outil de recherche Web serait en monde ouvert, tandis qu'un outil de mémoire ne le serait pas.

Indication de destruction : ✅ | Indication d'idempotence : ❌ | Indication de lecture seule : ❌ | Indication de monde ouvert : ❌