MCP Tools Reference: ces.googleapis.com

Outil : get_app_version

Récupère les détails de la version de l'application spécifiée.

L'exemple de code suivant montre comment utiliser curl pour appeler l'outil MCP get_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": "get_app_version",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Schéma d'entrée

Message de requête pour AgentService.GetAppVersion.

GetAppVersionRequest

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

string

Obligatoire. Nom de ressource de la version de l'application à récupérer.

Schéma de sortie

Dans 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,
  "updateTime": 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. La 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. Horodatage 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".

updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour 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 changé 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. Doit être compris entre -62135596800 et 253402300799 inclus (ce qui correspond à 0001-01-01T00:00:00Z à 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 garde-fous dans l'application.

toolsets[]

object (Toolset)

Facultatif. Liste des ensembles d'outils de 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 lisible par l'humain de l'application.

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 du modèle LLM par défaut pour l'application. Les ressources individuelles (par exemple, les agents, les garde-fous) peuvent remplacer ces configurations si nécessaire.

toolExecutionMode

enum (ToolExecutionMode)

Facultatif. Mode d'exécution de l'outil pour l'application. S'il n'est pas fourni, la valeur par défaut est PARALLEL.

evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

Facultatif. Seuils d'évaluation de 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 cette instruction pour configurer une identité ou une personnalité stable pour tous les agents.

guardrails[]

string

Facultatif. Liste des garde-fous de 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 canal 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 pertinentes sur les détails de l'application ou les utilisations prévues.

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 changé 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 de certificat client par défaut 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 aux ressources de l'application seront refusées.

validationErrors[]

string

Uniquement en sortie. Erreurs de 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 cette option est définie sur true, les agents de l'application utiliseront des instructions prédéfinies pour améliorer la gestion des entrées multilingues.

fallbackAction
(deprecated)

string

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 "escalate" ou "exit", 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, America/Los_Angeles, Europe/Paris).

AudioProcessingConfig

Représentation JSON
{
  "synthesizeSpeechConfigs": {
    string: {
      object (SynthesizeSpeechConfig)
    },
    ...
  },
  "bargeInConfig": {
    object (BargeInConfig)
  },
  "inactivityTimeout": string,
  "ambientSoundConfig": {
    object (AmbientSoundConfig)
  },
  "customVoiceSamples": [
    {
      object (CustomVoiceSample)
    }
  ]
}
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 vers SynthesizeSpeechConfig.

Si la configuration du code de langue spécifié est introuvable, la configuration 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 de 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 à se réengager. Si ce paramètre n'est pas défini, l'agent n'invitera pas l'utilisateur à se réengager.

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 à diffuser avec la réponse synthétisée de l'agent, afin d'améliorer le naturel de la conversation.

customVoiceSamples[]

object (CustomVoiceSample)

Facultatif. Configure des échantillons de voix personnalisés pour le clonage de voix.

SynthesizeSpeechConfigsEntry

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

string

value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

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

string

Facultatif. Nom de la voix. Si ce champ 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, consultez Voix et langues disponibles dans Cloud Text-to-Speech.

speakingRate

number

Facultatif. La vitesse d'élocution 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] renverront 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 voix lors de l'utilisation d'un modèle génératif.

BargeInConfig

Représentation JSON
{
  "disableBargeIn": boolean,
  "bargeInAwareness": boolean
}
Champs
disableBargeIn
(deprecated)

boolean

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 définie sur "true", l'entrée utilisateur pendant la lecture de la réponse de l'agent sera ignorée.

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 option 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 l'intervalle de temps. Doit être compris entre -315 576 000 000 et +315 576 000 000 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 seconde signées à une résolution de l'ordre de la nanoseconde de l'intervalle de temps. Les durées inférieures à une seconde sont représentées par un champ seconds de valeur 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. Doit être compris entre -999 999 999 et +999 999 999 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, dans la plage [-96,0, 16,0]. 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 à diffuser avec la réponse de l'agent synthétisée, pour améliorer le naturel de la conversation. source ne peut être qu'un des éléments suivants :
prebuiltAmbientNoise
(deprecated)

enum (PrebuiltAmbientNoise)

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 monocanal de 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 sur l'objet Cloud Storage.

prebuiltAmbientSound

string

Facultatif. Nom du son d'ambiance prédéfini. Les valeurs valides sont les suivantes : - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner"

CustomVoiceSample

Représentation JSON
{
  "name": string,
  "voiceSampleGcsUri": string,
  "consentAudioGcsUri": string,
  "voiceInstruction": string,
  "previewAudioContent": string,
  "previewText": string,
  "warnings": [
    {
      object (Warning)
    }
  ],
  "voiceInstructionMode": enum (VoiceInstructionMode)
}
Champs
name

string

Facultatif. Nom défini par l'utilisateur pour l'échantillon de voix personnalisée.

voiceSampleGcsUri

string

Facultatif. URI Cloud Storage de l'échantillon audio pour le clonage de voix. L'échantillon audio doit être un fichier WAV monocanal de 24 kHz.

consentAudioGcsUri

string

Facultatif. Audio de consentement pour le clonage vocal.

voiceInstruction

string

Facultatif. Instructions en langage naturel pour le style, le ton, le rythme ou la prononciation de la voix.

previewAudioContent

string (bytes format)

Uniquement en sortie. Aperçu audio synthétisé pour la voix personnalisée, au format WAV canonique (LINEAR16, 24 kHz, 16 bits, mono).

Chaîne encodée en base64.

previewText

string

Facultatif. Texte pour synthétiser l'aperçu audio d'une voix personnalisée.

warnings[]

object (Warning)

Uniquement en sortie. Messages d'avertissement rencontrés lors du traitement du clonage vocal (par exemple, niveau audio faible).

voiceInstructionMode

enum (VoiceInstructionMode)

Facultatif. Mode d'instruction pour l'extrait de voix. Si aucune valeur n'est spécifiée, la valeur par défaut est NO_INSTRUCTION.

Avertissement

Représentation JSON
{
  "message": string,
  "type": enum (WarningType)
}
Champs
message

string

Uniquement en sortie. Description lisible par l'humain de l'avertissement.

type

enum (WarningType)

Uniquement en sortie. Type d'avertissement.

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)
  },
  "requiredRecordingConsent": boolean
}
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 à une occultation, comme configuré dans RedactionConfig.

unredactedAudioRecordingConfig

object (AudioRecordingConfig)

Facultatif. Configure un enregistrement supplémentaire de l'audio non masqué. Cela peut être utile pour conserver une copie audio brute lorsque la suppression audio est 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 à une occultation, comme configuré 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 des tables BigQuery si cette option est activée.

cloudLoggingSettings

object (CloudLoggingSettings)

Facultatif. Paramètres décrivant les comportements de Cloud Logging pour l'application.

conversationLoggingSettings

object (ConversationLoggingSettings)

Facultatif. Paramètres décrivant 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 décrivant les comportements de collecte des données de conversation pour le pipeline d'analyse LLM de l'application.

requiredRecordingConsent

boolean

Facultatif. Si l'application doit indiquer ce qui peut être enregistré avant que quoi que ce soit ne soit conservé.

Si la valeur est "true", une session démarre avec l'enregistrement désactivé et reste désactivée jusqu'à ce que le client envoie SessionInput.recording_control, qui décide ensuite de chaque tour à partir de ce moment-là. Cela couvre l'enregistrement audio, l'historique des conversations, l'exportation BigQuery et Cloud Logging.

Lorsque la valeur est false (par défaut), les paramètres ci-dessus décident d'eux-mêmes et le client n'a rien à envoyer.

RedactionConfig

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

boolean

Facultatif. Si la valeur est true, l'occultation sera appliquée 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 pour 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. Le bucket Cloud Storage pour stocker les enregistrements audio de la session. 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 d'accès n'est pas spécifié, le préfixe par défaut $project/$location/$app/$date/$session/ sera 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. 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 ce champ n'est pas défini, 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 LLM. Si la valeur est "true", les données de conversation ne seront pas collectées pour les métriques d'analyse LLM. Sinon, les données de conversation seront collectées.

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, des 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 remplacement à 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 s'il faut escalader la session dans EndSession. Si la session est escaladée, metadata in EndSession contiendra 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,
  "thinkingLevel": enum (ThinkingLevel),

  // 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 ce champ n'est pas défini, l'agent héritera du modèle de son agent parent.

thinkingLevel

enum (ThinkingLevel)

Facultatif. Niveau de raisonnement du modèle.

Champ d'union _temperature.

_temperature ne peut être qu'un des éléments suivants :

temperature

number

Facultatif. Si elle est définie, cette température sera utilisée pour le modèle LLM. La température contrôle le degré de hasard des réponses du modèle. Des températures plus basses produisent des réponses plus prévisibles. Les températures plus élevées produisent 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 de référence.

hallucinationMetricBehavior
(deprecated)

enum (HallucinationMetricBehavior)

Facultatif. Obsolète : utilisez golden_hallucination_metric_behavior à la place. 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 de parole.

expectationLevelMetricsThresholds

object (ExpectationLevelMetricsThresholds)

Facultatif. Seuils des métriques au niveau de l'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 l'exactitude globale de l'appel d'outil. La valeur 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 l'exactitude des paramètres d'appel d'un outil individuel. La valeur 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 obligatoires 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. Indiquez que les éléments du tableau doivent être uniques. S'applique uniquement à 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 à 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. Autorise 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. Mappage de 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 compatibles avec 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 de nombre.

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))

Mappage non ordonné de valeurs saisies de manière dynamique.

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 saisies 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 canal.

channelType

enum (ChannelType)

Facultatif. Type du profil de canal.

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 vous souhaitez désactiver le DTMF (Dual-Tone Multi-Frequency).

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 par 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 l'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 canal. Les valeurs disponibles sont "low", "moderate", "high" et "very_high".

PersonaProperty

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

enum (Persona)

Facultatif. Le persona 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 le charge et n'autorise son chargement que s'il provient de la même origine ou de l'une des origines autorisées.

allowedOrigins[]

string

Facultatif. Origines autorisées à héberger le widget Web. Une origine est définie par la RFC 6454. Si ce champ est vide, toutes les origines sont autorisées. Vous ne pouvez pas indiquer 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 d'entreprise Meta récupéré.

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

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 d'entreprise Meta récupéré.

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

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 de secret Secret Manager stockant la phrase secrète pour déchiffrer la clé privée. Doit être laissé non défini 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 au port s'il est spécifié. Par exemple, "https://example.com" ou "https://example.com:443". Cette liste ne s'applique pas encore aux outils Python susceptibles d'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)
  },
  "remoteA2aAgent": {
    object (RemoteA2aAgent)
  }
  // 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 indiqués 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 indiqués 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 plusieurs appels sont effectués vers le modèle, 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 indiqués 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 plusieurs appels sont effectués vers le modèle, 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 indiqués 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. S'il y a plusieurs appels d'outils, 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 indiqués 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. S'il y a plusieurs appels d'outils, 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 indiqués 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. Horodatage 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 de l'agent. Format : projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

etag

string

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

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 de configuration ou erreurs dans l'agent susceptibles d'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 le rôle roles/dialogflow.client à l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

remoteA2aAgent

object (RemoteA2aAgent)

Facultatif. Agent A2A distant à utiliser pour l'exécution de l'agent.

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 la ressource d'agent Dialogflow. Format : projects/{project}/locations/{location}/agents/{agent}

flowId

string

Facultatif. ID du flux dans l'agent Dialogflow.

environmentId

string

Facultatif. ID d'environnement de l'agent Dialogflow à utiliser pour l'exécution de l'agent. Si aucune valeur n'est spécifiée, l'environnement de brouillon sera utilisé.

inputVariableMapping

map (key: string, value: string)

Facultatif. Mappage des noms des variables de l'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 des paramètres de session Dialogflow aux noms des 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 le paramètre allow_playback_interruption est défini 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

RemoteA2aAgent

Représentation JSON
{
  "a2aConfig": {
    object (RemoteA2aConfig)
  }
}
Champs
a2aConfig

object (RemoteA2aConfig)

Obligatoire. Configuration de la connexion A2A.

RemoteA2aConfig

Représentation JSON
{
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "inputVariableMapping": {
    string: string,
    ...
  },
  "outputVariableMapping": {
    string: string,
    ...
  },
  "streamingEnabled": boolean,
  "contextId": string,

  // Union field agent_spec can be only one of the following:
  "agentCard": {
    object (AgentCard)
  },
  "agentRegistry": string
  // End of list of possible types for union field agent_spec.
}
Champs
apiAuthentication

object (ApiAuthentication)

Facultatif. Configuration de l'authentification pour appeler l'agent distant. Facultatif si la référence du registre gère déjà l'authentification.

inputVariableMapping

map (key: string, value: string)

Facultatif. Mappage des noms de variables d'entrée de l'agent distant avec les noms de variables GECX.

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 variables de sortie de l'agent distant avec les noms de variables GECX.

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

streamingEnabled

boolean

Facultatif. Indique si le streaming est activé pour l'agent distant.

contextId

string

Facultatif. Si ce champ n'est pas vide, les interactions avec l'agent A2A distant utiliseront cet ID de contexte. Ce champ context_id peut faire référence à une variable de session telle que $context.variables.order_agent_session_id.

Champ d'union agent_spec. Spécification de l'agent distant. agent_spec ne peut être qu'un des éléments suivants :
agentCard

object (AgentCard)

Facultatif. Fiche d'agent complète définie de manière intégrée.

agentRegistry

string

Facultatif. Référence à l'agent dans Agent Registry. Format : projects/{project}/locations/{location}/agents/{agent}

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 unité de capacité qu'un agent peut exécuter. 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. Il doit s'agir d'une URL HTTPS absolue valide en production. Exemple : "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"

protocolBinding

string

Obligatoire. Liaison de protocole compatible avec cette URL. Il s'agit d'une chaîne de formulaire ouverte, qui peut être facilement étendue à d'autres liaisons de protocole. Les principaux formats officiellement compatibles 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 exposée par cette interface. 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 de la compétence lisible par l'humain.

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

inputModes[]

string

Ensemble de types de contenus multimédias d'entrée compatibles avec cette compétence, qui remplace les valeurs par défaut de l'agent.

outputModes[]

string

Ensemble de types de supports de sortie compatibles avec cette compétence, qui remplace les valeurs par défaut de l'agent.

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 de l'authentification par clé API.

oauthConfig

object (OAuthConfig)

Facultatif. Configuration pour OAuth.

serviceAgentIdTokenAuthConfig

object (ServiceAgentIdTokenAuthConfig)

Facultatif. Configuration de l'authentification par jeton d'ID générée à partir de l'agent de service CES.

serviceAccountAuthConfig

object (ServiceAccountAuthConfig)

Facultatif. Configuration de l'authentification du compte de service.

bearerTokenConfig

object (BearerTokenConfig)

Facultatif. Configuration de l'authentification par jeton de support.

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 du secret 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. Habilitations 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. Habilitations 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>.

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 par l'humain 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 cette option est activée, le rappel sera également exécuté sur les sorties de modèle intermédiaires. Ce paramètre n'affecte que le rappel "Après le modèle". À ACTIVER AVEC PRÉCAUTION. En règle générale, le rappel "Après le modèle" ne doit être exécuté qu'après la réception de toutes les réponses du modèle. L'activation de l'exécution proactive peut avoir un impact négatif sur le coût et la latence de l'exécution. Elle ne doit être activée que dans de rares situations.

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 pour 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 la règle s'applique. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}

direction

enum (Direction)

Obligatoire. Direction 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 l'appel à l'agent cible lorsque la condition est remplie.

disablePlannerTransfer

object (DisablePlannerTransfer)

Facultatif. Règle qui empêche le planificateur d'effectuer un transfert vers 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. 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 la valeur "true", le planificateur ne sera pas autorisé à effectuer un transfert vers 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)
  },
  "readOnly": boolean,

  // 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 ne fournissent que des sorties. Ils ne peuvent pas être référencés directement là où un outil est attendu.

displayName

string

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

executionType

enum (ExecutionType)

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

timeout

string (Duration format)

Facultatif. Délai avant expiration de l'exécution de l'outil. Si ce paramètre n'est pas défini, le délai avant expiration 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. Horodatage de la dernière mise à jour de l'outil.

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

etag

string

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

generatedSummary

string

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

toolFakeConfig

object (ToolFakeConfig)

Facultatif. Configuration du comportement de l'outil en mode fictif.

readOnly

boolean

Uniquement en sortie. Indique si l'outil est en lecture seule. Si la valeur est "true", l'utilisateur ne peut pas modifier l'outil.

Champ d'union tool_type. Type de l'outil. tool_type ne peut être qu'un des éléments suivants :
clientFunction

object (ClientFunction)

Facultatif. La fonction client.

openApiTool

object (OpenApiTool)

Facultatif. L'outil OpenAPI.

googleSearchTool

object (GoogleSearchTool)

Facultatif. L'outil de recherche Google.

connectorTool

object (ConnectorTool)

Facultatif. L'outil Integration Connectors.

dataStoreTool

object (DataStoreTool)

Facultatif. L'outil de data store.

pythonFunction

object (PythonFunction)

Facultatif. L'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. L'outil de recherche de fichiers.

systemTool

object (SystemTool)

Facultatif. L'outil système.

agentTool

object (AgentTool)

Facultatif. L'outil d'agent.

widgetTool

object (WidgetTool)

Facultatif. L'outil de 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 elle n'est pas fournie, la description de l'outil 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 OpenAPI. Ce champ n'est défini que dans les outils des dépendances de l'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.

TlsConfig

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

object (CaCert)

Obligatoire. Spécifie 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 peut être utilisé pour lever l'ambiguïté sur les certificats CA 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 du serveur HTTPS sont signés avec un "autre nom de l'objet". 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 de l'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 extrait directement de ces URL pour le contexte et l'ancrage. Exemple : "https://example.com/path.html". Vous pouvez ajouter jusqu'à 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 20 domaines au maximum.

excludeDomains[]

string

Facultatif. Liste des domaines à exclure des résultats de recherche. Exemple : "example.com". Vous pouvez exclure jusqu'à 2 000 domaines.

promptConfig

object (PromptConfig)

Facultatif. Instructions de requête 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 de l'interaction avec l'agent dans les conversations par chat. Si aucune valeur n'est définie, la requête par défaut sera utilisée.

voicePrompt

string

Facultatif. Définit la requête utilisée pour les instructions système lors de l'interaction avec l'agent dans les conversations vocales. Si aucune valeur n'est définie, la 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 par l'outil.

authConfig

object (EndUserAuthConfig)

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

name

string

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

description

string

Facultatif. Description de l'outil que l'agent peut utiliser pour décider d'appeler ou non ce 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 par 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 l'outil. 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é que l'outil doit utiliser.

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 par code d'autorisation OAuth 2.0.

oauth2JwtBearerConfig

object (Oauth2JwtBearerConfig)

Authentification par octroi 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 d'objet à 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 de data store.

description

string

Facultatif. Description de l'outil.

boostSpecs[]

object (BoostSpecs)

Facultatif. Spécification de boost pour booster certains documents.

modalityConfigs[]

object (ModalityConfig)

Facultatif. Configurations de modalité 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, soit un seul datastore, soit un moteur. search_source ne peut être qu'un des éléments suivants :
dataStoreSource

object (DataStoreSource)

Facultatif. Rechercher 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 de filtre pour le datastore. Consultez https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata.

dataStore

object (DataStore)

Facultatif. Le data store.

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 du 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 datastores PUBLIC_WEB et UNSTRUCTURED.

displayName

string

Uniquement en sortie. Nom à afficher du data store.

createTime

string (Timestamp format)

Uniquement en sortie. Code temporel 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 cette option 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. Non pertinent 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. Le datastore auquel la configuration de boosting est appliquée. Nom complet de la ressource du 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 de boost. 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 booster les suggestions dans les langues en ou fr : (lang_code: ANY("en", "fr"))

boost

number

Facultatif. Intensité du boosting, 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 la valeur sur 1.0 permet de promouvoir fortement les suggestions. Toutefois, cela ne signifie pas nécessairement que le meilleur résultat sera une suggestion boostée.

Définir la valeur sur -1.0 permet de rétrograder fortement les suggestions. Toutefois, d'autres suggestions pertinentes peuvent toujours s'afficher.

La valeur 0.0 signifie qu'aucun boost n'est appliqué. La condition de boosting est ignorée.

boostControlSpec

object (BoostControlSpec)

Facultatif. Spécification complexe pour le classement personnalisé en fonction de la valeur d'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 du boost. La valeur de l'attribut peut être dérivée de la valeur du champ field_name spécifié. Pour les valeurs numériques, c'est simple : attribute_value = numerical_field_value. Toutefois, dans le cas de la fraîcheur, attribute_value = (time.now() - datetime_field_value).

interpolationType

enum (InterpolationType)

Facultatif. Type d'interpolation à appliquer pour connecter 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 champ 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 une valeur parmi : 1. Valeur numérique du champ. 2. Spécification de la durée de l'actualisation : la valeur doit être au format XSD dayTimeDuration (un 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 de booster 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éécrivain.

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 du prompt. Si aucune valeur n'est définie, la 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 du prompt. Si aucune valeur n'est définie, la 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 est comprise dans une plage configurable de [1, 5]. Le niveau est utilisé pour définir le seuil d'ancrage de la réponse. Autrement dit, toutes les réponses dont le score d'ancrage est inférieur au seuil ne renverront que des extraits pertinents.

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

disabled

boolean

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

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 ce champ n'est pas défini, tous les extraits du service sont renvoyés 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 le nom n'est pas 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 se terminer par "/mcp/". Seuls les serveurs basés sur le transport HTTP en flux continu sont compatibles. Il s'agit de la même valeur que "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 de support, le jeton ne s'applique qu'à l'exécution de l'outil, et non à la liste des outils. Pour cela, les outils doivent pouvoir ê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 de l'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 du 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. Le 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 aucune valeur n'est spécifiée, le type par défaut est CUSTOMIZED.

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 des réponses textuelles toujours incluses.

Champ d'union input. Entrée de l'outil 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

Obsolète : utilisez python_function à la place.

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 de fourniture de la réponse textuelle.

staticText

string

Facultatif. Réponse textuelle statique à renvoyer lorsque le type est "STATIC".

textResponseInstruction

string

Facultatif. Instruction indiquant au LLM comment 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)
  },
  "statefulAgent": boolean,
  "inputVariableMapping": {
    string: string,
    ...
  },
  "outputVariableMapping": {
    string: string,
    ...
  }
}
Champs
name

string

Obligatoire. Nom de l'outil.

description

string

Obligatoire. Description de l'outil.

agentCard

object (AgentCard)

Obligatoire. Fiche de l'agent distant appelé par cet outil.

apiAuthentication

object (ApiAuthentication)

Facultatif. Configuration de l'authentification pour appeler l'agent distant.

statefulAgent

boolean

Facultatif. Lorsqu'elle est activée, l'interaction entre l'application CXAS et l'agent distant partage le même contexte. Si l'agent distant renvoie un context_id, il sera conservé pendant toute la durée de la session pour cet outil d'agent distant.

inputVariableMapping

map (key: string, value: string)

Facultatif. Mappage des noms de variables d'entrée de l'agent distant avec les noms de variables GECX.

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 variables de sortie de l'agent distant avec les noms de variables GECX.

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

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

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

Champ d'union tool_response. La réponse est soit statique, soit 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 fictif de l'outil. Signature de la fonction Python attendue : pour intercepter tous les appels d'outils : 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 lisible par l'humain de l'exemple.

entryAgent

string

Facultatif. Agent qui gère initialement la conversation. Si ce champ n'est pas spécifié, 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. Collection de messages qui composent la conversation.

createTime

string (Timestamp format)

Uniquement en sortie. Horodatage 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 de référence 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 changé 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 (par exemple, utilisateur, agent).

chunks[]

object (Chunk)

Facultatif. Contenu du message sous forme de série de fragments.

eventTime

string (Timestamp format)

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

Mininja

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. Données de fragment. data ne peut être qu'un des éléments suivants :
text

string

Facultatif. Données textuelles.

transcript

string

Facultatif. Transcription associée à l'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 de l'outil.

toolResponse

object (ToolResponse)

Facultatif. Réponse de 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, indexées par nom de variable.

defaultVariables

object (Struct format)

Une structure représente les variables par défaut au début de la conversation, indexées par les noms des variables.

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,
  "altText": string
}
Champs
mimeType

string

Obligatoire. Type MIME standard IANA des données sources. Types d'images compatibles : * image/png * image/jpeg * image/webp

data

string (bytes format)

Obligatoire. Octets bruts de l'image.

Chaîne encodée en base64.

altText

string

Facultatif. Texte alternatif de l'image.

ToolCall

Représentation JSON
{
  "id": string,
  "displayName": string,
  "args": {
    object
  },
  "parentToolCallId": string,
  "agentName": string,
  "targetApp": 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 ce champ est renseigné, le client doit renvoyer le résultat de l'exécution avec l'ID correspondant dans ToolResponse.

displayName

string

Uniquement en sortie. Nom à afficher de l'outil.

args

object (Struct format)

Facultatif. Paramètres d'entrée et valeurs de l'outil au format d'objet JSON.

parentToolCallId

string

Uniquement en sortie. ID de l'appel d'outil à l'origine de 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émarré au lieu d'afficher chaque étape comme un élément frère.

agentName

string

Uniquement en sortie. Nom lisible par l'humain de l'agent qui a émis cet appel, par exemple "Architecte de contrat". Vide lorsque l'agent racine l'a émis.

targetApp

string

Uniquement en sortie. Application ciblée par cet appel, dérivée par l'assistant à partir des arguments de ressource de l'appel : un nom de ressource d'application, PROJECT pour les outils limités à un emplacement ou vide pour les outils locaux de session. Défini uniquement dans les sessions de l'assistant au niveau du projet.

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 dont 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 lesquels récupérer le schéma.

ToolResponse

Représentation JSON
{
  "id": string,
  "displayName": string,
  "response": {
    object
  },
  "parentToolCallId": string,
  "agentName": string,
  "targetApp": 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 de mise en correspondance de l'élément tool call auquel la réponse est destinée.

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'intégralité de la "réponse" est traitée comme le résultat de l'exécution de l'outil.

parentToolCallId

string

Uniquement en sortie. ID de l'appel d'outil à l'origine de 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émarré au lieu d'afficher chaque étape comme un élément frère.

agentName

string

Uniquement en sortie. Nom lisible par l'humain de l'agent qui a émis cet appel, par exemple "Architecte de contrat". Vide lorsque l'agent racine l'a émis.

targetApp

string

Uniquement en sortie. Application ciblée par l'outil exécuté ; reflète ToolCall.target_app.

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 gérera la conversation à 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)
  },
  "supervisor": {
    object (Supervisor)
  }
  // End of list of possible types for union field guardrail_type.
}
Champs
name

string

Identifiant. Identifiant unique de la barrière de sécurité. 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 de la garde-fous.

enabled

boolean

Facultatif. Indique si la protection est activée.

action

object (TriggerAction)

Facultatif. Action à effectuer lorsque le garde-fou est déclenché.

createTime

string (Timestamp format)

Uniquement en sortie. Horodatage de la création de la barrière de sécurité.

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. Horodatage de la dernière mise à jour de la protection.

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

etag

string

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

Champ d'union guardrail_type. Type de garde-fou. guardrail_type ne peut être qu'un des éléments suivants :
contentFilter

object (ContentFilter)

Facultatif. Règle de protection qui interdit l'utilisation de certains contenus dans la conversation.

llmPromptSecurity

object (LlmPromptSecurity)

Facultatif. Guardrail qui bloque la conversation si le prompt est considéré comme dangereux d'après la classification du LLM.

llmPolicy

object (LlmPolicy)

Facultatif. Guardrail qui bloque la conversation si la réponse du LLM est considérée comme enfreignant la règle 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. Glissière de sécurité qui bloque potentiellement la conversation en fonction du résultat de l'exécution du rappel.

supervisor

object (Supervisor)

Facultatif. Garde-fou qui exécute l'intervention du superviseur.

ContentFilter

Représentation JSON
{
  "bannedContents": [
    string
  ],
  "bannedContentsInUserInput": [
    string
  ],
  "bannedContentsInAgentResponse": [
    string
  ],
  "matchType": enum (MatchType),
  "disregardDiacritics": boolean,
  "sensitiveWordsExemptions": [
    string
  ]
}
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. S'applique uniquement aux entrées utilisateur.

bannedContentsInAgentResponse[]

string

Facultatif. Liste des expressions interdites. S'applique uniquement aux réponses de l'agent.

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.

sensitiveWordsExemptions[]

string

Facultatif. Entrées de la liste de mots sensibles que ce garde-fou autorise. Valide uniquement lorsque match_type est défini sur SENSITIVE_WORDS. Chaque valeur doit correspondre à une entrée de la liste (non sensible à la casse, les espaces environnants sont ignorés). Les autres valeurs n'ont aucun effet. S'applique uniquement à cette protection. 1 000 entrées maximum de 256 caractères chacune.

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 de LLM. - Si la valeur est "true", la garde-fou est ignoré. - Si la valeur est "false" (par défaut), le garde-fou 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" qu'il contient 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 sert à afficher la requête que le système utilise par défaut. Il s'agit d'un champ OUTPUT_ONLY.

LlmPolicy

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

integer

Facultatif. Lors de la vérification de cette règle, tenez compte des "n" derniers messages de la conversation. Si aucune valeur n'est définie, la valeur par défaut est de 10.

modelSettings

object (ModelSettings)

Facultatif. Paramètres du modèle.

prompt

string

Obligatoire. Invite de règle. Accepte les espaces réservés pour les variables de session ({var}) ainsi que {agent_system_instruction} pour injecter les instructions système résolues de l'agent.

policyScope

enum (PolicyScope)

Obligatoire. Définit quand appliquer la vérification de la règle pendant la conversation. Si elle est définie sur POLICY_SCOPE_UNSPECIFIED, la règle sera appliquée à 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 de la règle, l'ouverture en cas de défaillance est activée et le garde-fou n'est pas déclenché.

allowShortUtterance

boolean

Facultatif. Par défaut, la vérification des règles du LLM est ignorée pour les énoncés courts. Si vous activez ce paramètre, la vérification des règles s'applique à tous les énoncés, y compris ceux qui seraient normalement ignorés.

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. La 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 dictionnaire ou un objet) contenant au moins : - "decision" : "OK" ou "TRIGGER". - "reason" : chaîne expliquant la décision. Une décision "TRIGGER" 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 dictionnaire ou un objet) contenant au moins : - "decision" : "OK" ou "TRIGGER". - "reason" : chaîne expliquant la décision. Une décision "TRIGGER" peut interrompre le traitement.

beforeModelCallback

object (Callback)

Facultatif. Rappel à exécuter avant l'appel du modèle. Si plusieurs appels sont effectués vers le modèle, le rappel sera exécuté plusieurs fois. Chaque fonction de rappel doit renvoyer une structure (par exemple, un dictionnaire ou un objet) contenant au moins : - "decision" : "OK" ou "TRIGGER". - "reason" : chaîne expliquant la décision. Une décision "TRIGGER" peut interrompre le traitement.

afterModelCallback

object (Callback)

Facultatif. Rappel à exécuter après l'appel du modèle. Si plusieurs appels sont effectués vers le modèle, le rappel sera exécuté plusieurs fois. Chaque fonction de rappel doit renvoyer une structure (par exemple, un dictionnaire ou un objet) contenant au moins : - "decision" : "OK" ou "TRIGGER". - "reason" : chaîne expliquant la décision. Une décision "TRIGGER" peut interrompre le traitement.

Superviseur

Représentation JSON
{
  "type": enum (Type),
  "detectionMode": enum (DetectionMode)
}
Champs
type

enum (Type)

Facultatif. Type de superviseur.

detectionMode

enum (DetectionMode)

Facultatif. Mode de détection du superviseur.

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érez la conversation à un autre agent.

generativeAnswer

object (GenerativeAnswer)

Facultatif. Répondre 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 de manière aléatoire.

Réponse

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

string

Obligatoire. Texte de la réponse de l'agent.

disabled

boolean

Facultatif. Indique si la réponse est désactivée. Les réponses désactivées ne sont pas utilisées par l'agent.

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.

Toolset

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. Il doit être unique dans une même application.

description

string

Facultatif. Description de l'ensemble d'outils.

timeout

string (Duration format)

Facultatif. Délai avant expiration de l'exécution de l'ensemble d'outils. Si ce paramètre n'est pas défini, le délai avant expiration 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. Horodatage 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 changé 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 de l'ensemble d'outils.

toolFakeConfig

object (ToolFakeConfig)

Facultatif. Configuration du comportement des outils en mode factice.

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. Un 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 se terminer par "/mcp/". Seuls les serveurs basés sur le transport HTTP en flux continu sont compatibles. 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 de support, le jeton ne s'applique qu'à l'exécution de l'outil, et non à la liste des outils. Pour cela, les outils doivent pouvoir être listés sans authentification.

serviceDirectoryConfig

object (ServiceDirectoryConfig)

Facultatif. Configuration de l'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. S'il est présent, cet outil utilise ce nom 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. S'il est présent, cet outil est "épinglé" et utilise les valeurs de l'instantané 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 OpenAPI. Ce champ n'est défini dans les ensembles d'outils des dépendances de l'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.

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 gestion de l'authentification dans Integration Connectors. Par défaut, une authentification d'administrateur est transmise dans les requêtes API Integration Connectors. Vous pouvez la remplacer par une autre configuration d'authentification de l'utilisateur final. Remarque : L'option de remplacement de l'authentification doit être activée pour la connexion afin de 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'un hall de congrès.
OUTDOOR Bruit ambiant d'une rue.

WarningType

Type d'avertissement rencontré lors du traitement de l'échantillon vocal.

Enums
WARNING_TYPE_UNSPECIFIED Type d'avertissement non spécifié.
LOW_AUDIO_LEVEL Le niveau audio de l'échantillon vocal est trop faible (par exemple, amplitude RMS faible).

VoiceInstructionMode

Mode d'instruction pour l'extrait de voix.

Enums
VOICE_INSTRUCTION_MODE_UNSPECIFIED Mode d'instruction non spécifié. La valeur par défaut est NO_INSTRUCTION.
NO_INSTRUCTION Aucune instruction vocale ne sera utilisée.
GENERATE_INSTRUCTION L'instruction vocale sera générée automatiquement par l'IA à partir de l'échantillon audio.
CUSTOM_INSTRUCTION Instruction vocale personnalisée fournie par l'utilisateur.

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 Aucun traitement spécifique n'est activé.
FALLBACK_RESPONSE Un message de remplacement sera renvoyé à l'utilisateur en cas d'erreurs système (par exemple, des erreurs LLM).
END_SESSION Un signal EndSession sera émis en cas d'erreurs système (par exemple, des erreurs LLM).

ThinkingLevel

Configuration du niveau de raisonnement pour le modèle.

Enums
THINKING_LEVEL_UNSPECIFIED Le niveau de raisonnement n'est pas spécifié.
DEFAULT Niveau de raisonnement par défaut.
LOW Niveau de réflexion faible.
MEDIUM Niveau de raisonnement intermédiaire.
HIGH Niveau de raisonnement élevé.

ToolExecutionMode

Définit le comportement d'exécution des outils si plusieurs outils sont sélectionnés par l'agent 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 de manière séquentielle. L'outil suivant ne sera exécuté qu'une fois l'outil précédent terminé, et il 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 Échouer 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 de la métrique d'hallucination non spécifié.
DISABLED Désactivez la métrique d'hallucination.
ENABLED Activer 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 Array.

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 pour l'union de types 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 un 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_CHAT Type de moteur de chat. Moteur SOLUTION_TYPE_CHAT de l'application. Tous les datastores de connecteur ajoutés à l'application seront ajoutés à ce moteur.

ChannelType

Type du profil de canal.

Enums
UNKNOWN Type de canal inconnu.
WEB_UI Canal de l'UI Web.
API Canal d'API.
TWILIO Canal Twilio.
GOOGLE_TELEPHONY_PLATFORM Canal Google Telephony Platform.
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 Instagram.

Persona

Le persona de la chaîne.

Enums
UNKNOWN Persona INCONNU.
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 accepte les entrées de chat et vocales.
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.

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. Seul l'octroi d'identifiants client est accepté.

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.

Direction

Direction du transfert.

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

OperationType

Opération à effectuer sur l'entité.

Enums
OPERATION_TYPE_UNSPECIFIED Type d'opération non spécifié. Non valide. La création/mise à jour de ConnectorTool échouera.
LIST Opération de liste.
GET Opération Get.
CREATE Créer une opération.
UPDATE Opération de mise à jour.
DELETE Supprimer l'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 Un data store contenant des données privées non structurées.
FAQ Datastore contenant des données structurées utilisées comme questions fréquentes.
CONNECTOR Un data store qui est un connecteur vers un service propriétaire 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 fragments.

AttributeType

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

Enums
ATTRIBUTE_TYPE_UNSPECIFIED AttributeType 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 de l'attribut (la valeur x) du point de contrôle sera la valeur réelle du champ numérique pour lequel la valeur boost_amount est spécifiée.
FRESHNESS Pour le cas d'utilisation de l'actualisation, la valeur de l'attribut correspond à la durée entre l'heure actuelle et la date dans le champ datetime spécifié. La valeur doit être au format XSD dayTimeDuration (un sous-ensemble restreint d'une valeur de durée ISO 8601). Le format est le suivant : [nD][T[nH][nM][nS]]. Exemples : 5D, 3DT12H30M, T24H.

InterpolationType

Type d'interpolation à appliquer. La valeur par défaut est "linear" (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 "Linear".
LINEAR L'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 du paramètre de filtre.

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

É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 pas proposé par le serveur pour le moment.
STALE L'outil existe sur le serveur, mais ne correspond pas à la version sur le serveur.

CorpusType

Type du corpus RAG Vertex.

Enums
CORPUS_TYPE_UNSPECIFIED Type de corpus non spécifié.
USER_OWNED Le corpus est créé par l'utilisateur, qui en est le propriétaire.
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_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 sur le produit avancées.
SHORT_FORM Widget de formulaire court.
OVERALL_SATISFACTION Widget de satisfaction globale.
ORDER_SUMMARY Widget de récapitulatif de la commande.
APPOINTMENT_DETAILS Widget des 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 le mappage field_mappings pour la transformation des données.
PYTHON_SCRIPT Utilisez python_script pour la transformation des 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 à côté du widget en fonction du contexte de la conversation.
LLM_GENERATED Le LLM est explicitement invité à générer une réponse textuelle.
STATIC Une réponse textuelle 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 La correspondance de contenu est établie 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 des expressions régulières.
SENSITIVE_WORDS Le contenu est comparé à une liste de mots et d'expressions sensibles gérée par le système. Associer un garde-fou avec ce type de correspondance à une application ou à un agent remplace le filtre de mots sensibles par défaut pour les agents concernés. Désactivez le garde-fou pour désactiver le filtre par défaut.

PolicyScope

Définit quand appliquer la vérification de la règle 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 une entrée utilisateur.
AGENT_RESPONSE La vérification des règles est déclenchée sur 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 sur l'entrée utilisateur et sur 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.

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 "langage grossier".
HARM_CATEGORY_TOXIC La catégorie de préjudice est "toxique".

HarmBlockThreshold

Niveaux de seuil basés sur la 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é.

Type

Type de superviseur.

Enums
TYPE_UNSPECIFIED Le type n'est pas spécifié.
INVALID_TEXT Type de problème de texte non valide.
LANGUAGE_SHIFT Type de problème de changement de langue.
SPEAKER_SHIFT Type de problème de changement de locuteur.
AUDIO_MISMATCH Type de problème de non-concordance audio.
MISSING_TOOL_CALL Type de problème d'appel d'outil manquant.
CUSTOM Type de problème personnalisé.
CHOPPY_AUDIO Type de problème de son haché.
PROFANITY Type de problème de grossièreté de l'agent.

DetectionMode

Mode de détection du superviseur.

Enums
DETECTION_MODE_UNSPECIFIED Le mode de détection n'est pas spécifié. La valeur par défaut est NON_BLOCKING.
NON_BLOCKING Mode de détection non bloquant. La réponse n'est pas bloquée lorsque la détection du superviseur est en cours.
BLOCKING Mode de détection de blocage. La réponse est bloquée lorsque la détection du superviseur est en cours.

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 considèrent ces indications comme non fiables, mais elles peuvent être utilisées pour décider quand envoyer une invite de confirmation à un utilisateur.

En plus de la chaîne de titre, les indices booléens suivants sont définis 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", l'appel répété de l'outil 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 sur le Web serait en monde ouvert, tandis qu'un outil de mémoire ne le serait pas.

Indice "Destructive" : ❌ | Indice "Idempotent" : ✅ | Indice "Read Only" : ✅ | Indice "Open World" : ❌