MCP Tools Reference: ces.googleapis.com

Strumento: update_app

Aggiorna l'app specificata. Assicurati di passare sempre una maschera di aggiornamento nell'input.

Il seguente esempio di codice mostra come utilizzare curl per chiamare lo strumento MCP update_app.

Richiesta curl 
curl --location 'https://ces.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "update_app",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Schema di input

Messaggio di richiesta per AgentService.UpdateApp.

UpdateAppRequest

Rappresentazione JSON 
{
  "app": {
    object (App)
  },
  "updateMask": string
}
Campi
app

object (App)

Obbligatorio. L'app da aggiornare.
updateMask

string (FieldMask format)

Facoltativo. La maschera di campo viene utilizzata per controllare quali campi vengono aggiornati. Se la maschera non è presente, verranno aggiornati tutti i campi.

Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".

App

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "pinned": boolean,
  "rootAgent": string,
  "languageSettings": {
    object (LanguageSettings)
  },
  "timeZoneSettings": {
    object (TimeZoneSettings)
  },
  "audioProcessingConfig": {
    object (AudioProcessingConfig)
  },
  "loggingSettings": {
    object (LoggingSettings)
  },
  "errorHandlingSettings": {
    object (ErrorHandlingSettings)
  },
  "modelSettings": {
    object (ModelSettings)
  },
  "toolExecutionMode": enum (ToolExecutionMode),
  "evaluationMetricsThresholds": {
    object (EvaluationMetricsThresholds)
  },
  "variableDeclarations": [
    {
      object (VariableDeclaration)
    }
  ],
  "predefinedVariableDeclarations": [
    {
      object (VariableDeclaration)
    }
  ],
  "globalInstruction": string,
  "guardrails": [
    string
  ],
  "dataStoreSettings": {
    object (DataStoreSettings)
  },
  "defaultChannelProfile": {
    object (ChannelProfile)
  },
  "metadata": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "deploymentCount": integer,
  "clientCertificateSettings": {
    object (ClientCertificateSettings)
  },
  "vpcScSettings": {
    object (VpcScSettings)
  },
  "locked": boolean,
  "validationErrors": [
    string
  ],
  "dashboardSettings": {
    object (DashboardSettings)
  }
}
Campi
name

string

Identificatore. L'identificatore univoco dell'app. Formato: projects/{project}/locations/{location}/apps/{app}
displayName

string

Obbligatorio. Nome visualizzato dell'app.
description

string

Facoltativo. Descrizione dell'app leggibile.
pinned

boolean

Facoltativo. Se l'app è bloccata nella lista di app.
rootAgent

string

Facoltativo. L'agente principale è l'entry point dell'app. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
languageSettings

object (LanguageSettings)

Facoltativo. Impostazioni della lingua dell'app.
timeZoneSettings

object (TimeZoneSettings)

Facoltativo. Impostazioni del fuso orario dell'app.
audioProcessingConfig

object (AudioProcessingConfig)

Facoltativo. Configurazione dell'elaborazione audio dell'app.
loggingSettings

object (LoggingSettings)

Facoltativo. Impostazioni di logging dell'app.
errorHandlingSettings

object (ErrorHandlingSettings)

Facoltativo. Impostazioni di gestione degli errori dell'app.
modelSettings

object (ModelSettings)

Facoltativo. Le impostazioni predefinite del modello LLM per l'app. Le singole risorse (ad es. agenti, guardrail) possono eseguire l'override di queste configurazioni in base alle esigenze.
toolExecutionMode

enum (ToolExecutionMode)

Facoltativo. La modalità di esecuzione dello strumento per l'app. Se non viene fornita, il valore predefinito sarà PARALLEL.
evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

Facoltativo. Le soglie di valutazione dell'app.
variableDeclarations[]

object (VariableDeclaration)

Facoltativo. Le dichiarazioni delle variabili.
predefinedVariableDeclarations[]

object (VariableDeclaration)

Solo output. Le dichiarazioni delle variabili predefinite per l'app.
globalInstruction

string

Facoltativo. Istruzioni per tutti gli agenti nell'app. Puoi utilizzare questa istruzione per configurare un'identità o una personalità stabile per tutti gli agenti.
guardrails[]

string

Facoltativo. Elenco di guardrail per l'app. Formato: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
dataStoreSettings

object (DataStoreSettings)

Facoltativo. Le impostazioni del datastore per l'app.
defaultChannelProfile

object (ChannelProfile)

Facoltativo. Il profilo del canale predefinito utilizzato dall'app.
metadata

map (key: string, value: string)

Facoltativo. Metadati relativi all'app. Questo campo può essere utilizzato per archiviare informazioni aggiuntive relative ai dettagli o agli utilizzi previsti dell'app.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Solo output. Timestamp della creazione dell'app.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo output. Timestamp dell'ultimo aggiornamento dell'app.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
etag

string

Solo output. Etag utilizzato per garantire che l'oggetto non sia cambiato durante un'operazione di lettura, modifica e scrittura. Se l'etag è vuoto, l'aggiornamento sovrascriverà eventuali modifiche simultanee.
deploymentCount

integer

Solo output. Numero di deployment nell'app.
clientCertificateSettings

object (ClientCertificateSettings)

Facoltativo. Le impostazioni predefinite del certificato client per l'app.
vpcScSettings

object (VpcScSettings)

Facoltativo. Impostazioni VPC-SC per l'app.
locked

boolean

Facoltativo. Indica se l'app è bloccata per le modifiche. Se l'app è bloccata, le modifiche alle risorse dell'app verranno rifiutate.
validationErrors[]

string

Solo output. Errori di configurazione o avvisi nell'app.
dashboardSettings

object (DashboardSettings)

Facoltativo. Impostazioni della dashboard specifiche per l'app per collegare e configurare le dashboard di Contact Center Insights.

LanguageSettings

Rappresentazione JSON 
{
  "defaultLanguageCode": string,
  "supportedLanguageCodes": [
    string
  ],
  "enableMultilingualSupport": boolean,
  "fallbackAction": string
}
Campi
defaultLanguageCode

string

Facoltativo. Il codice lingua predefinito dell'app.
supportedLanguageCodes[]

string

Facoltativo. Elenco dei codici lingua supportati dall'app, oltre a default_language_code.
enableMultilingualSupport

boolean

Facoltativo. Abilita il supporto multilingue. Se true, gli agenti nell'app utilizzeranno istruzioni predefinite per migliorare la gestione degli input multilingue.
fallbackAction
(deprecated)

string

Facoltativo. Ritirata: questa funzionalità non è più supportata. Utilizza invece enable_multilingual_support per migliorare la gestione dell'input multilingue. L'azione da eseguire quando un agente riceve un input in una lingua non supportata.

Può trattarsi di un'azione predefinita o di una chiamata allo strumento personalizzata. I valori validi sono: - Il nome completo della risorsa di uno strumento, che attiva l'esecuzione di uno strumento specifico. - Un'azione di sistema predefinita, come "escalate" o "exit", che attiva un segnale EndSession con il corrispondente metadata per terminare la conversazione.

TimeZoneSettings

Rappresentazione JSON 
{
  "timeZone": string
}
Campi
timeZone

string

Facoltativo. Il fuso orario dell'app dal database dei fusi orari, ad esempio America/Los_Angeles, Europe/Paris.

AudioProcessingConfig

Rappresentazione JSON 
{
  "synthesizeSpeechConfigs": {
    string: {
      object (SynthesizeSpeechConfig)
    },
    ...
  },
  "bargeInConfig": {
    object (BargeInConfig)
  },
  "inactivityTimeout": string,
  "ambientSoundConfig": {
    object (AmbientSoundConfig)
  },
  "customVoiceSamples": [
    {
      object (CustomVoiceSample)
    }
  ]
}
Campi
synthesizeSpeechConfigs

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

Facoltativo. Configurazione della modalità di sintesi della risposta dell'agente, mappatura dal codice lingua a SynthesizeSpeechConfig.

Se la configurazione per il codice lingua specificato non viene trovata, verrà utilizzata la configurazione per il codice lingua principale. Ad esempio, se la mappa contiene "en-us" ed "en" e il codice lingua specificato è "en-gb", verrà utilizzata la configurazione "en".

Nota: il codice lingua non fa distinzione tra maiuscole e minuscole.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
bargeInConfig

object (BargeInConfig)

Facoltativo. Configura il comportamento dell'agente per le attività di interruzione dell'utente.
inactivityTimeout

string (Duration format)

Facoltativo. La durata dell'inattività dell'utente (nessun parlato o interazione) prima che l'agente chieda all'utente di interagire di nuovo. Se non viene impostato, l'agente non chiederà all'utente di interagire nuovamente.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
ambientSoundConfig

object (AmbientSoundConfig)

Facoltativo. Configurazione del suono ambientale da riprodurre con la risposta sintetizzata dell'agente, per migliorare la naturalezza della conversazione.
customVoiceSamples[]

object (CustomVoiceSample)

Facoltativo. Configura campioni di voce personalizzati per la clonazione della voce.

SynthesizeSpeechConfigsEntry

Rappresentazione JSON 
{
  "key": string,
  "value": {
    object (SynthesizeSpeechConfig)
  }
}
Campi
key

string
value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

Rappresentazione JSON 
{
  "voice": string,
  "speakingRate": number,
  "model": string,
  "instruction": string
}
Campi
voice

string

Facoltativo. Il nome della voce. Se non viene impostata, il servizio sceglierà una voce in base agli altri parametri, ad esempio language_code.

Per l'elenco delle voci disponibili, consulta Voci e lingue supportate di Cloud Text-to-Speech.
speakingRate

number

Facoltativo. La velocità del parlato nell'intervallo [0,25, 2,0]. 1.0 è la velocità nativa normale supportata dalla voce specifica. 2.0 è il doppio della velocità e 0.5 è la metà della velocità. I valori al di fuori dell'intervallo [0,25, 2,0] restituiranno un errore.
model

string

Facoltativo. Il modello utilizzato per sintetizzare l'audio. Valori attualmente supportati: - "gemini-3.1-flash-tts-preview" Se vuoto, viene utilizzato Chirp3-HD.
instruction

string

Facoltativo. L'istruzione utilizzata per sintetizzare il parlato quando si utilizza un modello generativo.

BargeInConfig

Rappresentazione JSON 
{
  "disableBargeIn": boolean,
  "bargeInAwareness": boolean
}
Campi
disableBargeIn
(deprecated)

boolean

Facoltativo. Deprecato: disable_barge_in è deprecato a favore di disable_barge_in_control in ChannelProfile.

Disattiva l'interruzione da parte dell'utente mentre l'agente sta parlando. Se impostato su true, l'input utente durante la riproduzione della risposta dell'agente verrà ignorato.
bargeInAwareness

boolean

Facoltativo. Se questa opzione è attiva, l'agente adatterà la sua risposta successiva in base al presupposto che l'utente non abbia ascoltato l'intero messaggio precedente dell'agente. Non deve essere utilizzato in scenari in cui le risposte dell'agente vengono visualizzate visivamente.

Durata

Rappresentazione JSON 
{
  "seconds": string,
  "nanos": integer
}
Campi
seconds

string (int64 format)

Secondi con segno dell'intervallo di tempo. Deve essere compreso tra -315.576.000.000 e +315.576.000.000 inclusi. Nota: questi limiti sono calcolati da: 60 sec/min * 60 min/ora * 24 ore/giorno * 365,25 giorni/anno * 10.000 anni
nanos

integer

Frazioni di secondo con segno con risoluzione in nanosecondi dell'intervallo di tempo. Le durate inferiori a un secondo sono rappresentate con un campo seconds pari a 0 e un campo nanos positivo o negativo. Per durate di un secondo o più, un valore diverso da zero per il campo nanos deve avere lo stesso segno del campo seconds. Deve essere compreso tra -999.999.999 e +999.999.999 inclusi.

AmbientSoundConfig

Rappresentazione 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.
}
Campi
volumeGainDb

number

Facoltativo. Guadagno del volume (in dB) del volume nativo normale supportato dal rumore ambientale, nell'intervallo [-96,0, 16,0]. Se non viene impostato o se viene impostato su un valore pari a 0, 0 (dB), la riproduzione avverrà con l'ampiezza del segnale nativo normale. Un valore di -6,0 (dB) verrà riprodotto a circa la metà dell'ampiezza del segnale nativo normale. Un valore di +6,0 (dB) verrà riprodotto a un'ampiezza pari a circa il doppio dell'ampiezza del segnale nativo normale. Ti consigliamo vivamente di non superare i +10 (dB), poiché in genere non si verifica un aumento effettivo del volume per valori superiori.
Campo unione source. Rumore ambientale da riprodurre con la risposta sintetizzata dell'agente per migliorare la naturalezza della conversazione. source può essere solo uno dei seguenti tipi:
prebuiltAmbientNoise
(deprecated)

enum (PrebuiltAmbientNoise)

Facoltativo. Deprecato: prebuilt_ambient_noise è deprecato e sostituito con prebuilt_ambient_sound.
gcsUri

string

Facoltativo. Rumore ambientale sotto forma di file WAV monocanale a 16 kHz archiviato in Cloud Storage.

Nota: assicurati che l'agente di servizio CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com disponga dell'autorizzazione storage.objects.get per l'oggetto Cloud Storage.
prebuiltAmbientSound

string

Facoltativo. Nome del suono ambientale predefinito. I valori validi sono: - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner"

CustomVoiceSample

Rappresentazione JSON 
{
  "name": string,
  "voiceSampleGcsUri": string,
  "consentAudioGcsUri": string,
  "voiceInstruction": string,
  "previewAudioContent": string,
  "previewText": string,
  "warnings": [
    {
      object (Warning)
    }
  ],
  "voiceInstructionMode": enum (VoiceInstructionMode)
}
Campi
name

string

Facoltativo. Il nome definito dall'utente per il campione di voce personalizzata.
voiceSampleGcsUri

string

Facoltativo. L'URI Cloud Storage del campione audio per la clonazione della voce. Il campione audio deve essere un file WAV monocanale a 24 kHz.
consentAudioGcsUri

string

Facoltativo. Audio di consenso per la clonazione vocale.
voiceInstruction

string

Facoltativo. Istruzioni in linguaggio naturale per lo stile, il tono, il ritmo o la pronuncia della voce.
previewAudioContent

string (bytes format)

Solo output. Audio di anteprima sintetizzato per la voce personalizzata, formattato come WAV canonico (LINEAR16, 24 kHz, 16 bit, mono).

Una stringa con codifica in base64.
previewText

string

Facoltativo. Testo per la sintesi dell'audio di anteprima per la voce personalizzata.
warnings[]

object (Warning)

Solo output. Messaggi di avviso riscontrati durante l'elaborazione della clonazione della voce (ad es. livello audio basso).
voiceInstructionMode

enum (VoiceInstructionMode)

Facoltativo. Modalità di istruzione per il campione vocale. Se non specificato, il valore predefinito è NO_INSTRUCTION.

Avviso

Rappresentazione JSON 
{
  "message": string,
  "type": enum (WarningType)
}
Campi
message

string

Solo output. Una descrizione dell'avviso leggibile da una persona.
type

enum (WarningType)

Solo output. Il tipo di avviso.

LoggingSettings

Rappresentazione 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
}
Campi
redactionConfig

object (RedactionConfig)

Facoltativo. Configurazione della modalità di oscuramento dei dati sensibili.
audioRecordingConfig

object (AudioRecordingConfig)

Facoltativo. Configurazione della modalità di registrazione delle interazioni audio. L'audio è soggetto a oscuramento come configurato in RedactionConfig.
unredactedAudioRecordingConfig

object (AudioRecordingConfig)

Facoltativo. Configura una registrazione aggiuntiva dell'audio non oscurato. Può essere utilizzato per conservare una copia audio non elaborata quando l'oscuramento dell'audio è enabled, in genere per scopi di controllo o monitoraggio.
bigqueryExportSettings

object (BigQueryExportSettings)

Facoltativo. Configura i comportamenti di esportazione di BigQuery per l'app. I dati della conversazione sono soggetti a oscuramento come configurato in RedactionConfig.
unredactedBigqueryExportSettings

object (BigQueryExportSettings)

Facoltativo. Configura i comportamenti di esportazione di BigQuery per l'app. Se l'opzione è abilitata, i dati della conversazione non oscurati verranno esportati nelle tabelle BigQuery.
cloudLoggingSettings

object (CloudLoggingSettings)

Facoltativo. Impostazioni per descrivere i comportamenti di Cloud Logging per l'app.
conversationLoggingSettings

object (ConversationLoggingSettings)

Facoltativo. Impostazioni per descrivere i comportamenti di logging delle conversazioni per l'app.
evaluationAudioRecordingConfig

object (AudioRecordingConfig)

Facoltativo. Configurazione della modalità di registrazione delle interazioni audio per la valutazione. Per impostazione predefinita, la registrazione audio non è attivata per le sessioni di valutazione.
metricAnalysisSettings

object (MetricAnalysisSettings)

Facoltativo. Impostazioni per descrivere i comportamenti di raccolta dei dati delle conversazioni per la pipeline di analisi LLM dell'app.
requiredRecordingConsent

boolean

Facoltativo. Se l'app deve indicare cosa potrebbe essere registrato prima di conservare qualsiasi dato.

Se impostato su true, una sessione inizia con la registrazione disattivata e rimane disattivata finché il client non invia SessionInput.recording_control, che poi decide ogni turno da quel momento in poi. Ciò include la registrazione audio, la cronologia delle conversazioni, l'esportazione in BigQuery e Cloud Logging.

Se l'opzione è impostata su false, ovvero il valore predefinito, le impostazioni precedenti decidono autonomamente e il client non deve inviare nulla.

RedactionConfig

Rappresentazione JSON 
{
  "enableRedaction": boolean,
  "inspectTemplate": string,
  "deidentifyTemplate": string
}
Campi
enableRedaction

boolean

Facoltativo. Se true, l'oscuramento verrà applicato in vari scenari di logging, tra cui la cronologia delle conversazioni, Cloud Logging e la registrazione audio.
inspectTemplate

string

Facoltativo. Nome del template di ispezione DLP per configurare il rilevamento dei tipi di dati sensibili.

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

string

Facoltativo. Nome del template di anonimizzazione DLP per indicare come anonimizzare i contenuti.

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

AudioRecordingConfig

Rappresentazione JSON 
{
  "gcsBucket": string,
  "gcsPathPrefix": string
}
Campi
gcsBucket

string

Facoltativo. Il bucket Cloud Storage in cui archiviare le registrazioni audio della sessione. L'URI deve iniziare con "gs://".

Scegli una località del bucket che soddisfi i tuoi requisiti di residenza dei dati.

Nota: se il bucket Cloud Storage si trova in un progetto diverso da quello dell'app, devi concedere l'autorizzazione storage.objects.create all'agente di servizio CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
gcsPathPrefix

string

Facoltativo. Il prefisso del percorso di Cloud Storage per le registrazioni audio.

Questo prefisso può includere i seguenti segnaposto, che verranno sostituiti dinamicamente al momento della pubblicazione: - $project: ID progetto - $location: posizione dell'app - $app: ID app - $date: data della sessione nel formato AAAA-MM-GG - $session: ID sessione

Se il prefisso del percorso non è specificato, verrà utilizzato il prefisso predefinito $project/$location/$app/$date/$session/.

BigQueryExportSettings

Rappresentazione JSON 
{
  "enabled": boolean,
  "project": string,
  "dataset": string
}
Campi
enabled

boolean

Facoltativo. Indica se l'esportazione in BigQuery è abilitata.
project

string

Facoltativo. L'ID progetto del set di dati BigQuery in cui esportare i dati.

Nota: se il set di dati BigQuery si trova in un progetto diverso da quello dell'app, devi concedere il ruolo roles/bigquery.admin all'agente di servizio CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
dataset

string

Facoltativo. L'ID set di dati BigQuery in cui esportare i dati.

CloudLoggingSettings

Rappresentazione JSON 
{
  "enableCloudLogging": boolean
}
Campi
enableCloudLogging

boolean

Facoltativo. Indica se abilitare Cloud Logging per le sessioni.

ConversationLoggingSettings

Rappresentazione JSON 
{
  "disableConversationLogging": boolean,
  "retentionWindow": string
}
Campi
disableConversationLogging

boolean

Facoltativo. Indica se disattivare il logging delle conversazioni per le sessioni.
retentionWindow

string (Duration format)

Facoltativo. Controlla il periodo di conservazione della conversazione. Se non viene impostato, la conversazione verrà conservata per 365 giorni.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".

MetricAnalysisSettings

Rappresentazione JSON 
{
  "llmMetricsOptedOut": boolean
}
Campi
llmMetricsOptedOut

boolean

Facoltativo. Indica se raccogliere i dati della conversazione per le metriche di analisi LLM. Se il valore è true, i dati della conversazione non verranno raccolti per le metriche di analisi LLM; in caso contrario, i dati della conversazione verranno raccolti.

ErrorHandlingSettings

Rappresentazione JSON 
{
  "errorHandlingStrategy": enum (ErrorHandlingStrategy),
  "fallbackResponseConfig": {
    object (FallbackResponseConfig)
  },
  "endSessionConfig": {
    object (EndSessionConfig)
  }
}
Campi
errorHandlingStrategy

enum (ErrorHandlingStrategy)

Facoltativo. La strategia da utilizzare per la gestione degli errori.
fallbackResponseConfig

object (FallbackResponseConfig)

Facoltativo. Configurazione per la gestione delle risposte di fallback.
endSessionConfig

object (EndSessionConfig)

Facoltativo. Configurazione per terminare la sessione in caso di errori di sistema (ad es. errori LLM).

FallbackResponseConfig

Rappresentazione JSON 
{
  "customFallbackMessages": {
    string: string,
    ...
  },
  "maxFallbackAttempts": integer
}
Campi
customFallbackMessages

map (key: string, value: string)

Facoltativo. I messaggi di riserva in caso di errori di sistema (ad es. errori LLM), mappati in base al codice lingua supportato.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
maxFallbackAttempts

integer

Facoltativo. Il numero massimo di tentativi di fallback da effettuare prima che l'agente emetta l'indicatore EndSession.

CustomFallbackMessagesEntry

Rappresentazione JSON 
{
  "key": string,
  "value": string
}
Campi
key

string
value

string

EndSessionConfig

Rappresentazione JSON 
{

  // Union field _escalate_session can be only one of the following:
  "escalateSession": boolean
  // End of list of possible types for union field _escalate_session.
}
Campi

Campo unione _escalate_session.

_escalate_session può essere solo uno dei seguenti tipi:
escalateSession

boolean

Facoltativo. Se assegnare la sessione a un livello superiore in EndSession. Se la sessione viene riassegnata, metadata in EndSession conterrà session_escalated = true. Per maggiori dettagli, consulta https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent.

ModelSettings

Rappresentazione JSON 
{
  "model": string,
  "thinkingLevel": enum (ThinkingLevel),

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

string

Facoltativo. Il modello LLM che l'agente deve utilizzare. Se non viene impostato, l'agente erediterà il modello dall'agente parent.
thinkingLevel

enum (ThinkingLevel)

Facoltativo. Il livello di ragionamento del modello.

Campo unione _temperature.

_temperature può essere solo uno dei seguenti tipi:
temperature

number

Facoltativo. Se impostata, questa temperatura verrà utilizzata per il modello LLM. La temperatura controlla la casualità delle risposte del modello. Le temperature più basse producono risposte più prevedibili. Temperature più elevate producono risposte più creative.

EvaluationMetricsThresholds

Rappresentazione JSON 
{
  "goldenEvaluationMetricsThresholds": {
    object (GoldenEvaluationMetricsThresholds)
  },
  "hallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "goldenHallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "scenarioHallucinationMetricBehavior": enum (HallucinationMetricBehavior)
}
Campi
goldenEvaluationMetricsThresholds

object (GoldenEvaluationMetricsThresholds)

Facoltativo. Le soglie delle metriche di valutazione secondo regole d'oro.
hallucinationMetricBehavior
(deprecated)

enum (HallucinationMetricBehavior)

Facoltativo. Ritirato: utilizza invece golden_hallucination_metric_behavior. Il comportamento della metrica delle allucinazioni è attualmente utilizzato per le valutazioni golden.
goldenHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

Facoltativo. Il comportamento della metrica delle allucinazioni per le valutazioni golden.
scenarioHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

Facoltativo. Il comportamento della metrica delle allucinazioni per le valutazioni degli scenari.

GoldenEvaluationMetricsThresholds

Rappresentazione JSON 
{
  "turnLevelMetricsThresholds": {
    object (TurnLevelMetricsThresholds)
  },
  "expectationLevelMetricsThresholds": {
    object (ExpectationLevelMetricsThresholds)
  },
  "toolMatchingSettings": {
    object (ToolMatchingSettings)
  }
}
Campi
turnLevelMetricsThresholds

object (TurnLevelMetricsThresholds)

Facoltativo. Le soglie delle metriche a livello di turno.
expectationLevelMetricsThresholds

object (ExpectationLevelMetricsThresholds)

Facoltativo. Le soglie delle metriche a livello di aspettativa.
toolMatchingSettings

object (ToolMatchingSettings)

Facoltativo. Le impostazioni di corrispondenza dello strumento. Una chiamata allo strumento aggiuntiva è una chiamata allo strumento presente nell'esecuzione, ma che non corrisponde a nessuna chiamata allo strumento nell'aspettativa golden.

TurnLevelMetricsThresholds

Rappresentazione 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.
}
Campi
semanticSimilarityChannel

enum (SemanticSimilarityChannel)

Facoltativo. Il canale di somiglianza semantica da utilizzare per la valutazione.

Campo unione _semantic_similarity_success_threshold.

_semantic_similarity_success_threshold può essere solo uno dei seguenti tipi:
semanticSimilaritySuccessThreshold

integer

Facoltativo. La soglia di successo per la somiglianza semantica. Deve essere un numero intero compreso tra 0 e 4. Il valore predefinito è >= 3.

Campo unione _overall_tool_invocation_correctness_threshold.

_overall_tool_invocation_correctness_threshold può essere solo uno dei seguenti tipi:
overallToolInvocationCorrectnessThreshold

number

Facoltativo. La soglia di successo per la correttezza complessiva della chiamata dello strumento. Deve essere un numero in virgola mobile compreso tra 0 e 1. Il valore predefinito è 1.0.

ExpectationLevelMetricsThresholds

Rappresentazione 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.
}
Campi

Campo unione _tool_invocation_parameter_correctness_threshold.

_tool_invocation_parameter_correctness_threshold può essere solo uno dei seguenti tipi:
toolInvocationParameterCorrectnessThreshold

number

Facoltativo. La soglia di successo per la correttezza dei singoli parametri di chiamata dello strumento. Deve essere un numero in virgola mobile compreso tra 0 e 1. Il valore predefinito è 1.0.

ToolMatchingSettings

Rappresentazione JSON 
{
  "extraToolCallBehavior": enum (ExtraToolCallBehavior)
}
Campi
extraToolCallBehavior

enum (ExtraToolCallBehavior)

Facoltativo. Comportamento per le chiamate allo strumento aggiuntive. Il valore predefinito è FAIL.

VariableDeclaration

Rappresentazione JSON 
{
  "name": string,
  "description": string,
  "schema": {
    object (Schema)
  }
}
Campi
name

string

Obbligatorio. Il nome della variabile. Il nome deve iniziare con una lettera o un trattino basso e contenere solo lettere, numeri o trattini bassi.
description

string

Obbligatorio. La descrizione della variabile.
schema

object (Schema)

Obbligatorio. Lo schema della variabile.

Schema

Rappresentazione 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.
}
Campi
type

enum (Type)

Obbligatorio. Il tipo di dati.
properties

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

Facoltativo. Proprietà di Type.OBJECT.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
required[]

string

Facoltativo. Proprietà obbligatorie di Type.OBJECT.
description

string

Facoltativo. La descrizione dei dati.
items

object (Schema)

Facoltativo. Schema degli elementi di Type.ARRAY.
nullable

boolean

Facoltativo. Indica se il valore può essere null.
uniqueItems

boolean

Facoltativo. Indica che gli elementi nell'array devono essere univoci. Si applica solo a TYPE.ARRAY.
prefixItems[]

object (Schema)

Facoltativo. Schemi degli elementi iniziali di Type.ARRAY.
additionalProperties

object (Schema)

Facoltativo. Può essere un valore booleano o un oggetto e controlla la presenza di proprietà aggiuntive.
anyOf[]

object (Schema)

Facoltativo. Il valore deve essere convalidato rispetto a uno o più sottoschemi nell'elenco.
enum[]

string

Facoltativo. Possibili valori dell'elemento di tipo primitivo con formato enum. Esempi: 1. Possiamo definire la direzione come : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. Possiamo definire il numero dell'appartamento come : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default

value (Value format)

Facoltativo. Valore predefinito dei dati.
ref

string

Facoltativo. Consente riferimenti indiretti tra i nodi dello schema. Il valore deve essere un riferimento valido a un elemento secondario della radice defs.

Ad esempio, lo schema seguente definisce un riferimento a un nodo dello schema denominato "Pet":

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

Il valore della proprietà "pet" è un riferimento al nodo dello schema denominato "Pet". Per maggiori dettagli, consulta https://json-schema.org/understanding-json-schema/structuring.
defs

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

Facoltativo. Una mappa delle definizioni da utilizzare per ref. Consentito solo nella radice dello schema.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
title

string

Facoltativo. Il titolo dello schema.
minItems

string (int64 format)

Facoltativo. Numero minimo di elementi per Type.ARRAY.
maxItems

string (int64 format)

Facoltativo. Numero massimo di elementi per Type.ARRAY.

Campo unione _minimum.

_minimum può essere solo uno dei seguenti tipi:
minimum

number

Facoltativo. Valore minimo per Type.INTEGER e Type.NUMBER.

Campo unione _maximum.

_maximum può essere solo uno dei seguenti tipi:
maximum

number

Facoltativo. Valore massimo per Type.INTEGER e Type.NUMBER.

PropertiesEntry

Rappresentazione JSON 
{
  "key": string,
  "value": {
    object (Schema)
  }
}
Campi
key

string
value

object (Schema)

Valore

Rappresentazione 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.
}
Campi
Campo unione kind. Il tipo di valore. kind può essere solo uno dei seguenti tipi:
nullValue

null

Rappresenta un null JSON.
numberValue

number

Rappresenta un numero JSON. Non deve essere NaN, Infinity o -Infinity, poiché questi valori non sono supportati in JSON. Inoltre, non può rappresentare valori Int64 di grandi dimensioni, poiché il formato JSON in genere non li supporta nel tipo di numero.
stringValue

string

Rappresenta una stringa JSON.
boolValue

boolean

Rappresentano un valore booleano JSON (valore letterale true o false in JSON).
structValue

object (Struct format)

Rappresenta un oggetto JSON.
listValue

array (ListValue format)

Rappresenta un array JSON.

Struct

Rappresentazione JSON 
{
  "fields": {
    string: value,
    ...
  }
}
Campi
fields

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

Mappa non ordinata di valori con tipo dinamico.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

Rappresentazione JSON 
{
  "key": string,
  "value": value
}
Campi
key

string
value

value (Value format)

ListValue

Rappresentazione JSON 
{
  "values": [
    value
  ]
}
Campi
values[]

value (Value format)

Campo ripetuto di valori con tipo dinamico.

DefsEntry

Rappresentazione JSON 
{
  "key": string,
  "value": {
    object (Schema)
  }
}
Campi
key

string
value

object (Schema)

DataStoreSettings

Rappresentazione JSON 
{
  "engines": [
    {
      object (Engine)
    }
  ]
}
Campi
engines[]

object (Engine)

Solo output. I motori per l'app.

Motore

Rappresentazione JSON 
{
  "name": string,
  "type": enum (Type)
}
Campi
name

string

Solo output. Il nome della risorsa del motore. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type

enum (Type)

Solo output. Il tipo di motore.

ChannelProfile

Rappresentazione JSON 
{
  "profileId": string,
  "channelType": enum (ChannelType),
  "personaProperty": {
    object (PersonaProperty)
  },
  "webWidgetConfig": {
    object (WebWidgetConfig)
  },
  "whatsappConfig": {
    object (WhatsAppConfig)
  },
  "instagramConfig": {
    object (InstagramConfig)
  },

  // Union field _disable_dtmf can be only one of the following:
  "disableDtmf": boolean
  // End of list of possible types for union field _disable_dtmf.

  // Union field _disable_barge_in_control can be only one of the following:
  "disableBargeInControl": boolean
  // End of list of possible types for union field _disable_barge_in_control.

  // Union field _noise_suppression_level can be only one of the following:
  "noiseSuppressionLevel": string
  // End of list of possible types for union field _noise_suppression_level.
}
Campi
profileId

string

Facoltativo. L'identificatore univoco del profilo del canale.
channelType

enum (ChannelType)

Facoltativo. Il tipo di profilo del canale.
personaProperty

object (PersonaProperty)

Facoltativo. La proprietà persona del profilo del canale.
webWidgetConfig

object (WebWidgetConfig)

Facoltativo. La configurazione del widget web.
whatsappConfig

object (WhatsAppConfig)

Facoltativo. Configurazione specifica per i deployment di WhatsApp.
instagramConfig

object (InstagramConfig)

Facoltativo. Configurazione specifica per i deployment di Instagram.

Campo unione _disable_dtmf.

_disable_dtmf può essere solo uno dei seguenti tipi:
disableDtmf

boolean

Facoltativo. Indica se disattivare il DTMF (dual-tone multi-frequency).

Campo unione _disable_barge_in_control.

_disable_barge_in_control può essere solo uno dei seguenti tipi:
disableBargeInControl

boolean

Facoltativo. Indica se disattivare il controllo dell'interruzione da parte dell'utente nella conversazione. - true: le interruzioni dell'utente sono disattivate mentre l'agente parla. - false: l'agente mantiene il controllo automatico su quando l'utente può interrompere.

Campo unione _noise_suppression_level.

_noise_suppression_level può essere solo uno dei seguenti tipi:
noiseSuppressionLevel

string

Facoltativo. Il livello di eliminazione dei rumori del profilo del canale. I valori disponibili sono "low", "moderate", "high", "very_high".

PersonaProperty

Rappresentazione JSON 
{
  "persona": enum (Persona)
}
Campi
persona

enum (Persona)

Facoltativo. La personalità del canale.

WebWidgetConfig

Rappresentazione JSON 
{
  "modality": enum (Modality),
  "theme": enum (Theme),
  "webWidgetTitle": string,
  "securitySettings": {
    object (SecuritySettings)
  }
}
Campi
modality

enum (Modality)

Facoltativo. La modalità del widget web.
theme

enum (Theme)

Facoltativo. Il tema del widget web.
webWidgetTitle

string

Facoltativo. Il titolo del widget web.
securitySettings

object (SecuritySettings)

Facoltativo. Le impostazioni di sicurezza del widget web.

SecuritySettings

Rappresentazione JSON 
{
  "enablePublicAccess": boolean,
  "enableOriginCheck": boolean,
  "allowedOrigins": [
    string
  ],
  "enableRecaptcha": boolean
}
Campi
enablePublicAccess

boolean

Facoltativo. Indica se l'accesso pubblico al widget web è abilitato. Se true, il widget web sarà accessibile pubblicamente. Se false, il widget web deve essere integrato con il tuo sistema di autenticazione e autorizzazione per restituire credenziali valide per l'accesso all'agente CES.
enableOriginCheck

boolean

Facoltativo. Indica se il controllo dell'origine per il widget web è abilitato. Se true, il widget web controllerà l'origine del sito web che lo carica e ne consentirà il caricamento solo nella stessa origine o in una delle origini consentite.
allowedOrigins[]

string

Facoltativo. Le origini autorizzate a ospitare il widget web. Un'origine è definita dal documento RFC 6454. Se il campo è vuoto, sono consentite tutte le origini. È consentito un massimo di 100 origini. Esempio: "https://example.com"
enableRecaptcha

boolean

Facoltativo. Indica se la verifica reCAPTCHA per il widget web è abilitata.

WhatsAppConfig

Rappresentazione JSON 
{
  "wabaId": string,
  "phoneNumberId": string,
  "phoneNumber": string,
  "displayName": string,
  "thumbnailUrl": string,
  "description": string
}
Campi
wabaId

string

Obbligatorio. L'ID account WhatsApp Business.
phoneNumberId

string

Obbligatorio. L'ID numero di telefono Meta.
phoneNumber

string

Facoltativo. Il numero di telefono in formato E.164.
displayName

string

Solo output. Il nome della pagina aziendale Meta recuperato.
thumbnailUrl

string

Solo output. L'URL della miniatura del profilo aziendale Meta recuperato.
description

string

Solo output. La descrizione della pagina o del profilo aziendale Meta.

InstagramConfig

Rappresentazione JSON 
{
  "instagramAccountId": string,
  "displayName": string,
  "thumbnailUrl": string,
  "description": string
}
Campi
instagramAccountId

string

Obbligatorio. L'ID account Instagram.
displayName

string

Solo output. Il nome della pagina aziendale Meta recuperato.
thumbnailUrl

string

Solo output. L'URL della miniatura del profilo aziendale Meta recuperato.
description

string

Solo output. La descrizione della pagina o del profilo aziendale Meta.

MetadataEntry

Rappresentazione JSON 
{
  "key": string,
  "value": string
}
Campi
key

string
value

string

Timestamp

Rappresentazione JSON 
{
  "seconds": string,
  "nanos": integer
}
Campi
seconds

string (int64 format)

Rappresenta i secondi dell'ora UTC dall'epoca di Unix 1970-01-01T00:00:00Z. Deve essere compreso tra -62135596800 e 253402300799 inclusi (che corrispondono a un intervallo compreso tra 0001-01-01T00:00:00Z e 9999-12-31T23:59:59Z).
nanos

integer

Frazioni di secondo non negative con risoluzione in nanosecondi. Questo campo è la parte in nanosecondi della durata, non un'alternativa ai secondi. I valori dei secondi negativi con frazioni devono comunque avere valori di nanosecondi non negativi che avanzano nel tempo. Deve essere un valore compreso tra 0 e 999.999.999 inclusi.

ClientCertificateSettings

Rappresentazione JSON 
{
  "tlsCertificate": string,
  "privateKey": string,
  "passphrase": string
}
Campi
tlsCertificate

string

Obbligatorio. Il certificato TLS codificato in formato PEM. Questa stringa deve includere le righe di intestazione iniziale e piè di pagina finale.
privateKey

string

Obbligatorio. Il nome della risorsa della versione del secret di SecretManager che archivia la chiave privata codificata in formato PEM. Formato: projects/{project}/secrets/{secret}/versions/{version}
passphrase

string

Facoltativo. Il nome della risorsa della versione del secret di SecretManager che archivia la passphrase per decriptare la chiave privata. Deve essere lasciato vuoto se la chiave privata non è criptata. Formato: projects/{project}/secrets/{secret}/versions/{version}

VpcScSettings

Rappresentazione JSON 
{
  "allowedOrigins": [
    string
  ]
}
Campi
allowedOrigins[]

string

Facoltativo. Le origini HTTP(S) consentite che gli strumenti OpenAPI nell'app possono chiamare direttamente quando i Controlli di servizio VPC sono abilitati. Queste stringhe devono corrispondere esattamente all'origine, inclusa la porta, se specificata. Ad esempio, "https://example.com" o "https://example.com:443". Questo elenco non si applica ancora agli strumenti Python che potrebbero effettuare chiamate HTTP dirette.

DashboardSettings

Rappresentazione JSON 
{
  "defaultDashboard": string
}
Campi
defaultDashboard

string

Facoltativo. Il nome della risorsa della dashboard predefinita di Contact Center Insights associata all'app. Questa è la dashboard che verrà visualizzata quando gli utenti accedono alla visualizzazione Monitoraggio dell'app.

Formato: projects/{project}/locations/{location}/dashboards/{dashboard}

FieldMask

Rappresentazione JSON 
{
  "paths": [
    string
  ]
}
Campi
paths[]

string

L'insieme di percorsi della maschera di campo.

PrebuiltAmbientNoise

Rumore ambientale predefinito.

Enum
PREBUILT_AMBIENT_NOISE_UNSPECIFIED Non specificato.
RETAIL_STORE Rumore ambientale di un negozio di vendita al dettaglio.
CONVENTION_HALL Rumore ambientale di una sala congressi.
OUTDOOR Rumore ambientale di una strada.

WarningType

Tipo di avviso rilevato durante l'elaborazione del campione vocale.

Enum
WARNING_TYPE_UNSPECIFIED Tipo di avviso non specificato.
LOW_AUDIO_LEVEL Il livello audio del campione vocale è troppo basso (ad es. ampiezza RMS bassa).

VoiceInstructionMode

Modalità di istruzione per il campione vocale.

Enum
VOICE_INSTRUCTION_MODE_UNSPECIFIED Modalità di istruzione non specificata. Il valore predefinito è NO_INSTRUCTION.
NO_INSTRUCTION Non verranno utilizzate istruzioni vocali.
GENERATE_INSTRUCTION L'istruzione vocale verrà generata automaticamente dall'AI a partire dal campione audio.
CUSTOM_INSTRUCTION Istruzione vocale personalizzata fornita dall'utente.

ErrorHandlingStrategy

Definisce la strategia per la gestione degli errori.

Enum
ERROR_HANDLING_STRATEGY_UNSPECIFIED Strategia di gestione degli errori non specificata.
NONE Non è attiva alcuna gestione specifica.
FALLBACK_RESPONSE In caso di errori di sistema (ad es. errori LLM), all'utente verrà restituito un messaggio di riserva.
END_SESSION In caso di errori di sistema (ad es. errori LLM), verrà emesso un segnale EndSession.

ThinkingLevel

Configurazione del livello di ragionamento per il modello.

Enum
THINKING_LEVEL_UNSPECIFIED Il livello di ragionamento non è specificato.
DEFAULT Livello di ragionamento predefinito.
LOW Livello di ragionamento basso.
MEDIUM Livello di ragionamento medio.
HIGH Livello di ragionamento elevato.

ToolExecutionMode

Definisce il comportamento di esecuzione degli strumenti se l'agente seleziona più strumenti contemporaneamente.

Enum
TOOL_EXECUTION_MODE_UNSPECIFIED Modalità di esecuzione dello strumento non specificata. Il valore predefinito è PARALLEL.
PARALLEL Se vengono selezionati più strumenti, verranno eseguiti in parallelo con lo stesso ToolContext.
SEQUENTIAL Se vengono selezionati più strumenti, verranno eseguiti in sequenza. Lo strumento successivo verrà eseguito solo dopo il completamento dello strumento precedente e potrà visualizzare il ToolContext aggiornato dello strumento precedente.

SemanticSimilarityChannel

Canale di similarità semantica da utilizzare.

Enum
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED Metrica non specificata. Il valore predefinito è TEXT.
TEXT Utilizza la somiglianza semantica del testo.
AUDIO Utilizza la somiglianza semantica dell'audio.

ExtraToolCallBehavior

Definisce il comportamento quando viene rilevata una chiamata allo strumento aggiuntiva. Una chiamata allo strumento aggiuntiva è una chiamata allo strumento presente nell'esecuzione, ma che non corrisponde a nessuna chiamata allo strumento nell'aspettativa golden.

Enum
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED Comportamento non specificato. Il valore predefinito è FAIL.
FAIL La valutazione non va a buon fine se viene rilevata una chiamata allo strumento aggiuntiva.
ALLOW Consenti la chiamata allo strumento aggiuntiva.

HallucinationMetricBehavior

Il comportamento della metrica delle allucinazioni. Indipendentemente dal comportamento, la metrica verrà sempre calcolata. La differenza è che, se disattivata, la metrica non viene utilizzata per calcolare il punteggio di valutazione complessivo.

Enum
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED Comportamento della metrica delle allucinazioni non specificato.
DISABLED Disabilita la metrica delle allucinazioni.
ENABLED Abilita la metrica delle allucinazioni.

Tipo

Tipi di dati OpenAPI.

Enum
TYPE_UNSPECIFIED Tipo non specificato.
STRING Tipo di stringa.
INTEGER Tipo di numero intero.
NUMBER Tipo di numero.
BOOLEAN Tipo booleano.
OBJECT Tipo di oggetto.
ARRAY Tipo di array.

NullValue

Rappresenta un null JSON.

NullValue è un sentinel che utilizza un enum con un solo valore per rappresentare il valore null per l'unione di tipi Value.

Un campo di tipo NullValue con un valore diverso da 0 è considerato non valido. La maggior parte dei serializzatori ProtoJSON emetterà un Value con un null_value impostato come null JSON indipendentemente dal valore intero, quindi eseguirà un round trip a un valore 0.

Enum
NULL_VALUE Valore null.

Tipo

Il tipo di motore. Consulta la documentazione disponibile all'indirizzo https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType e https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

Enum
TYPE_UNSPECIFIED Tipo di motore non specificato.
ENGINE_TYPE_CHAT Tipo di motore di chat. Il motore SOLUTION_TYPE_CHAT per l'app. Tutti i datastore del connettore aggiunti all'app verranno aggiunti a questo motore.

ChannelType

Il tipo di profilo del canale.

Enum
UNKNOWN Tipo di canale sconosciuto.
WEB_UI Canale UI web.
API Canale API.
TWILIO Canale Twilio.
GOOGLE_TELEPHONY_PLATFORM Canale della piattaforma di telefonia Google.
CONTACT_CENTER_AS_A_SERVICE Canale Contact Center as a Service (CCaaS).
CONTACT_CENTER_AS_A_SERVICE_CHAT Canale Contact Center as a Service (chat CCaaS).
FIVE9 Canale Five9.
CONTACT_CENTER_INTEGRATION Canale di integrazione del contact center di terze parti.
WHATSAPP Canale WhatsApp.
INSTAGRAM Canale Instagram.

Utente tipo

La personalità del canale.

Enum
UNKNOWN UNKNOWN persona.
CONCISE L'agente fornisce risposte concise e pertinenti
CHATTY L'agente fornisce contesto, spiegazioni e dettagli aggiuntivi

Modalità

Modalità del widget web.

Enum
MODALITY_UNSPECIFIED Modalità sconosciuta.
CHAT_AND_VOICE Il widget supporta sia l'input di chat che quello vocale.
VOICE_ONLY Il widget supporta solo l'input vocale.
CHAT_ONLY Il widget supporta solo l'input di chat.
CHAT_VOICE_AND_VIDEO Il widget supporta l'input di chat, voce e video.

Tema

Tema del widget web.

Enum
THEME_UNSPECIFIED Tema sconosciuto.
LIGHT Tema chiaro.
DARK Tema scuro.

Schema di output

Un'app funge da container di primo livello per un gruppo di agenti, tra cui l'agente principale e i suoi sub-agenti, insieme alle configurazioni associate. Questi agenti collaborano per raggiungere obiettivi specifici nel contesto dell'app.

App

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "pinned": boolean,
  "rootAgent": string,
  "languageSettings": {
    object (LanguageSettings)
  },
  "timeZoneSettings": {
    object (TimeZoneSettings)
  },
  "audioProcessingConfig": {
    object (AudioProcessingConfig)
  },
  "loggingSettings": {
    object (LoggingSettings)
  },
  "errorHandlingSettings": {
    object (ErrorHandlingSettings)
  },
  "modelSettings": {
    object (ModelSettings)
  },
  "toolExecutionMode": enum (ToolExecutionMode),
  "evaluationMetricsThresholds": {
    object (EvaluationMetricsThresholds)
  },
  "variableDeclarations": [
    {
      object (VariableDeclaration)
    }
  ],
  "predefinedVariableDeclarations": [
    {
      object (VariableDeclaration)
    }
  ],
  "globalInstruction": string,
  "guardrails": [
    string
  ],
  "dataStoreSettings": {
    object (DataStoreSettings)
  },
  "defaultChannelProfile": {
    object (ChannelProfile)
  },
  "metadata": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "deploymentCount": integer,
  "clientCertificateSettings": {
    object (ClientCertificateSettings)
  },
  "vpcScSettings": {
    object (VpcScSettings)
  },
  "locked": boolean,
  "validationErrors": [
    string
  ],
  "dashboardSettings": {
    object (DashboardSettings)
  }
}
Campi
name

string

Identificatore. L'identificatore univoco dell'app. Formato: projects/{project}/locations/{location}/apps/{app}
displayName

string

Obbligatorio. Nome visualizzato dell'app.
description

string

Facoltativo. Descrizione dell'app leggibile.
pinned

boolean

Facoltativo. Se l'app è bloccata nella lista di app.
rootAgent

string

Facoltativo. L'agente principale è l'entry point dell'app. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
languageSettings

object (LanguageSettings)

Facoltativo. Impostazioni della lingua dell'app.
timeZoneSettings

object (TimeZoneSettings)

Facoltativo. Impostazioni del fuso orario dell'app.
audioProcessingConfig

object (AudioProcessingConfig)

Facoltativo. Configurazione dell'elaborazione audio dell'app.
loggingSettings

object (LoggingSettings)

Facoltativo. Impostazioni di logging dell'app.
errorHandlingSettings

object (ErrorHandlingSettings)

Facoltativo. Impostazioni di gestione degli errori dell'app.
modelSettings

object (ModelSettings)

Facoltativo. Le impostazioni predefinite del modello LLM per l'app. Le singole risorse (ad es. agenti, guardrail) possono eseguire l'override di queste configurazioni in base alle esigenze.
toolExecutionMode

enum (ToolExecutionMode)

Facoltativo. La modalità di esecuzione dello strumento per l'app. Se non viene fornita, il valore predefinito sarà PARALLEL.
evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

Facoltativo. Le soglie di valutazione dell'app.
variableDeclarations[]

object (VariableDeclaration)

Facoltativo. Le dichiarazioni delle variabili.
predefinedVariableDeclarations[]

object (VariableDeclaration)

Solo output. Le dichiarazioni delle variabili predefinite per l'app.
globalInstruction

string

Facoltativo. Istruzioni per tutti gli agenti nell'app. Puoi utilizzare questa istruzione per configurare un'identità o una personalità stabile per tutti gli agenti.
guardrails[]

string

Facoltativo. Elenco di guardrail per l'app. Formato: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
dataStoreSettings

object (DataStoreSettings)

Facoltativo. Le impostazioni del datastore per l'app.
defaultChannelProfile

object (ChannelProfile)

Facoltativo. Il profilo del canale predefinito utilizzato dall'app.
metadata

map (key: string, value: string)

Facoltativo. Metadati relativi all'app. Questo campo può essere utilizzato per archiviare informazioni aggiuntive relative ai dettagli o agli utilizzi previsti dell'app.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Solo output. Timestamp della creazione dell'app.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo output. Timestamp dell'ultimo aggiornamento dell'app.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
etag

string

Solo output. Etag utilizzato per garantire che l'oggetto non sia cambiato durante un'operazione di lettura, modifica e scrittura. Se l'etag è vuoto, l'aggiornamento sovrascriverà eventuali modifiche simultanee.
deploymentCount

integer

Solo output. Numero di deployment nell'app.
clientCertificateSettings

object (ClientCertificateSettings)

Facoltativo. Le impostazioni predefinite del certificato client per l'app.
vpcScSettings

object (VpcScSettings)

Facoltativo. Impostazioni VPC-SC per l'app.
locked

boolean

Facoltativo. Indica se l'app è bloccata per le modifiche. Se l'app è bloccata, le modifiche alle risorse dell'app verranno rifiutate.
validationErrors[]

string

Solo output. Errori di configurazione o avvisi nell'app.
dashboardSettings

object (DashboardSettings)

Facoltativo. Impostazioni della dashboard specifiche per l'app per collegare e configurare le dashboard di Contact Center Insights.

LanguageSettings

Rappresentazione JSON 
{
  "defaultLanguageCode": string,
  "supportedLanguageCodes": [
    string
  ],
  "enableMultilingualSupport": boolean,
  "fallbackAction": string
}
Campi
defaultLanguageCode

string

Facoltativo. Il codice lingua predefinito dell'app.
supportedLanguageCodes[]

string

Facoltativo. Elenco dei codici lingua supportati dall'app, oltre a default_language_code.
enableMultilingualSupport

boolean

Facoltativo. Abilita il supporto multilingue. Se true, gli agenti nell'app utilizzeranno istruzioni predefinite per migliorare la gestione degli input multilingue.
fallbackAction
(deprecated)

string

Facoltativo. Ritirata: questa funzionalità non è più supportata. Utilizza invece enable_multilingual_support per migliorare la gestione dell'input multilingue. L'azione da eseguire quando un agente riceve un input in una lingua non supportata.

Può trattarsi di un'azione predefinita o di una chiamata allo strumento personalizzata. I valori validi sono: - Il nome completo della risorsa di uno strumento, che attiva l'esecuzione di uno strumento specifico. - Un'azione di sistema predefinita, come "escalate" o "exit", che attiva un segnale EndSession con il corrispondente metadata per terminare la conversazione.

TimeZoneSettings

Rappresentazione JSON 
{
  "timeZone": string
}
Campi
timeZone

string

Facoltativo. Il fuso orario dell'app dal database dei fusi orari, ad esempio America/Los_Angeles, Europe/Paris.

AudioProcessingConfig

Rappresentazione JSON 
{
  "synthesizeSpeechConfigs": {
    string: {
      object (SynthesizeSpeechConfig)
    },
    ...
  },
  "bargeInConfig": {
    object (BargeInConfig)
  },
  "inactivityTimeout": string,
  "ambientSoundConfig": {
    object (AmbientSoundConfig)
  },
  "customVoiceSamples": [
    {
      object (CustomVoiceSample)
    }
  ]
}
Campi
synthesizeSpeechConfigs

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

Facoltativo. Configurazione della modalità di sintesi della risposta dell'agente, mappatura dal codice lingua a SynthesizeSpeechConfig.

Se la configurazione per il codice lingua specificato non viene trovata, verrà utilizzata la configurazione per il codice lingua principale. Ad esempio, se la mappa contiene "en-us" ed "en" e il codice lingua specificato è "en-gb", verrà utilizzata la configurazione "en".

Nota: il codice lingua non fa distinzione tra maiuscole e minuscole.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
bargeInConfig

object (BargeInConfig)

Facoltativo. Configura il comportamento dell'agente per le attività di interruzione dell'utente.
inactivityTimeout

string (Duration format)

Facoltativo. La durata dell'inattività dell'utente (nessun parlato o interazione) prima che l'agente chieda all'utente di interagire di nuovo. Se non viene impostato, l'agente non chiederà all'utente di interagire nuovamente.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
ambientSoundConfig

object (AmbientSoundConfig)

Facoltativo. Configurazione del suono ambientale da riprodurre con la risposta sintetizzata dell'agente, per migliorare la naturalezza della conversazione.
customVoiceSamples[]

object (CustomVoiceSample)

Facoltativo. Configura campioni di voce personalizzati per la clonazione della voce.

SynthesizeSpeechConfigsEntry

Rappresentazione JSON 
{
  "key": string,
  "value": {
    object (SynthesizeSpeechConfig)
  }
}
Campi
key

string
value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

Rappresentazione JSON 
{
  "voice": string,
  "speakingRate": number,
  "model": string,
  "instruction": string
}
Campi
voice

string

Facoltativo. Il nome della voce. Se non viene impostata, il servizio sceglierà una voce in base agli altri parametri, ad esempio language_code.

Per l'elenco delle voci disponibili, consulta Voci e lingue supportate di Cloud Text-to-Speech.
speakingRate

number

Facoltativo. La velocità del parlato nell'intervallo [0,25, 2,0]. 1.0 è la velocità nativa normale supportata dalla voce specifica. 2.0 è il doppio della velocità e 0.5 è la metà della velocità. I valori al di fuori dell'intervallo [0,25, 2,0] restituiranno un errore.
model

string

Facoltativo. Il modello utilizzato per sintetizzare l'audio. Valori attualmente supportati: - "gemini-3.1-flash-tts-preview" Se vuoto, viene utilizzato Chirp3-HD.
instruction

string

Facoltativo. L'istruzione utilizzata per sintetizzare il parlato quando si utilizza un modello generativo.

BargeInConfig

Rappresentazione JSON 
{
  "disableBargeIn": boolean,
  "bargeInAwareness": boolean
}
Campi
disableBargeIn
(deprecated)

boolean

Facoltativo. Deprecato: disable_barge_in è deprecato a favore di disable_barge_in_control in ChannelProfile.

Disattiva l'interruzione da parte dell'utente mentre l'agente sta parlando. Se impostato su true, l'input utente durante la riproduzione della risposta dell'agente verrà ignorato.
bargeInAwareness

boolean

Facoltativo. Se questa opzione è attiva, l'agente adatterà la sua risposta successiva in base al presupposto che l'utente non abbia ascoltato l'intero messaggio precedente dell'agente. Non deve essere utilizzato in scenari in cui le risposte dell'agente vengono visualizzate visivamente.

Durata

Rappresentazione JSON 
{
  "seconds": string,
  "nanos": integer
}
Campi
seconds

string (int64 format)

Secondi con segno dell'intervallo di tempo. Deve essere compreso tra -315.576.000.000 e +315.576.000.000 inclusi. Nota: questi limiti sono calcolati da: 60 sec/min * 60 min/ora * 24 ore/giorno * 365,25 giorni/anno * 10.000 anni
nanos

integer

Frazioni di secondo con segno con risoluzione in nanosecondi dell'intervallo di tempo. Le durate inferiori a un secondo sono rappresentate con un campo seconds pari a 0 e un campo nanos positivo o negativo. Per durate di un secondo o più, un valore diverso da zero per il campo nanos deve avere lo stesso segno del campo seconds. Deve essere compreso tra -999.999.999 e +999.999.999 inclusi.

AmbientSoundConfig

Rappresentazione 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.
}
Campi
volumeGainDb

number

Facoltativo. Guadagno del volume (in dB) del volume nativo normale supportato dal rumore ambientale, nell'intervallo [-96,0, 16,0]. Se non viene impostato o se viene impostato su un valore pari a 0, 0 (dB), la riproduzione avverrà con l'ampiezza del segnale nativo normale. Un valore di -6,0 (dB) verrà riprodotto a circa la metà dell'ampiezza del segnale nativo normale. Un valore di +6,0 (dB) verrà riprodotto a un'ampiezza pari a circa il doppio dell'ampiezza del segnale nativo normale. Ti consigliamo vivamente di non superare i +10 (dB), poiché in genere non si verifica un aumento effettivo del volume per valori superiori.
Campo unione source. Rumore ambientale da riprodurre con la risposta sintetizzata dell'agente per migliorare la naturalezza della conversazione. source può essere solo uno dei seguenti tipi:
prebuiltAmbientNoise
(deprecated)

enum (PrebuiltAmbientNoise)

Facoltativo. Deprecato: prebuilt_ambient_noise è deprecato e sostituito con prebuilt_ambient_sound.
gcsUri

string

Facoltativo. Rumore ambientale sotto forma di file WAV monocanale a 16 kHz archiviato in Cloud Storage.

Nota: assicurati che l'agente di servizio CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com disponga dell'autorizzazione storage.objects.get per l'oggetto Cloud Storage.
prebuiltAmbientSound

string

Facoltativo. Nome del suono ambientale predefinito. I valori validi sono: - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner"

CustomVoiceSample

Rappresentazione JSON 
{
  "name": string,
  "voiceSampleGcsUri": string,
  "consentAudioGcsUri": string,
  "voiceInstruction": string,
  "previewAudioContent": string,
  "previewText": string,
  "warnings": [
    {
      object (Warning)
    }
  ],
  "voiceInstructionMode": enum (VoiceInstructionMode)
}
Campi
name

string

Facoltativo. Il nome definito dall'utente per il campione di voce personalizzata.
voiceSampleGcsUri

string

Facoltativo. L'URI Cloud Storage del campione audio per la clonazione della voce. Il campione audio deve essere un file WAV monocanale a 24 kHz.
consentAudioGcsUri

string

Facoltativo. Audio di consenso per la clonazione vocale.
voiceInstruction

string

Facoltativo. Istruzioni in linguaggio naturale per lo stile, il tono, il ritmo o la pronuncia della voce.
previewAudioContent

string (bytes format)

Solo output. Audio di anteprima sintetizzato per la voce personalizzata, formattato come WAV canonico (LINEAR16, 24 kHz, 16 bit, mono).

Una stringa con codifica in base64.
previewText

string

Facoltativo. Testo per la sintesi dell'audio di anteprima per la voce personalizzata.
warnings[]

object (Warning)

Solo output. Messaggi di avviso riscontrati durante l'elaborazione della clonazione della voce (ad es. livello audio basso).
voiceInstructionMode

enum (VoiceInstructionMode)

Facoltativo. Modalità di istruzione per il campione vocale. Se non specificato, il valore predefinito è NO_INSTRUCTION.

Avviso

Rappresentazione JSON 
{
  "message": string,
  "type": enum (WarningType)
}
Campi
message

string

Solo output. Una descrizione dell'avviso leggibile da una persona.
type

enum (WarningType)

Solo output. Il tipo di avviso.

LoggingSettings

Rappresentazione 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
}
Campi
redactionConfig

object (RedactionConfig)

Facoltativo. Configurazione della modalità di oscuramento dei dati sensibili.
audioRecordingConfig

object (AudioRecordingConfig)

Facoltativo. Configurazione della modalità di registrazione delle interazioni audio. L'audio è soggetto a oscuramento come configurato in RedactionConfig.
unredactedAudioRecordingConfig

object (AudioRecordingConfig)

Facoltativo. Configura una registrazione aggiuntiva dell'audio non oscurato. Può essere utilizzato per conservare una copia audio non elaborata quando l'oscuramento dell'audio è enabled, in genere per scopi di controllo o monitoraggio.
bigqueryExportSettings

object (BigQueryExportSettings)

Facoltativo. Configura i comportamenti di esportazione di BigQuery per l'app. I dati della conversazione sono soggetti a oscuramento come configurato in RedactionConfig.
unredactedBigqueryExportSettings

object (BigQueryExportSettings)

Facoltativo. Configura i comportamenti di esportazione di BigQuery per l'app. Se l'opzione è abilitata, i dati della conversazione non oscurati verranno esportati nelle tabelle BigQuery.
cloudLoggingSettings

object (CloudLoggingSettings)

Facoltativo. Impostazioni per descrivere i comportamenti di Cloud Logging per l'app.
conversationLoggingSettings

object (ConversationLoggingSettings)

Facoltativo. Impostazioni per descrivere i comportamenti di logging delle conversazioni per l'app.
evaluationAudioRecordingConfig

object (AudioRecordingConfig)

Facoltativo. Configurazione della modalità di registrazione delle interazioni audio per la valutazione. Per impostazione predefinita, la registrazione audio non è attivata per le sessioni di valutazione.
metricAnalysisSettings

object (MetricAnalysisSettings)

Facoltativo. Impostazioni per descrivere i comportamenti di raccolta dei dati delle conversazioni per la pipeline di analisi LLM dell'app.
requiredRecordingConsent

boolean

Facoltativo. Se l'app deve indicare cosa potrebbe essere registrato prima di conservare qualsiasi dato.

Se impostato su true, una sessione inizia con la registrazione disattivata e rimane disattivata finché il client non invia SessionInput.recording_control, che poi decide ogni turno da quel momento in poi. Ciò include la registrazione audio, la cronologia delle conversazioni, l'esportazione in BigQuery e Cloud Logging.

Se l'opzione è impostata su false, ovvero il valore predefinito, le impostazioni precedenti decidono autonomamente e il client non deve inviare nulla.

RedactionConfig

Rappresentazione JSON 
{
  "enableRedaction": boolean,
  "inspectTemplate": string,
  "deidentifyTemplate": string
}
Campi
enableRedaction

boolean

Facoltativo. Se true, l'oscuramento verrà applicato in vari scenari di logging, tra cui la cronologia delle conversazioni, Cloud Logging e la registrazione audio.
inspectTemplate

string

Facoltativo. Nome del template di ispezione DLP per configurare il rilevamento dei tipi di dati sensibili.

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

string

Facoltativo. Nome del template di anonimizzazione DLP per indicare come anonimizzare i contenuti.

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

AudioRecordingConfig

Rappresentazione JSON 
{
  "gcsBucket": string,
  "gcsPathPrefix": string
}
Campi
gcsBucket

string

Facoltativo. Il bucket Cloud Storage in cui archiviare le registrazioni audio della sessione. L'URI deve iniziare con "gs://".

Scegli una località del bucket che soddisfi i tuoi requisiti di residenza dei dati.

Nota: se il bucket Cloud Storage si trova in un progetto diverso da quello dell'app, devi concedere l'autorizzazione storage.objects.create all'agente di servizio CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
gcsPathPrefix

string

Facoltativo. Il prefisso del percorso di Cloud Storage per le registrazioni audio.

Questo prefisso può includere i seguenti segnaposto, che verranno sostituiti dinamicamente al momento della pubblicazione: - $project: ID progetto - $location: posizione dell'app - $app: ID app - $date: data della sessione nel formato AAAA-MM-GG - $session: ID sessione

Se il prefisso del percorso non è specificato, verrà utilizzato il prefisso predefinito $project/$location/$app/$date/$session/.

BigQueryExportSettings

Rappresentazione JSON 
{
  "enabled": boolean,
  "project": string,
  "dataset": string
}
Campi
enabled

boolean

Facoltativo. Indica se l'esportazione in BigQuery è abilitata.
project

string

Facoltativo. L'ID progetto del set di dati BigQuery in cui esportare i dati.

Nota: se il set di dati BigQuery si trova in un progetto diverso da quello dell'app, devi concedere il ruolo roles/bigquery.admin all'agente di servizio CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
dataset

string

Facoltativo. L'ID set di dati BigQuery in cui esportare i dati.

CloudLoggingSettings

Rappresentazione JSON 
{
  "enableCloudLogging": boolean
}
Campi
enableCloudLogging

boolean

Facoltativo. Indica se abilitare Cloud Logging per le sessioni.

ConversationLoggingSettings

Rappresentazione JSON 
{
  "disableConversationLogging": boolean,
  "retentionWindow": string
}
Campi
disableConversationLogging

boolean

Facoltativo. Indica se disattivare il logging delle conversazioni per le sessioni.
retentionWindow

string (Duration format)

Facoltativo. Controlla il periodo di conservazione della conversazione. Se non viene impostato, la conversazione verrà conservata per 365 giorni.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".

MetricAnalysisSettings

Rappresentazione JSON 
{
  "llmMetricsOptedOut": boolean
}
Campi
llmMetricsOptedOut

boolean

Facoltativo. Indica se raccogliere i dati della conversazione per le metriche di analisi LLM. Se il valore è true, i dati della conversazione non verranno raccolti per le metriche di analisi LLM; in caso contrario, i dati della conversazione verranno raccolti.

ErrorHandlingSettings

Rappresentazione JSON 
{
  "errorHandlingStrategy": enum (ErrorHandlingStrategy),
  "fallbackResponseConfig": {
    object (FallbackResponseConfig)
  },
  "endSessionConfig": {
    object (EndSessionConfig)
  }
}
Campi
errorHandlingStrategy

enum (ErrorHandlingStrategy)

Facoltativo. La strategia da utilizzare per la gestione degli errori.
fallbackResponseConfig

object (FallbackResponseConfig)

Facoltativo. Configurazione per la gestione delle risposte di fallback.
endSessionConfig

object (EndSessionConfig)

Facoltativo. Configurazione per terminare la sessione in caso di errori di sistema (ad es. errori LLM).

FallbackResponseConfig

Rappresentazione JSON 
{
  "customFallbackMessages": {
    string: string,
    ...
  },
  "maxFallbackAttempts": integer
}
Campi
customFallbackMessages

map (key: string, value: string)

Facoltativo. I messaggi di riserva in caso di errori di sistema (ad es. errori LLM), mappati in base al codice lingua supportato.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
maxFallbackAttempts

integer

Facoltativo. Il numero massimo di tentativi di fallback da effettuare prima che l'agente emetta l'indicatore EndSession.

CustomFallbackMessagesEntry

Rappresentazione JSON 
{
  "key": string,
  "value": string
}
Campi
key

string
value

string

EndSessionConfig

Rappresentazione JSON 
{

  // Union field _escalate_session can be only one of the following:
  "escalateSession": boolean
  // End of list of possible types for union field _escalate_session.
}
Campi

Campo unione _escalate_session.

_escalate_session può essere solo uno dei seguenti tipi:
escalateSession

boolean

Facoltativo. Se assegnare la sessione a un livello superiore in EndSession. Se la sessione viene riassegnata, metadata in EndSession conterrà session_escalated = true. Per maggiori dettagli, consulta https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent.

ModelSettings

Rappresentazione JSON 
{
  "model": string,
  "thinkingLevel": enum (ThinkingLevel),

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

string

Facoltativo. Il modello LLM che l'agente deve utilizzare. Se non viene impostato, l'agente erediterà il modello dall'agente parent.
thinkingLevel

enum (ThinkingLevel)

Facoltativo. Il livello di ragionamento del modello.

Campo unione _temperature.

_temperature può essere solo uno dei seguenti tipi:
temperature

number

Facoltativo. Se impostata, questa temperatura verrà utilizzata per il modello LLM. La temperatura controlla la casualità delle risposte del modello. Le temperature più basse producono risposte più prevedibili. Temperature più elevate producono risposte più creative.

EvaluationMetricsThresholds

Rappresentazione JSON 
{
  "goldenEvaluationMetricsThresholds": {
    object (GoldenEvaluationMetricsThresholds)
  },
  "hallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "goldenHallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "scenarioHallucinationMetricBehavior": enum (HallucinationMetricBehavior)
}
Campi
goldenEvaluationMetricsThresholds

object (GoldenEvaluationMetricsThresholds)

Facoltativo. Le soglie delle metriche di valutazione secondo regole d'oro.
hallucinationMetricBehavior
(deprecated)

enum (HallucinationMetricBehavior)

Facoltativo. Ritirato: utilizza invece golden_hallucination_metric_behavior. Il comportamento della metrica delle allucinazioni è attualmente utilizzato per le valutazioni golden.
goldenHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

Facoltativo. Il comportamento della metrica delle allucinazioni per le valutazioni golden.
scenarioHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

Facoltativo. Il comportamento della metrica delle allucinazioni per le valutazioni degli scenari.

GoldenEvaluationMetricsThresholds

Rappresentazione JSON 
{
  "turnLevelMetricsThresholds": {
    object (TurnLevelMetricsThresholds)
  },
  "expectationLevelMetricsThresholds": {
    object (ExpectationLevelMetricsThresholds)
  },
  "toolMatchingSettings": {
    object (ToolMatchingSettings)
  }
}
Campi
turnLevelMetricsThresholds

object (TurnLevelMetricsThresholds)

Facoltativo. Le soglie delle metriche a livello di turno.
expectationLevelMetricsThresholds

object (ExpectationLevelMetricsThresholds)

Facoltativo. Le soglie delle metriche a livello di aspettativa.
toolMatchingSettings

object (ToolMatchingSettings)

Facoltativo. Le impostazioni di corrispondenza dello strumento. Una chiamata allo strumento aggiuntiva è una chiamata allo strumento presente nell'esecuzione, ma che non corrisponde a nessuna chiamata allo strumento nell'aspettativa golden.

TurnLevelMetricsThresholds

Rappresentazione 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.
}
Campi
semanticSimilarityChannel

enum (SemanticSimilarityChannel)

Facoltativo. Il canale di somiglianza semantica da utilizzare per la valutazione.

Campo unione _semantic_similarity_success_threshold.

_semantic_similarity_success_threshold può essere solo uno dei seguenti tipi:
semanticSimilaritySuccessThreshold

integer

Facoltativo. La soglia di successo per la somiglianza semantica. Deve essere un numero intero compreso tra 0 e 4. Il valore predefinito è >= 3.

Campo unione _overall_tool_invocation_correctness_threshold.

_overall_tool_invocation_correctness_threshold può essere solo uno dei seguenti tipi:
overallToolInvocationCorrectnessThreshold

number

Facoltativo. La soglia di successo per la correttezza complessiva della chiamata dello strumento. Deve essere un numero in virgola mobile compreso tra 0 e 1. Il valore predefinito è 1.0.

ExpectationLevelMetricsThresholds

Rappresentazione 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.
}
Campi

Campo unione _tool_invocation_parameter_correctness_threshold.

_tool_invocation_parameter_correctness_threshold può essere solo uno dei seguenti tipi:
toolInvocationParameterCorrectnessThreshold

number

Facoltativo. La soglia di successo per la correttezza dei singoli parametri di chiamata dello strumento. Deve essere un numero in virgola mobile compreso tra 0 e 1. Il valore predefinito è 1.0.

ToolMatchingSettings

Rappresentazione JSON 
{
  "extraToolCallBehavior": enum (ExtraToolCallBehavior)
}
Campi
extraToolCallBehavior

enum (ExtraToolCallBehavior)

Facoltativo. Comportamento per le chiamate allo strumento aggiuntive. Il valore predefinito è FAIL.

VariableDeclaration

Rappresentazione JSON 
{
  "name": string,
  "description": string,
  "schema": {
    object (Schema)
  }
}
Campi
name

string

Obbligatorio. Il nome della variabile. Il nome deve iniziare con una lettera o un trattino basso e contenere solo lettere, numeri o trattini bassi.
description

string

Obbligatorio. La descrizione della variabile.
schema

object (Schema)

Obbligatorio. Lo schema della variabile.

Schema

Rappresentazione 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.
}
Campi
type

enum (Type)

Obbligatorio. Il tipo di dati.
properties

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

Facoltativo. Proprietà di Type.OBJECT.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
required[]

string

Facoltativo. Proprietà obbligatorie di Type.OBJECT.
description

string

Facoltativo. La descrizione dei dati.
items

object (Schema)

Facoltativo. Schema degli elementi di Type.ARRAY.
nullable

boolean

Facoltativo. Indica se il valore può essere null.
uniqueItems

boolean

Facoltativo. Indica che gli elementi nell'array devono essere univoci. Si applica solo a TYPE.ARRAY.
prefixItems[]

object (Schema)

Facoltativo. Schemi degli elementi iniziali di Type.ARRAY.
additionalProperties

object (Schema)

Facoltativo. Può essere un valore booleano o un oggetto e controlla la presenza di proprietà aggiuntive.
anyOf[]

object (Schema)

Facoltativo. Il valore deve essere convalidato rispetto a uno o più sottoschemi nell'elenco.
enum[]

string

Facoltativo. Possibili valori dell'elemento di tipo primitivo con formato enum. Esempi: 1. Possiamo definire la direzione come : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. Possiamo definire il numero dell'appartamento come : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default

value (Value format)

Facoltativo. Valore predefinito dei dati.
ref

string

Facoltativo. Consente riferimenti indiretti tra i nodi dello schema. Il valore deve essere un riferimento valido a un elemento secondario della radice defs.

Ad esempio, lo schema seguente definisce un riferimento a un nodo dello schema denominato "Pet":

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

Il valore della proprietà "pet" è un riferimento al nodo dello schema denominato "Pet". Per maggiori dettagli, consulta https://json-schema.org/understanding-json-schema/structuring.
defs

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

Facoltativo. Una mappa delle definizioni da utilizzare per ref. Consentito solo nella radice dello schema.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
title

string

Facoltativo. Il titolo dello schema.
minItems

string (int64 format)

Facoltativo. Numero minimo di elementi per Type.ARRAY.
maxItems

string (int64 format)

Facoltativo. Numero massimo di elementi per Type.ARRAY.

Campo unione _minimum.

_minimum può essere solo uno dei seguenti tipi:
minimum

number

Facoltativo. Valore minimo per Type.INTEGER e Type.NUMBER.

Campo unione _maximum.

_maximum può essere solo uno dei seguenti tipi:
maximum

number

Facoltativo. Valore massimo per Type.INTEGER e Type.NUMBER.

PropertiesEntry

Rappresentazione JSON 
{
  "key": string,
  "value": {
    object (Schema)
  }
}
Campi
key

string
value

object (Schema)

Valore

Rappresentazione 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.
}
Campi
Campo unione kind. Il tipo di valore. kind può essere solo uno dei seguenti tipi:
nullValue

null

Rappresenta un null JSON.
numberValue

number

Rappresenta un numero JSON. Non deve essere NaN, Infinity o -Infinity, poiché questi valori non sono supportati in JSON. Inoltre, non può rappresentare valori Int64 di grandi dimensioni, poiché il formato JSON in genere non li supporta nel tipo di numero.
stringValue

string

Rappresenta una stringa JSON.
boolValue

boolean

Rappresentano un valore booleano JSON (valore letterale true o false in JSON).
structValue

object (Struct format)

Rappresenta un oggetto JSON.
listValue

array (ListValue format)

Rappresenta un array JSON.

Struct

Rappresentazione JSON 
{
  "fields": {
    string: value,
    ...
  }
}
Campi
fields

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

Mappa non ordinata di valori con tipo dinamico.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

Rappresentazione JSON 
{
  "key": string,
  "value": value
}
Campi
key

string
value

value (Value format)

ListValue

Rappresentazione JSON 
{
  "values": [
    value
  ]
}
Campi
values[]

value (Value format)

Campo ripetuto di valori con tipo dinamico.

DefsEntry

Rappresentazione JSON 
{
  "key": string,
  "value": {
    object (Schema)
  }
}
Campi
key

string
value

object (Schema)

DataStoreSettings

Rappresentazione JSON 
{
  "engines": [
    {
      object (Engine)
    }
  ]
}
Campi
engines[]

object (Engine)

Solo output. I motori per l'app.

Motore

Rappresentazione JSON 
{
  "name": string,
  "type": enum (Type)
}
Campi
name

string

Solo output. Il nome della risorsa del motore. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type

enum (Type)

Solo output. Il tipo di motore.

ChannelProfile

Rappresentazione JSON 
{
  "profileId": string,
  "channelType": enum (ChannelType),
  "personaProperty": {
    object (PersonaProperty)
  },
  "webWidgetConfig": {
    object (WebWidgetConfig)
  },
  "whatsappConfig": {
    object (WhatsAppConfig)
  },
  "instagramConfig": {
    object (InstagramConfig)
  },

  // Union field _disable_dtmf can be only one of the following:
  "disableDtmf": boolean
  // End of list of possible types for union field _disable_dtmf.

  // Union field _disable_barge_in_control can be only one of the following:
  "disableBargeInControl": boolean
  // End of list of possible types for union field _disable_barge_in_control.

  // Union field _noise_suppression_level can be only one of the following:
  "noiseSuppressionLevel": string
  // End of list of possible types for union field _noise_suppression_level.
}
Campi
profileId

string

Facoltativo. L'identificatore univoco del profilo del canale.
channelType

enum (ChannelType)

Facoltativo. Il tipo di profilo del canale.
personaProperty

object (PersonaProperty)

Facoltativo. La proprietà persona del profilo del canale.
webWidgetConfig

object (WebWidgetConfig)

Facoltativo. La configurazione del widget web.
whatsappConfig

object (WhatsAppConfig)

Facoltativo. Configurazione specifica per i deployment di WhatsApp.
instagramConfig

object (InstagramConfig)

Facoltativo. Configurazione specifica per i deployment di Instagram.

Campo unione _disable_dtmf.

_disable_dtmf può essere solo uno dei seguenti tipi:
disableDtmf

boolean

Facoltativo. Indica se disattivare il DTMF (dual-tone multi-frequency).

Campo unione _disable_barge_in_control.

_disable_barge_in_control può essere solo uno dei seguenti tipi:
disableBargeInControl

boolean

Facoltativo. Indica se disattivare il controllo dell'interruzione da parte dell'utente nella conversazione. - true: le interruzioni dell'utente sono disattivate mentre l'agente parla. - false: l'agente mantiene il controllo automatico su quando l'utente può interrompere.

Campo unione _noise_suppression_level.

_noise_suppression_level può essere solo uno dei seguenti tipi:
noiseSuppressionLevel

string

Facoltativo. Il livello di eliminazione dei rumori del profilo del canale. I valori disponibili sono "low", "moderate", "high", "very_high".

PersonaProperty

Rappresentazione JSON 
{
  "persona": enum (Persona)
}
Campi
persona

enum (Persona)

Facoltativo. La personalità del canale.

WebWidgetConfig

Rappresentazione JSON 
{
  "modality": enum (Modality),
  "theme": enum (Theme),
  "webWidgetTitle": string,
  "securitySettings": {
    object (SecuritySettings)
  }
}
Campi
modality

enum (Modality)

Facoltativo. La modalità del widget web.
theme

enum (Theme)

Facoltativo. Il tema del widget web.
webWidgetTitle

string

Facoltativo. Il titolo del widget web.
securitySettings

object (SecuritySettings)

Facoltativo. Le impostazioni di sicurezza del widget web.

SecuritySettings

Rappresentazione JSON 
{
  "enablePublicAccess": boolean,
  "enableOriginCheck": boolean,
  "allowedOrigins": [
    string
  ],
  "enableRecaptcha": boolean
}
Campi
enablePublicAccess

boolean

Facoltativo. Indica se l'accesso pubblico al widget web è abilitato. Se true, il widget web sarà accessibile pubblicamente. Se false, il widget web deve essere integrato con il tuo sistema di autenticazione e autorizzazione per restituire credenziali valide per l'accesso all'agente CES.
enableOriginCheck

boolean

Facoltativo. Indica se il controllo dell'origine per il widget web è abilitato. Se true, il widget web controllerà l'origine del sito web che lo carica e ne consentirà il caricamento solo nella stessa origine o in una delle origini consentite.
allowedOrigins[]

string

Facoltativo. Le origini autorizzate a ospitare il widget web. Un'origine è definita dal documento RFC 6454. Se il campo è vuoto, sono consentite tutte le origini. È consentito un massimo di 100 origini. Esempio: "https://example.com"
enableRecaptcha

boolean

Facoltativo. Indica se la verifica reCAPTCHA per il widget web è abilitata.

WhatsAppConfig

Rappresentazione JSON 
{
  "wabaId": string,
  "phoneNumberId": string,
  "phoneNumber": string,
  "displayName": string,
  "thumbnailUrl": string,
  "description": string
}
Campi
wabaId

string

Obbligatorio. L'ID account WhatsApp Business.
phoneNumberId

string

Obbligatorio. L'ID numero di telefono Meta.
phoneNumber

string

Facoltativo. Il numero di telefono in formato E.164.
displayName

string

Solo output. Il nome della pagina aziendale Meta recuperato.
thumbnailUrl

string

Solo output. L'URL della miniatura del profilo aziendale Meta recuperato.
description

string

Solo output. La descrizione della pagina o del profilo aziendale Meta.

InstagramConfig

Rappresentazione JSON 
{
  "instagramAccountId": string,
  "displayName": string,
  "thumbnailUrl": string,
  "description": string
}
Campi
instagramAccountId

string

Obbligatorio. L'ID account Instagram.
displayName

string

Solo output. Il nome della pagina aziendale Meta recuperato.
thumbnailUrl

string

Solo output. L'URL della miniatura del profilo aziendale Meta recuperato.
description

string

Solo output. La descrizione della pagina o del profilo aziendale Meta.

MetadataEntry

Rappresentazione JSON 
{
  "key": string,
  "value": string
}
Campi
key

string
value

string

Timestamp

Rappresentazione JSON 
{
  "seconds": string,
  "nanos": integer
}
Campi
seconds

string (int64 format)

Rappresenta i secondi dell'ora UTC dall'epoca di Unix 1970-01-01T00:00:00Z. Deve essere compreso tra -62135596800 e 253402300799 inclusi (che corrispondono a un intervallo compreso tra 0001-01-01T00:00:00Z e 9999-12-31T23:59:59Z).
nanos

integer

Frazioni di secondo non negative con risoluzione in nanosecondi. Questo campo è la parte in nanosecondi della durata, non un'alternativa ai secondi. I valori dei secondi negativi con frazioni devono comunque avere valori di nanosecondi non negativi che avanzano nel tempo. Deve essere un valore compreso tra 0 e 999.999.999 inclusi.

ClientCertificateSettings

Rappresentazione JSON 
{
  "tlsCertificate": string,
  "privateKey": string,
  "passphrase": string
}
Campi
tlsCertificate

string

Obbligatorio. Il certificato TLS codificato in formato PEM. Questa stringa deve includere le righe di intestazione iniziale e piè di pagina finale.
privateKey

string

Obbligatorio. Il nome della risorsa della versione del secret di SecretManager che archivia la chiave privata codificata in formato PEM. Formato: projects/{project}/secrets/{secret}/versions/{version}
passphrase

string

Facoltativo. Il nome della risorsa della versione del secret di SecretManager che archivia la passphrase per decriptare la chiave privata. Deve essere lasciato vuoto se la chiave privata non è criptata. Formato: projects/{project}/secrets/{secret}/versions/{version}

VpcScSettings

Rappresentazione JSON 
{
  "allowedOrigins": [
    string
  ]
}
Campi
allowedOrigins[]

string

Facoltativo. Le origini HTTP(S) consentite che gli strumenti OpenAPI nell'app possono chiamare direttamente quando i Controlli di servizio VPC sono abilitati. Queste stringhe devono corrispondere esattamente all'origine, inclusa la porta, se specificata. Ad esempio, "https://example.com" o "https://example.com:443". Questo elenco non si applica ancora agli strumenti Python che potrebbero effettuare chiamate HTTP dirette.

DashboardSettings

Rappresentazione JSON 
{
  "defaultDashboard": string
}
Campi
defaultDashboard

string

Facoltativo. Il nome della risorsa della dashboard predefinita di Contact Center Insights associata all'app. Questa è la dashboard che verrà visualizzata quando gli utenti accedono alla visualizzazione Monitoraggio dell'app.

Formato: projects/{project}/locations/{location}/dashboards/{dashboard}

PrebuiltAmbientNoise

Rumore ambientale predefinito.

Enum
PREBUILT_AMBIENT_NOISE_UNSPECIFIED Non specificato.
RETAIL_STORE Rumore ambientale di un negozio di vendita al dettaglio.
CONVENTION_HALL Rumore ambientale di una sala congressi.
OUTDOOR Rumore ambientale di una strada.

WarningType

Tipo di avviso rilevato durante l'elaborazione del campione vocale.

Enum
WARNING_TYPE_UNSPECIFIED Tipo di avviso non specificato.
LOW_AUDIO_LEVEL Il livello audio del campione vocale è troppo basso (ad es. ampiezza RMS bassa).

VoiceInstructionMode

Modalità di istruzione per il campione vocale.

Enum
VOICE_INSTRUCTION_MODE_UNSPECIFIED Modalità di istruzione non specificata. Il valore predefinito è NO_INSTRUCTION.
NO_INSTRUCTION Non verranno utilizzate istruzioni vocali.
GENERATE_INSTRUCTION L'istruzione vocale verrà generata automaticamente dall'AI a partire dal campione audio.
CUSTOM_INSTRUCTION Istruzione vocale personalizzata fornita dall'utente.

ErrorHandlingStrategy

Definisce la strategia per la gestione degli errori.

Enum
ERROR_HANDLING_STRATEGY_UNSPECIFIED Strategia di gestione degli errori non specificata.
NONE Non è attiva alcuna gestione specifica.
FALLBACK_RESPONSE In caso di errori di sistema (ad es. errori LLM), all'utente verrà restituito un messaggio di riserva.
END_SESSION In caso di errori di sistema (ad es. errori LLM), verrà emesso un segnale EndSession.

ThinkingLevel

Configurazione del livello di ragionamento per il modello.

Enum
THINKING_LEVEL_UNSPECIFIED Il livello di ragionamento non è specificato.
DEFAULT Livello di ragionamento predefinito.
LOW Livello di ragionamento basso.
MEDIUM Livello di ragionamento medio.
HIGH Livello di ragionamento elevato.

ToolExecutionMode

Definisce il comportamento di esecuzione degli strumenti se l'agente seleziona più strumenti contemporaneamente.

Enum
TOOL_EXECUTION_MODE_UNSPECIFIED Modalità di esecuzione dello strumento non specificata. Il valore predefinito è PARALLEL.
PARALLEL Se vengono selezionati più strumenti, verranno eseguiti in parallelo con lo stesso ToolContext.
SEQUENTIAL Se vengono selezionati più strumenti, verranno eseguiti in sequenza. Lo strumento successivo verrà eseguito solo dopo il completamento dello strumento precedente e potrà visualizzare il ToolContext aggiornato dello strumento precedente.

SemanticSimilarityChannel

Canale di similarità semantica da utilizzare.

Enum
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED Metrica non specificata. Il valore predefinito è TEXT.
TEXT Utilizza la somiglianza semantica del testo.
AUDIO Utilizza la somiglianza semantica dell'audio.

ExtraToolCallBehavior

Definisce il comportamento quando viene rilevata una chiamata allo strumento aggiuntiva. Una chiamata allo strumento aggiuntiva è una chiamata allo strumento presente nell'esecuzione, ma che non corrisponde a nessuna chiamata allo strumento nell'aspettativa golden.

Enum
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED Comportamento non specificato. Il valore predefinito è FAIL.
FAIL La valutazione non va a buon fine se viene rilevata una chiamata allo strumento aggiuntiva.
ALLOW Consenti la chiamata allo strumento aggiuntiva.

HallucinationMetricBehavior

Il comportamento della metrica delle allucinazioni. Indipendentemente dal comportamento, la metrica verrà sempre calcolata. La differenza è che, se disattivata, la metrica non viene utilizzata per calcolare il punteggio di valutazione complessivo.

Enum
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED Comportamento della metrica delle allucinazioni non specificato.
DISABLED Disabilita la metrica delle allucinazioni.
ENABLED Abilita la metrica delle allucinazioni.

Tipo

Tipi di dati OpenAPI.

Enum
TYPE_UNSPECIFIED Tipo non specificato.
STRING Tipo di stringa.
INTEGER Tipo di numero intero.
NUMBER Tipo di numero.
BOOLEAN Tipo booleano.
OBJECT Tipo di oggetto.
ARRAY Tipo di array.

NullValue

Rappresenta un null JSON.

NullValue è un sentinel che utilizza un enum con un solo valore per rappresentare il valore null per l'unione di tipi Value.

Un campo di tipo NullValue con un valore diverso da 0 è considerato non valido. La maggior parte dei serializzatori ProtoJSON emetterà un Value con un null_value impostato come null JSON indipendentemente dal valore intero, quindi eseguirà un round trip a un valore 0.

Enum
NULL_VALUE Valore null.

Tipo

Il tipo di motore. Consulta la documentazione disponibile all'indirizzo https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType e https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

Enum
TYPE_UNSPECIFIED Tipo di motore non specificato.
ENGINE_TYPE_CHAT Tipo di motore di chat. Il motore SOLUTION_TYPE_CHAT per l'app. Tutti i datastore del connettore aggiunti all'app verranno aggiunti a questo motore.

ChannelType

Il tipo di profilo del canale.

Enum
UNKNOWN Tipo di canale sconosciuto.
WEB_UI Canale UI web.
API Canale API.
TWILIO Canale Twilio.
GOOGLE_TELEPHONY_PLATFORM Canale della piattaforma di telefonia Google.
CONTACT_CENTER_AS_A_SERVICE Canale Contact Center as a Service (CCaaS).
CONTACT_CENTER_AS_A_SERVICE_CHAT Canale Contact Center as a Service (chat CCaaS).
FIVE9 Canale Five9.
CONTACT_CENTER_INTEGRATION Canale di integrazione del contact center di terze parti.
WHATSAPP Canale WhatsApp.
INSTAGRAM Canale Instagram.

Utente tipo

La personalità del canale.

Enum
UNKNOWN UNKNOWN persona.
CONCISE L'agente fornisce risposte concise e pertinenti
CHATTY L'agente fornisce contesto, spiegazioni e dettagli aggiuntivi

Modalità

Modalità del widget web.

Enum
MODALITY_UNSPECIFIED Modalità sconosciuta.
CHAT_AND_VOICE Il widget supporta sia l'input di chat che quello vocale.
VOICE_ONLY Il widget supporta solo l'input vocale.
CHAT_ONLY Il widget supporta solo l'input di chat.
CHAT_VOICE_AND_VIDEO Il widget supporta l'input di chat, voce e video.

Tema

Tema del widget web.

Enum
THEME_UNSPECIFIED Tema sconosciuto.
LIGHT Tema chiaro.
DARK Tema scuro.

Annotazioni dello strumento

Le annotazioni degli strumenti vengono inviate ai client MCP per descrivere il rischio di base di un determinato strumento. La maggior parte dei client considera questi suggerimenti non attendibili, ma possono essere utilizzati per decidere quando inviare una richiesta di conferma a un utente.

Oltre alla stringa del titolo, i seguenti suggerimenti booleani sono definiti come segue:

  • readOnlyHint: se true, lo strumento non modifica il suo ambiente. Valore predefinito: false.
  • destructiveHint: se true, lo strumento può eseguire azioni distruttive. Se è false, lo strumento può eseguire solo azioni additive. Valore predefinito: true.
  • idempotentHint: se true, la chiamata ripetuta dello strumento con gli stessi argomenti non avrà alcun effetto aggiuntivo sul suo ambiente. Valore predefinito: false.
  • openWorldHint: se true, lo strumento può interagire con un "open world" di entità esterne. Se è false, lo strumento può interagire solo con entità interne. Ad esempio, uno strumento di ricerca web sarebbe open world, mentre uno strumento di memoria non lo sarebbe.

Destructive Hint: ✅ | Idempotent Hint: ❌ | Read Only Hint: ❌ | Open World Hint: ❌