MCP Tools Reference: ces.googleapis.com

Outil : create_app

Crée une application dans le projet et l'emplacement indiqués.

L'exemple suivant montre comment utiliser curl pour appeler l'outil MCP create_app.

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

Schéma d'entrée

Message de requête pour AgentService.CreateApp.

CreateAppRequest

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

string

Obligatoire. Nom de ressource de l'établissement dans lequel créer une application.
appId

string

Facultatif. ID à utiliser pour l'application, qui constituera le composant final du nom de ressource de l'application. Si aucun ID n'est fourni, un ID unique sera automatiquement attribué à l'application.
app

object (App)

Obligatoire. Application à créer.

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)
  },
  "locked": boolean
}
Champs
name

string

Identifiant. Identifiant unique de l'application. Format : projects/{project}/locations/{location}/apps/{app}
displayName

string

Obligatoire. Nom à afficher de l'application.
description

string

Facultatif. Description de l'application dans un format lisible.
pinned

boolean

Facultatif. Indique si l'application est épinglée dans la liste des applications.
rootAgent

string

Facultatif. L'agent racine est le point d'entrée de l'application. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
languageSettings

object (LanguageSettings)

Facultatif. Paramètres de langue de l'application.
timeZoneSettings

object (TimeZoneSettings)

Facultatif. Paramètres de fuseau horaire de l'application.
audioProcessingConfig

object (AudioProcessingConfig)

Facultatif. Configuration du traitement audio de l'application.
loggingSettings

object (LoggingSettings)

Facultatif. Paramètres de journalisation de l'application.
errorHandlingSettings

object (ErrorHandlingSettings)

Facultatif. Paramètres de gestion des erreurs de l'application.
modelSettings

object (ModelSettings)

Facultatif. Paramètres de modèle LLM par défaut pour l'application. Les ressources individuelles (par exemple, les agents et les garde-fous) peuvent remplacer ces configurations si nécessaire.
toolExecutionMode

enum (ToolExecutionMode)

Facultatif. Mode d'exécution de l'outil pour l'application. Si aucune valeur n'est fournie, la valeur par défaut est PARALLEL.
evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

Facultatif. Seuils d'évaluation 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 ces instructions pour configurer une identité ou une personnalité stable pour tous les agents.
guardrails[]

string

Facultatif. Liste des garde-fous pour l'application. Format : projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
dataStoreSettings

object (DataStoreSettings)

Facultatif. Paramètres du data store pour l'application.
defaultChannelProfile

object (ChannelProfile)

Facultatif. Profil de chaîne par défaut utilisé par l'application.
metadata

map (key: string, value: string)

Facultatif. Métadonnées sur l'application. Ce champ peut être utilisé pour stocker des informations supplémentaires concernant les détails ou les utilisations prévues de l'application.

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

string (Timestamp format)

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

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

string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour de l'application.

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

string

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

integer

Uniquement en sortie. Nombre de déploiements dans l'application.
clientCertificateSettings

object (ClientCertificateSettings)

Facultatif. Paramètres par défaut du certificat client pour l'application.
locked

boolean

Facultatif. Indique si l'application est verrouillée pour les modifications. Si l'application est verrouillée, les modifications apportées à ses ressources seront refusées.

LanguageSettings

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

string

Facultatif. Code de langue par défaut de l'application.
supportedLanguageCodes[]

string

Facultatif. Liste des codes de langue acceptés par l'application, en plus de default_language_code.
enableMultilingualSupport

boolean

Facultatif. Active la compatibilité multilingue. Si la valeur est "true", les agents de l'application utiliseront des instructions prédéfinies pour mieux gérer les entrées multilingues.
fallbackAction

string

Facultatif. Action à effectuer lorsqu'un agent reçoit une entrée dans une langue non acceptée.

Il peut s'agir d'une action prédéfinie ou d'un appel d'outil personnalisé. Les valeurs valides sont les suivantes : - Nom complet de la ressource d'un outil, qui déclenche l'exécution d'un outil spécifique. - Une action système prédéfinie, telle que "escalade" ou "quitter", qui déclenche un signal EndSession avec le metadata correspondant pour mettre fin à la conversation.

TimeZoneSettings

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

string

Facultatif. Fuseau horaire de l'application à partir de la base de données de 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)
  }
}
Champs
synthesizeSpeechConfigs

map (key: string, value: object (SynthesizeSpeechConfig))

Facultatif. Configuration de la synthèse de la réponse de l'agent, mappant le code de langue à SynthesizeSpeechConfig.

Si la configuration pour le code de langue spécifié est introuvable, celle du code de langue racine sera utilisée. Par exemple, si la carte contient "en-us" et "en", et que le code de langue spécifié est "en-gb", la configuration "en" sera utilisée.

Remarque : Le code de langue n'est pas sensible à la casse.

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

object (BargeInConfig)

Facultatif. Configure le comportement de l'agent pour les activités d'interruption par l'utilisateur.
inactivityTimeout

string (Duration format)

Facultatif. Durée d'inactivité de l'utilisateur (aucune parole ni interaction) avant que l'agent ne l'invite à réagir. Si ce paramètre n'est pas défini, l'agent ne demandera pas à l'utilisateur de réengager la conversation.

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

object (AmbientSoundConfig)

Facultatif. Configuration du son ambiant à lire avec la réponse de l'agent synthétisée, pour rendre la conversation plus naturelle.

SynthesizeSpeechConfigsEntry

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

string
value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

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

string

Facultatif. Nom de la voix. Si ce paramètre n'est pas défini, le service choisit une voix en fonction des autres paramètres, tels que language_code.

Pour obtenir la liste des voix disponibles, veuillez consulter Voix et langues disponibles dans Cloud Text-to-Speech.
speakingRate

number

Facultatif. Taux/vitesse de l'énoncé. Valeur comprise dans la plage [0,25, 2,0]. La valeur 1,0 correspond à la vitesse native normale compatible avec la voix spécifique. La valeur 2,0 est deux fois plus rapide et la valeur 0,5 est deux fois moins rapide. Les valeurs en dehors de la plage [0,25, 2,0] renvoient une erreur.

BargeInConfig

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

boolean

Facultatif. Désactive l'interruption par l'utilisateur pendant que l'agent parle. Si la valeur est "true", les saisies utilisateur pendant la lecture de la réponse de l'agent seront ignorées.

Obsolète : disable_barge_in est obsolète et remplacé par disable_barge_in_control dans ChannelProfile.
bargeInAwareness

boolean

Facultatif. Si cette option est activée, l'agent adaptera sa prochaine réponse en partant du principe que l'utilisateur n'a pas entendu l'intégralité du message précédent de l'agent. Cette méthode ne doit pas être utilisée dans les scénarios où les réponses de l'agent sont affichées visuellement.

Durée

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

string (int64 format)

Secondes signées de la période. La valeur doit être comprise entre -315 576 000 000 et +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 secondes signées avec une précision de l'ordre de la nanoseconde pour la durée. Les durées inférieures à une seconde sont représentées par un champ seconds égal à 0 et un champ nanos positif ou négatif. Pour les durées d'une seconde ou plus, une valeur non nulle pour le champ nanos doit avoir le même signe que le champ seconds. La valeur doit être comprise entre -999 999 999 et +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 pris en charge par le bruit ambiant, dans la plage [-96, 16]. Si la valeur n'est pas définie ou si elle est définie sur une valeur de zéro (dB), elle est lue à une amplitude de signal natif normal. Une valeur de -6 (dB) est lue avec environ la moitié de l'amplitude du signal natif normal. Une valeur de +6 (dB) est lue avec environ deux fois plus d'amplitude que le signal natif normal. Nous vous recommandons vivement de ne pas dépasser +10 (dB), car il n'y a généralement pas d'augmentation efficace du volume pour une valeur supérieure à cette valeur.
Champ d'union source. Bruit ambiant à lire avec la réponse de l'agent synthétisée, pour rendre la conversation plus naturelle. source ne peut être qu'un des éléments suivants :
prebuiltAmbientNoise
(deprecated)

enum (PrebuiltAmbientNoise)

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 monophonique à 16 kHz stocké dans Cloud Storage.

Remarque : Veuillez vous assurer que l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com dispose de l'autorisation storage.objects.get pour l'objet Cloud Storage.
prebuiltAmbientSound

string

Facultatif. Nom du son ambiant prédéfini. Les valeurs valides sont 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"

LoggingSettings

Représentation JSON 
{
  "redactionConfig": {
    object (RedactionConfig)
  },
  "audioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "bigqueryExportSettings": {
    object (BigQueryExportSettings)
  },
  "cloudLoggingSettings": {
    object (CloudLoggingSettings)
  },
  "conversationLoggingSettings": {
    object (ConversationLoggingSettings)
  },
  "evaluationAudioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "metricAnalysisSettings": {
    object (MetricAnalysisSettings)
  }
}
Champs
redactionConfig

object (RedactionConfig)

Facultatif. Configuration du masquage des données sensibles.
audioRecordingConfig

object (AudioRecordingConfig)

Facultatif. Configuration de l'enregistrement des interactions audio.
bigqueryExportSettings

object (BigQueryExportSettings)

Facultatif. Paramètres permettant de décrire les comportements d'exportation BigQuery pour l'application. Les données de conversation seront exportées vers des tables BigQuery si cette option est activée.
cloudLoggingSettings

object (CloudLoggingSettings)

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

object (ConversationLoggingSettings)

Facultatif. Paramètres permettant de décrire les comportements de journalisation des conversations pour l'application.
evaluationAudioRecordingConfig

object (AudioRecordingConfig)

Facultatif. Configuration de l'enregistrement des interactions audio pour l'évaluation. Par défaut, l'enregistrement audio n'est pas activé pour les sessions d'évaluation.
metricAnalysisSettings

object (MetricAnalysisSettings)

Facultatif. Paramètres permettant de décrire les comportements de collecte des données de conversation pour le pipeline d'analyse LLM de l'application.

RedactionConfig

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

boolean

Facultatif. Si la valeur est "true", le masquage sera appliqué dans différents scénarios de journalisation, y compris l'historique des conversations, Cloud Logging et l'enregistrement audio.
inspectTemplate

string

Facultatif. Nom du modèle d'inspection DLP permettant de configurer la détection des types de données sensibles.

Format : projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
deidentifyTemplate

string

Facultatif. Nom du modèle d'anonymisation DLP pour indiquer comment anonymiser le contenu.

Format : projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

AudioRecordingConfig

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

string

Facultatif. Bucket Cloud Storage pour stocker les enregistrements audio des sessions. L'URI doit commencer par "gs://".

Veuillez choisir un emplacement de bucket qui répond à vos exigences de résidence des données.

Remarque : Si le bucket Cloud Storage se trouve dans un projet différent de celui de l'application, vous devez accorder l'autorisation storage.objects.create à l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
gcsPathPrefix

string

Facultatif. Préfixe du chemin d'accès Cloud Storage pour les enregistrements audio.

Ce préfixe peut inclure les espaces réservés suivants, qui seront remplacés de manière dynamique au moment de la diffusion : - $project : ID du projet - $location : emplacement de l'application - $app : ID de l'application - $date : date de la session au format AAAA-MM-JJ - $session : ID de la session

Si le préfixe de chemin n'est pas spécifié, le préfixe par défaut $project/$location/$app/$date/$session/ est utilisé.

BigQueryExportSettings

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

boolean

Facultatif. Indique si l'exportation BigQuery est activée.
project

string

Facultatif. 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. 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
}
Champs
disableConversationLogging

boolean

Facultatif. Indique si la journalisation des conversations doit être désactivée pour les sessions.

MetricAnalysisSettings

Représentation JSON 
{
  "llmMetricsOptedOut": boolean
}
Champs
llmMetricsOptedOut

boolean

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

ErrorHandlingSettings

Représentation JSON 
{
  "errorHandlingStrategy": enum (ErrorHandlingStrategy)
}
Champs
errorHandlingStrategy

enum (ErrorHandlingStrategy)

Facultatif. Stratégie à utiliser pour le gestion des exceptions.

ModelSettings

Représentation JSON 
{
  "model": string,

  // Union field _temperature can be only one of the following:
  "temperature": number
  // End of list of possible types for union field _temperature.
}
Champs
model

string

Facultatif. Modèle LLM que l'agent doit utiliser. Si aucune valeur n'est définie, l'agent hérite du modèle de son agent parent.

Champ d'union _temperature.

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

number

Facultatif. Si cette option est définie, cette température sera utilisée pour le modèle LLM. La température contrôle le caractère aléatoire des réponses du modèle. Les températures plus basses produisent des réponses plus prévisibles. Les températures plus élevées 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 privilégiées.
hallucinationMetricBehavior
(deprecated)

enum (HallucinationMetricBehavior)

Facultatif. Obsolète : utilisez plutôt golden_hallucination_metric_behavior. Le comportement de la métrique d'hallucination est actuellement utilisé pour les évaluations de référence.
goldenHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

Facultatif. Comportement de la métrique d'hallucination pour les évaluations de référence.
scenarioHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

Facultatif. Comportement de la métrique d'hallucination pour les évaluations de scénarios.

GoldenEvaluationMetricsThresholds

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

object (TurnLevelMetricsThresholds)

Facultatif. Seuils des métriques au niveau du tour.
expectationLevelMetricsThresholds

object (ExpectationLevelMetricsThresholds)

Facultatif. Seuils des métriques de niveau d'attente.
toolMatchingSettings

object (ToolMatchingSettings)

Facultatif. Paramètres de correspondance de l'outil. Un appel d'outil supplémentaire est un appel d'outil présent dans l'exécution, mais qui ne correspond à aucun appel d'outil dans l'attente de référence.

TurnLevelMetricsThresholds

Représentation JSON 
{
  "semanticSimilarityChannel": enum (SemanticSimilarityChannel),

  // Union field _semantic_similarity_success_threshold can be only one of the
  // following:
  "semanticSimilaritySuccessThreshold": integer
  // End of list of possible types for union field
  // _semantic_similarity_success_threshold.

  // Union field _overall_tool_invocation_correctness_threshold can be only one
  // of the following:
  "overallToolInvocationCorrectnessThreshold": number
  // End of list of possible types for union field
  // _overall_tool_invocation_correctness_threshold.
}
Champs
semanticSimilarityChannel

enum (SemanticSimilarityChannel)

Facultatif. Canal de similarité sémantique à utiliser pour l'évaluation.

Champ d'union _semantic_similarity_success_threshold.

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

integer

Facultatif. Seuil de réussite pour la similarité sémantique. Veuillez saisir un nombre entier compris entre 0 et 4. La valeur par défaut est >= 3.

Champ d'union _overall_tool_invocation_correctness_threshold.

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

number

Facultatif. Seuil de réussite pour la correction globale de l'appel d'outil. Doit être un nombre à virgule flottante compris entre 0 et 1. La valeur par défaut est 1.0.

ExpectationLevelMetricsThresholds

Représentation JSON 
{

  // Union field _tool_invocation_parameter_correctness_threshold can be only one
  // of the following:
  "toolInvocationParameterCorrectnessThreshold": number
  // End of list of possible types for union field
  // _tool_invocation_parameter_correctness_threshold.
}
Champs

Champ d'union _tool_invocation_parameter_correctness_threshold.

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

number

Facultatif. Seuil de réussite pour la correction des paramètres d'invocation d'outils individuels. 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 contenir que des lettres, des chiffres ou des traits de soulignement.
description

string

Obligatoire. Description de la variable.
schema

object (Schema)

Obligatoire. Schéma de la variable.

Schéma

Représentation JSON 
{
  "type": enum (Type),
  "properties": {
    string: {
      object (Schema)
    },
    ...
  },
  "required": [
    string
  ],
  "description": string,
  "items": {
    object (Schema)
  },
  "nullable": boolean,
  "uniqueItems": boolean,
  "prefixItems": [
    {
      object (Schema)
    }
  ],
  "additionalProperties": {
    object (Schema)
  },
  "anyOf": [
    {
      object (Schema)
    }
  ],
  "enum": [
    string
  ],
  "default": value,
  "ref": string,
  "defs": {
    string: {
      object (Schema)
    },
    ...
  },
  "title": string,
  "minItems": string,
  "maxItems": string,

  // Union field _minimum can be only one of the following:
  "minimum": number
  // End of list of possible types for union field _minimum.

  // Union field _maximum can be only one of the following:
  "maximum": number
  // End of list of possible types for union field _maximum.
}
Champs
type

enum (Type)

Obligatoire. Type des données.
properties

map (key: string, value: object (Schema))

Facultatif. Propriétés de Type.OBJECT.

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

string

Facultatif. Propriétés requises de Type.OBJECT.
description

string

Facultatif. Description des données.
items

object (Schema)

Facultatif. Schéma des éléments de Type.ARRAY.
nullable

boolean

Facultatif. Indique si la valeur peut être nulle.
uniqueItems

boolean

Facultatif. Indique que les éléments du tableau doivent être uniques. Ne s'applique qu'à TYPE.ARRAY.
prefixItems[]

object (Schema)

Facultatif. Schémas des éléments initiaux de Type.ARRAY.
additionalProperties

object (Schema)

Facultatif. Peut être une valeur booléenne ou un objet. Contrôle la présence de propriétés supplémentaires.
anyOf[]

object (Schema)

Facultatif. La valeur doit être validée par rapport à l'un ou plusieurs des sous-schémas de la liste.
enum[]

string

Facultatif. Valeurs possibles de l'élément de type primitif avec le format enum. Exemples : 1. Nous pouvons définir la direction comme suit : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. Nous pouvons définir le numéro d'appartement comme suit : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default

value (Value format)

Facultatif. Valeur par défaut des données.
ref

string

Facultatif. Permet les références indirectes entre les nœuds de schéma. La valeur doit être une référence valide à un enfant de la racine defs.

Par exemple, le schéma suivant définit une référence à un nœud de schéma nommé "Pet" :

type: object
properties:
  pet:
    ref: #/defs/Pet
defs:
  Pet:
    type: object
    properties:
      name:
        type: string

La valeur de la propriété "pet" est une référence au nœud de schéma nommé "Pet". Pour en savoir plus, consultez https://json-schema.org/understanding-json-schema/structuring.
defs

map (key: string, value: object (Schema))

Facultatif. Carte des définitions à utiliser par ref. Uniquement autorisé à la racine du schéma.

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

string

Facultatif. Titre du schéma.
minItems

string (int64 format)

Facultatif. Nombre minimal d'éléments pour Type.ARRAY.
maxItems

string (int64 format)

Facultatif. Nombre maximal d'éléments pour Type.ARRAY.

Champ d'union _minimum.

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

number

Facultatif. Valeur minimale pour Type.INTEGER et Type.NUMBER.

Champ d'union _maximum.

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

number

Facultatif. Valeur maximale pour Type.INTEGER et Type.NUMBER.

PropertiesEntry

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

string
value

object (Schema)

Valeur

Représentation JSON 
{

  // Union field kind can be only one of the following:
  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
  // End of list of possible types for union field kind.
}
Champs
Champ d'union kind. Type de valeur. kind ne peut être qu'un des éléments suivants :
nullValue

null

Représente une valeur nulle.
numberValue

number

Représente une valeur double.
stringValue

string

Représente une valeur de chaîne.
boolValue

boolean

Représente une valeur booléenne.
structValue

object (Struct format)

Représente une valeur structurée.
listValue

array (ListValue format)

Représente un Value répété.

Struct

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

map (key: string, value: value (Value format))

Carte non ordonnée de valeurs typées 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 typées de manière dynamique.

DefsEntry

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

string
value

object (Schema)

DataStoreSettings

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

object (Engine)

Uniquement en sortie. Moteurs de l'application.

Moteur

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

string

Uniquement en sortie. Nom de ressource du moteur. Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type

enum (Type)

Uniquement en sortie. Type de moteur.

ChannelProfile

Représentation JSON 
{
  "profileId": string,
  "channelType": enum (ChannelType),
  "personaProperty": {
    object (PersonaProperty)
  },
  "disableDtmf": boolean,
  "disableBargeInControl": boolean,
  "webWidgetConfig": {
    object (WebWidgetConfig)
  },
  "noiseSuppressionLevel": string
}
Champs
profileId

string

Facultatif. Identifiant unique du profil de chaîne.
channelType

enum (ChannelType)

Facultatif. Type de profil de chaîne.
personaProperty

object (PersonaProperty)

Facultatif. Propriété de la persona du profil de chaîne.
disableDtmf

boolean

Facultatif. Indique si le DTMF (double fréquence) doit être désactivé.
disableBargeInControl

boolean

Facultatif. Indique si le contrôle de l'interruption par l'utilisateur doit être désactivé dans la conversation. - true : les interruptions de l'utilisateur sont désactivées pendant que l'agent parle. - false : l'agent conserve le contrôle automatique du moment où l'utilisateur peut interrompre.
webWidgetConfig

object (WebWidgetConfig)

Facultatif. Configuration du widget Web.
noiseSuppressionLevel

string

Facultatif. Niveau de suppression du bruit du profil de chaîne. Les valeurs disponibles sont "low", "moderate", "high" et "very_high".

PersonaProperty

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

enum (Persona)

Facultatif. Personnalité de la chaîne.

WebWidgetConfig

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

enum (Modality)

Facultatif. Modalité du widget Web.
theme

enum (Theme)

Facultatif. Thème du widget Web.
webWidgetTitle

string

Facultatif. Titre du widget Web.
securitySettings

object (SecuritySettings)

Facultatif. Paramètres de sécurité du widget Web.

SecuritySettings

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

boolean

Facultatif. Indique si l'accès public au widget Web est activé. Si la valeur est true, le widget Web sera accessible au public. Si la valeur est false, le widget Web doit être intégré à votre propre système d'authentification et d'autorisation pour renvoyer des identifiants valides permettant d'accéder à l'agent CES.
enableOriginCheck

boolean

Facultatif. Indique si la vérification de l'origine du widget Web est activée. Si la valeur est true, le widget Web vérifie l'origine du site Web qui charge le widget Web et n'autorise le chargement que dans la même origine ou dans l'une des origines autorisées.
allowedOrigins[]

string

Facultatif. Origines autorisées à héberger le widget Web. Une origine est définie par la RFC 6454. Si ce champ est vide, toutes les origines sont autorisées. Vous ne pouvez pas inclure plus de 100 origines. Exemple : "https://example.com"
enableRecaptcha

boolean

Facultatif. Indique si la validation reCAPTCHA pour le widget Web est activée.

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. La valeur doit être comprise entre -62135596800 et 253402300799 inclus (ce qui correspond à 0001-01-01T00:00:00Z et 9999-12-31T23:59:59Z).
nanos

integer

Fractions de secondes non négatives avec une précision de l'ordre de la nanoseconde. Ce champ correspond à la partie en nanosecondes de la durée, et non à une alternative aux secondes. Les valeurs de secondes négatives avec des fractions doivent toujours comporter des valeurs de nanosecondes non négatives comptabilisées dans le temps. La valeur doit être comprise entre 0 et 999 999 999 inclus.

ClientCertificateSettings

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

string

Obligatoire. Certificat TLS encodé au format PEM. Cette chaîne doit inclure les lignes d'en-tête de début et de pied de page de fin.
privateKey

string

Obligatoire. Nom de la ressource de version du secret Secret Manager stockant la clé privée encodée au format PEM. Format : projects/{project}/secrets/{secret}/versions/{version}
passphrase

string

Facultatif. Nom de la ressource de version du secret Secret Manager stockant la phrase secrète permettant de déchiffrer la clé privée. Doit être laissé vide si la clé privée n'est pas chiffrée. Format : projects/{project}/secrets/{secret}/versions/{version}

Schéma de sortie

Cette ressource représente une opération de longue durée résultant d'un appel d'API réseau.

Opération

Représentation JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
Champs
name

string

Nom attribué par le serveur. Unique au sein du service qui le renvoie initialement. Si vous utilisez le mappage HTTP par défaut, le champ name doit être un nom de ressource se terminant par operations/{unique_id}.
metadata

object

Métadonnées spécifiques au service associées à l'opération. Ce champ contient généralement des informations de progression et des métadonnées courantes telles que la date de création. Certains services peuvent ne pas fournir ce genre de métadonnées. Toute méthode renvoyant une opération de longue durée doit indiquer le type de métadonnées, le cas échéant.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.
done

boolean

Si la valeur est false, cela signifie que l'opération est toujours en cours. Si elle est définie sur true, l'opération est terminée, et un message error ou response est disponible.
Champ d'union result. Résultat de l'opération, qui peut être une erreur (message error) ou une réponse valide (message response). Si done == false, ni error, ni response ne sont définis. Si done == true, une seule des options error ou response peut être définie. Certains services peuvent ne pas fournir le résultat. result ne peut être qu'un des éléments suivants :
error

object (Status)

Résultat d'erreur de l'opération en cas d'échec ou d'annulation.
response

object

Réponse normale indiquant la réussite de l'opération. Si la méthode d'origine ne renvoie aucune donnée en cas de réussite (telle que Delete), la réponse est google.protobuf.Empty. Si la méthode d'origine est une méthode Get/Create/Update standard, la réponse doit correspondre à la ressource. Pour les autres méthodes, la réponse doit avoir le type XxxResponse, où Xxx est le nom de la méthode d'origine. Par exemple, si le nom de la méthode d'origine est TakeSnapshot(), le type de réponse déduit est TakeSnapshotResponse.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

Tous

Représentation JSON 
{
  "typeUrl": string,
  "value": string
}
Champs
typeUrl

string

Identifie le type du message Protobuf sérialisé avec une référence URI composée d'un préfixe se terminant par une barre oblique et du nom de type complet.

Exemple : type.googleapis.com/google.protobuf.StringValue

Cette chaîne doit contenir au moins un caractère /, et le contenu après le dernier / doit être le nom complet du type sous forme canonique, sans point au début. N'écrivez pas de schéma sur ces références URI afin que les clients ne tentent pas de les contacter.

Le préfixe est arbitraire et les implémentations Protobuf sont censées supprimer tout ce qui précède le dernier / (y compris) pour identifier le type. type.googleapis.com/ est un préfixe par défaut courant requis par certaines anciennes implémentations. Ce préfixe n'indique pas l'origine du type, et les URI qui le contiennent ne sont pas censés répondre aux requêtes.

Toutes les chaînes d'URL de type doivent être des références URI légales avec la restriction supplémentaire (pour le format texte) que le contenu de la référence ne doit être composé que de caractères alphanumériques, d'échappements encodés en pourcentage et de caractères de l'ensemble suivant (sans les accents graves extérieurs) : /-.~_!$&()*+,;=. Bien que nous autorisions les encodages en pourcentage, les implémentations ne doivent pas les décoder pour éviter toute confusion avec les analyseurs existants. Par exemple, type.googleapis.com%2FFoo doit être rejeté.

Dans la conception d'origine de Any, la possibilité de lancer un service de résolution de type à ces URL de type a été envisagée, mais Protobuf n'en a jamais implémenté et considère que la prise de contact avec ces URL est problématique et constitue un problème de sécurité potentiel. N'essayez pas de contacter les URL de type.
value

string (bytes format)

Contient une sérialisation Protobuf du type décrit par type_url.

Chaîne encodée en base64.

État

Représentation JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Champs
code

integer

Code d'état, qui doit être une valeur d'énumération de google.rpc.Code.
message

string

Message d'erreur destiné au développeur, qui doit être en anglais. Tout message d'erreur destiné aux utilisateurs doit être localisé et envoyé dans le champ google.rpc.Status.details, ou localisé par le client.
details[]

object

Liste de messages comportant les détails de l'erreur. Il existe un ensemble commun de types de message utilisable par les API.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

Annotations d'outils

Indication destructive : ✅ | Indication d'idempotence : ❌ | Indication de lecture seule : ❌ | Indication Open World : ❌