MCP Tools Reference: ces.googleapis.com

Outil : update_app

Met à jour l'application spécifiée. Veillez à toujours transmettre un masque de mise à jour dans l'entrée.

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

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": "update_app",
    "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.UpdateApp.

UpdateAppRequest

Représentation JSON
{
  "app": {
    object (App)
  },
  "updateMask": string
}
Champs
app

object (App)

Obligatoire. Application à mettre à jour.

updateMask

string (FieldMask format)

Facultatif. Le masque de champ permet de contrôler les champs à mettre à jour. Si le masque n'est pas présent, tous les champs seront mis à jour.

Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo".

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

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

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}

FieldMask

Représentation JSON
{
  "paths": [
    string
  ]
}
Champs
paths[]

string

Ensemble de chemins d'accès au masque de champ.

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.

Schéma de sortie

Une application sert de conteneur de premier niveau pour un groupe d'agents, y compris l'agent racine et ses sous-agents, ainsi que leurs configurations associées. Ces agents travaillent ensemble pour atteindre des objectifs spécifiques dans le contexte 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

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

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}

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.

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.

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