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)
  },
  "vpcScSettings": {
    object (VpcScSettings)
  },
  "locked": boolean,
  "evaluationPersonas": [
    {
      object (EvaluationPersona)
    }
  ],
  "evaluationSettings": {
    object (EvaluationSettings)
  },
  "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 (App.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 (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 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.

evaluationPersonas[]

object (EvaluationPersona)

Facultatif. Personas d'évaluation de l'application. Ce champ permet de définir les personas pouvant être utilisés pour l'évaluation. Vous pouvez définir jusqu'à 30 personas.

evaluationSettings

object (EvaluationSettings)

Facultatif. Paramètres d'évaluation de l'application.

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

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

Paramètres de fuseau horaire de l'application.

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

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)
  },
  "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.

SynthesizeSpeechConfig

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

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

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

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

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

boolean

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

AmbientSoundConfig

Configuration du son ambiant à diffuser avec la réponse synthétisée de l'agent, afin d'améliorer le naturel de la conversation.

Représentation JSON
{
  "volumeGainDb": number,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "prebuiltAmbientNoise": enum (AmbientSoundConfig.PrebuiltAmbientNoise),
  "gcsUri": string,
  "prebuiltAmbientSound": string
  // End of mutually exclusive fields.
}
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.

Bruit ambiant à diffuser avec la réponse de l'agent synthétisée, pour améliorer le naturel de la conversation. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
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 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"

Fin des champs mutuellement exclusifs.

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'un hall de congrès.
OUTDOOR Bruit ambiant d'une rue.

CustomVoiceSample

Configuration d'un échantillon de voix personnalisé utilisé pour le clonage de voix.

Représentation JSON
{
  "name": string,
  "voiceSampleGcsUri": string,
  "consentAudioGcsUri": string,
  "voiceInstruction": string,
  "previewAudioContent": string,
  "previewText": string,
  "warnings": [
    {
      object (CustomVoiceSample.Warning)
    }
  ],
  "voiceInstructionMode": enum (CustomVoiceSample.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 (CustomVoiceSample.Warning)

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

voiceInstructionMode

enum (CustomVoiceSample.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.

CustomVoiceSample.Warning

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

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

string

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

type

enum (CustomVoiceSample.Warning.WarningType)

Uniquement en sortie. Type d'avertissement.

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

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

LoggingSettings

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

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.

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, 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/{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. 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

Paramètres décrivant 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. 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

Paramètres décrivant 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 décrivant les comportements de journalisation des conversations pour l'application.

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

Paramètres décrivant les comportements de collecte des 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 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

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

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

enum (ErrorHandlingSettings.ErrorHandlingStrategy)

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

fallbackResponseConfig

object (ErrorHandlingSettings.FallbackResponseConfig)

Facultatif. Configuration pour la gestion des réponses de remplacement.

endSessionConfig

object (ErrorHandlingSettings.EndSessionConfig)

Facultatif. Configuration pour mettre fin à la session en cas d'erreurs système (par exemple, des erreurs LLM).

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

ErrorHandlingSettings.FallbackResponseConfig

Configuration pour la gestion des réponses de remplacement.

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.

ErrorHandlingSettings.EndSessionConfig

Configuration pour mettre fin à la session en cas d'erreurs système (par exemple, des erreurs LLM).

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

boolean

Facultatif. Indique s'il faut escalader la session dans EndSession. Si la session est escaladée, metadata in EndSession contiendra sessionEscalated = 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.

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

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

DataStoreSettings

Paramètres liés au datastore pour 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 datastores 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 de l'application. Tous les datastores 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 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

Paramètres VPC-SC de l'application.

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.

EvaluationSettings

Paramètres d'évaluation.

Représentation JSON
{
  "scenarioConversationInitiator": enum (EvaluationSettings.ScenarioConversationInitiator),
  "goldenRunMethod": enum (GoldenRunMethod),
  "goldenEvaluationToolCallBehaviour": enum (EvaluationToolCallBehaviour),
  "scenarioEvaluationToolCallBehaviour": enum (EvaluationToolCallBehaviour),
  "metricsConfig": {
    object (EvaluationMetricsConfig)
  },
  "scenarioExecutionMode": enum (EvaluationSettings.ScenarioExecutionMode),
  "evaluationRunCachingSettings": {
    object (EvaluationRunCachingSettings)
  }
}
Champs
scenarioConversationInitiator

enum (EvaluationSettings.ScenarioConversationInitiator)

Facultatif. Qui démarre la conversation dans une évaluation de scénario.

goldenRunMethod

enum (GoldenRunMethod)

Facultatif. Méthode par défaut utilisée pour exécuter les évaluations de référence. Cette valeur sera utilisée si aucune méthode goldenRunMethod n'est spécifiée dans RunEvaluationRequest.

goldenEvaluationToolCallBehaviour

enum (EvaluationToolCallBehaviour)

Facultatif. Configure le comportement d'appel d'outil par défaut pour les évaluations de référence.

scenarioEvaluationToolCallBehaviour

enum (EvaluationToolCallBehaviour)

Facultatif. Configure le comportement par défaut des appels d'outils pour les évaluations de scénarios.

metricsConfig

object (EvaluationMetricsConfig)

Facultatif. Configure les métriques par défaut pour les évaluations.

scenarioExecutionMode

enum (EvaluationSettings.ScenarioExecutionMode)

Facultatif. Mode d'exécution pour les évaluations de scénarios. Si aucune valeur n'est fournie, la valeur par défaut est QUALITY_OPTIMIZED.

evaluationRunCachingSettings

object (EvaluationRunCachingSettings)

Facultatif. Paramètres de mise en cache à utiliser pour l'exécution de l'évaluation.

EvaluationSettings.ScenarioConversationInitiator

Détermine qui démarre la conversation dans une session d'évaluation de scénario.

Enums
SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED Non spécifié. La valeur par défaut est USER.
USER L'utilisateur entame la conversation.
AGENT L'agent entame la conversation.

DashboardSettings

Paramètres des tableaux de bord associés à l'application, qui s'affichent dans la vue "Surveillance".

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}

Méthodes

chatAiAssistant

Exécute Arc, l'assistant IA, pour la session d'assistant spécifiée.

create

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

delete

Supprime l'application spécifiée.

executeTool

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

exportApp

Exporte l'application spécifiée.

generateAppResource

Génère des ressources spécifiques (par exemple,

generateOnboardingSuggestions

Génère des suggestions d'intégration personnalisées pour l'état zéro d'Arc : classe l'utilisateur demandeur (nouveau/explorateur/revenant) à partir de l'historique de ses sessions avec l'assistant dans l'application et renvoie des chips de suggestion (reprendre une session, continuer à travailler ou commencer quelque chose de nouveau) à afficher avant l'envoi de tout message.

get

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

getExtendedAgentCard

Récupère la fiche d'agent étendue de l'agent authentifié.

importApp

Importe l'application spécifiée.

importEvaluations

Importe les évaluations dans l'application.

list

Répertorie les applications du projet et de l'emplacement donnés.

patch

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

retrieveToolSchema

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

runAssistant

Exécute l'agent d'assistance pour la session d'assistance spécifiée.

runEvaluation

Exécute une évaluation de l'application.

testPersonaVoice

Teste la voix d'un persona.