REST Resource: projects.locations.apps

Ressource : App

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.

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 (App.ToolExecutionMode),
  "evaluationMetricsThresholds": {
    object (EvaluationMetricsThresholds)
  },
  "variableDeclarations": [
    {
      object (App.VariableDeclaration)
    }
  ],
  "predefinedVariableDeclarations": [
    {
      object (App.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 (App.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 (App.VariableDeclaration)

Facultatif. Déclarations des variables.
predefinedVariableDeclarations[]

object (App.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

Paramètres de langue de l'application.

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 defaultLanguageCode.
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 "escalate" ou "exit", qui déclenche un signal EndSession avec le metadata correspondant pour mettre fin à la conversation.

TimeZoneSettings

Paramètres de fuseau horaire de l'application.

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

Configuration du traitement et de la diffusion de l'audio d'entrée et de sortie.

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.

SynthesizeSpeechConfig

Configuration de la synthèse de la réponse de l'agent.

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

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

Configuration de la gestion des activités d'interruption par l'utilisateur.

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 : disableBargeIn est obsolète et remplacé par disableBargeInControl 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.

AmbientSoundConfig

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

Représentation JSON 
{
  "volumeGainDb": number,

  // Union field source can be only one of the following:
  "prebuiltAmbientNoise": enum (AmbientSoundConfig.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 (AmbientSoundConfig.PrebuiltAmbientNoise)

Facultatif. Obsolète : prebuiltAmbientNoise est obsolète et remplacé par prebuiltAmbientSound.
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"

AmbientSoundConfig.PrebuiltAmbientNoise

Bruit ambiant prédéfini.

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

LoggingSettings

Paramètres permettant de décrire les comportements de journalisation de l'application.

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

Configuration permettant d'indiquer comment les données sensibles doivent être traitées.

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/{inspectTemplate}
deidentifyTemplate

string

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

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

AudioRecordingConfig

Configuration de l'enregistrement des interactions audio.

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

Paramètres permettant de décrire les comportements d'exportation BigQuery pour l'application.

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

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

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

boolean

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

ConversationLoggingSettings

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

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

boolean

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

MetricAnalysisSettings

Paramètres permettant de décrire les comportements de collecte de données de conversation pour le pipeline de métriques d'analyse LLM.

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

Paramètres permettant de décrire comment les erreurs doivent être gérées dans l'application.

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

enum (ErrorHandlingSettings.ErrorHandlingStrategy)

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

ErrorHandlingSettings.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. La valeur par défaut est FALLBACK_RESPONSE.
NONE Aucune gestion spécifique n'est activée.
FALLBACK_RESPONSE Un message de remplacement sera renvoyé à l'utilisateur en cas d'erreur du LLM.

App.ToolExecutionMode

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

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

EvaluationMetricsThresholds

Paramètres de seuil pour les métriques d'une évaluation.

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

object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds)

Facultatif. Seuils des métriques d'évaluation privilégiées.
hallucinationMetricBehavior
(deprecated)

enum (EvaluationMetricsThresholds.HallucinationMetricBehavior)

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

enum (EvaluationMetricsThresholds.HallucinationMetricBehavior)

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

enum (EvaluationMetricsThresholds.HallucinationMetricBehavior)

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

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds

Paramètres pour les évaluations de référence.

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

object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds)

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

object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds)

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

object (EvaluationMetricsThresholds.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.

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds

Seuils des métriques au niveau du tour.

Représentation JSON 
{
  "semanticSimilarityChannel": enum (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel),
  "semanticSimilaritySuccessThreshold": integer,
  "overallToolInvocationCorrectnessThreshold": number
}
Champs
semanticSimilarityChannel

enum (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel)

Facultatif. Canal de similarité sémantique à utiliser pour l'évaluation.
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.
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.

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.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.

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds

Seuils des métriques de niveau d'attente.

Représentation JSON 
{
  "toolInvocationParameterCorrectnessThreshold": number
}
Champs
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.

EvaluationMetricsThresholds.ToolMatchingSettings

Paramètres pour faire correspondre les appels d'outils.

Représentation JSON 
{
  "extraToolCallBehavior": enum (EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior)
}
Champs
extraToolCallBehavior

enum (EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior)

Facultatif. Comportement pour les appels d'outils supplémentaires. La valeur par défaut est "FAIL".

EvaluationMetricsThresholds.ToolMatchingSettings.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 Échec de l'évaluation si un appel d'outil supplémentaire est détecté.
ALLOW Autorisez l'appel d'outil supplémentaire.

EvaluationMetricsThresholds.HallucinationMetricBehavior

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

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

App.VariableDeclaration

Définit la structure et les métadonnées d'une variable.

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.

DataStoreSettings

Paramètres liés au data store de l'application.

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

object (DataStoreSettings.Engine)

Uniquement en sortie. Moteurs de l'application.

DataStoreSettings.Engine

Moteur auquel les data stores sont connectés. Consultez Vertex AI Search : https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

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

string

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

enum (DataStoreSettings.Engine.Type)

Uniquement en sortie. Type de moteur.

DataStoreSettings.Engine.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 pour l'application. Tous les magasins de données de connecteur ajoutés à l'application seront ajoutés à ce moteur.

ClientCertificateSettings

Paramètres des certificats client personnalisés.

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}

Méthodes

create

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

delete

 Supprime l'application spécifiée.

executeTool

 Exécute l'outil donné avec les arguments donnés.

exportApp

 Exporte l'application spécifiée.

get

 Obtient les détails de l'application spécifiée.

importApp

 Importe l'application spécifiée.

list

 Liste les applications du projet et de l'emplacement spécifiés.

patch

 Met à jour l'application spécifiée.

retrieveToolSchema

 Récupère le schéma de l'outil donné.