MCP Tools Reference: ces.googleapis.com

Strumento: list_app_versions

Elenca tutte le versioni dell'app specificata.

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

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": "list_app_versions",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Schema di input

Messaggio di richiesta per AgentService.ListAppVersions.

ListAppVersionsRequest

Rappresentazione JSON 
{
  "parent": string,
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "orderBy": string
}
Campi
parent

string

Obbligatorio. Il nome della risorsa dell'app da cui elencare le versioni dell'app.
pageSize

integer

Facoltativo. Dimensioni della pagina richiesta. Il server potrebbe restituire meno elementi di quelli richiesti. Se non specificato, il server sceglierà un valore predefinito appropriato.
pageToken

string

Facoltativo. Il valore next_page_token restituito da una chiamata AgentService.ListAppVersions dell'elenco precedente.
filter

string

Facoltativo. Filtro da applicare quando vengono elencate le versioni dell'app. Per maggiori dettagli, visita la pagina https://google.aip.dev/160.
orderBy

string

Facoltativo. Campo in base al quale ordinare. Sono supportati solo "name" e "create_time". Per maggiori dettagli, consulta https://google.aip.dev/132#ordering.

Schema di output

Messaggio di risposta per AgentService.ListAppVersions.

ListAppVersionsResponse

Rappresentazione JSON 
{
  "appVersions": [
    {
      object (AppVersion)
    }
  ],
  "nextPageToken": string
}
Campi
appVersions[]

object (AppVersion)

L'elenco delle versioni dell'app.
nextPageToken

string

Un token che può essere inviato come ListAppVersionsRequest.page_token per recuperare la pagina successiva. L'assenza di questo campo indica che non sono presenti pagine successive.

AppVersion

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "creator": string,
  "createTime": string,
  "updateTime": string,
  "snapshot": {
    object (AppSnapshot)
  },
  "etag": string
}
Campi
name

string

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

string

Facoltativo. Il nome visualizzato della versione dell'app.
description

string

Facoltativo. La descrizione della versione dell'app.
creator

string

Solo output. Email dell'utente che ha creato la versione dell'app.
createTime

string (Timestamp format)

Solo output. Timestamp della creazione della versione 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 della versione 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".
snapshot

object (AppSnapshot)

Solo output. Lo snapshot dell'app al momento della creazione della versione.
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.

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.

AppSnapshot

Rappresentazione JSON 
{
  "app": {
    object (App)
  },
  "agents": [
    {
      object (Agent)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "examples": [
    {
      object (Example)
    }
  ],
  "guardrails": [
    {
      object (Guardrail)
    }
  ],
  "toolsets": [
    {
      object (Toolset)
    }
  ]
}
Campi
app

object (App)

Facoltativo. Le impostazioni di base dell'app.
agents[]

object (Agent)

Facoltativo. Elenco degli agenti nell'app.
tools[]

object (Tool)

Facoltativo. Elenco di strumenti nell'app.
examples[]

object (Example)

Facoltativo. Elenco di esempi nell'app.
guardrails[]

object (Guardrail)

Facoltativo. Elenco di guardrail nell'app.
toolsets[]

object (Toolset)

Facoltativo. Elenco di set di strumenti nell'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

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}

Agente

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "modelSettings": {
    object (ModelSettings)
  },
  "instruction": string,
  "tools": [
    string
  ],
  "childAgents": [
    string
  ],
  "beforeAgentCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterAgentCallbacks": [
    {
      object (Callback)
    }
  ],
  "beforeModelCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterModelCallbacks": [
    {
      object (Callback)
    }
  ],
  "beforeToolCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterToolCallbacks": [
    {
      object (Callback)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "guardrails": [
    string
  ],
  "etag": string,
  "toolsets": [
    {
      object (AgentToolset)
    }
  ],
  "generatedSummary": string,
  "transferRules": [
    {
      object (TransferRule)
    }
  ],
  "validationErrors": [
    string
  ],

  // Union field agent_type can be only one of the following:
  "llmAgent": {
    object (LlmAgent)
  },
  "remoteDialogflowAgent": {
    object (RemoteDialogflowAgent)
  },
  "remoteA2aAgent": {
    object (RemoteA2aAgent)
  }
  // End of list of possible types for union field agent_type.
}
Campi
name

string

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

string

Obbligatorio. Nome visualizzato dell'agente.
description

string

Facoltativo. Descrizione leggibile dell'agente.
modelSettings

object (ModelSettings)

Facoltativo. Configurazioni per il modello LLM.
instruction

string

Facoltativo. Istruzioni per il modello LLM per guidare il comportamento dell'agente.
tools[]

string

Facoltativo. Elenco degli strumenti disponibili per l'agente. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
childAgents[]

string

Facoltativo. Elenco degli agenti secondari nell'albero degli agenti. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
beforeAgentCallbacks[]

object (Callback)

Facoltativo. I callback da eseguire prima della chiamata dell'agente. I callback forniti vengono eseguiti in sequenza nell'ordine esatto in cui sono indicati nell'elenco. Se un callback restituisce una risposta sottoposta a override, l'esecuzione si interrompe e gli eventuali callback rimanenti vengono ignorati.
afterAgentCallbacks[]

object (Callback)

Facoltativo. I callback da eseguire dopo la chiamata dell'agente. I callback forniti vengono eseguiti in sequenza nell'ordine esatto in cui sono indicati nell'elenco. Se un callback restituisce una risposta sottoposta a override, l'esecuzione si interrompe e gli eventuali callback rimanenti vengono ignorati.
beforeModelCallbacks[]

object (Callback)

Facoltativo. I callback da eseguire prima della chiamata del modello. Se il modello viene chiamato più volte, il callback verrà eseguito più volte. I callback forniti vengono eseguiti in sequenza nell'ordine esatto in cui sono indicati nell'elenco. Se un callback restituisce una risposta sottoposta a override, l'esecuzione si interrompe e gli eventuali callback rimanenti vengono ignorati.
afterModelCallbacks[]

object (Callback)

Facoltativo. I callback da eseguire dopo la chiamata del modello. Se il modello viene chiamato più volte, il callback verrà eseguito più volte. I callback forniti vengono eseguiti in sequenza nell'ordine esatto in cui sono indicati nell'elenco. Se un callback restituisce una risposta sottoposta a override, l'esecuzione si interrompe e gli eventuali callback rimanenti vengono ignorati.
beforeToolCallbacks[]

object (Callback)

Facoltativo. I callback da eseguire prima che venga richiamato lo strumento. Se sono presenti più chiamate di strumenti, il callback verrà eseguito più volte. I callback forniti vengono eseguiti in sequenza nell'ordine esatto in cui sono indicati nell'elenco. Se un callback restituisce una risposta sottoposta a override, l'esecuzione si interrompe e gli eventuali callback rimanenti vengono ignorati.
afterToolCallbacks[]

object (Callback)

Facoltativo. I callback da eseguire dopo l'invocazione dello strumento. Se sono presenti più chiamate di strumenti, il callback verrà eseguito più volte. I callback forniti vengono eseguiti in sequenza nell'ordine esatto in cui sono indicati nell'elenco. Se un callback restituisce una risposta sottoposta a override, l'esecuzione si interrompe e gli eventuali callback rimanenti vengono ignorati.
createTime

string (Timestamp format)

Solo output. Timestamp della creazione dell'agente.

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

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".
guardrails[]

string

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

string

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.
toolsets[]

object (AgentToolset)

Facoltativo. Elenco di set di strumenti per l'agente.
generatedSummary

string

Solo output. Se l'agente è generato dall'assistente LLM, questo campo contiene un riepilogo descrittivo della generazione.
transferRules[]

object (TransferRule)

Facoltativo. Regole di trasferimento dell'agente. Se più regole corrispondono, verrà utilizzata la prima nell'elenco.
validationErrors[]

string

Solo output. Errori di configurazione o errori nell'agente che potrebbero influire sulla qualità dell'agente.
Campo unione agent_type. Il tipo di agente. agent_type può essere solo uno dei seguenti tipi:
llmAgent

object (LlmAgent)

Facoltativo. Il tipo di agente predefinito.
remoteDialogflowAgent

object (RemoteDialogflowAgent)

Facoltativo. L'agente Dialogflow remoto da utilizzare per l'esecuzione dell'agente. Se questo campo è impostato, tutte le altre proprietà a livello di agente verranno ignorate.

Nota: se l'agente Dialogflow si trova in un progetto diverso da quello dell'app, devi concedere roles/dialogflow.client all'agente di servizio CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
remoteA2aAgent

object (RemoteA2aAgent)

Facoltativo. L'agente A2A remoto da utilizzare per l'esecuzione dell'agente.

RemoteDialogflowAgent

Rappresentazione JSON 
{
  "agent": string,
  "flowId": string,
  "environmentId": string,
  "inputVariableMapping": {
    string: string,
    ...
  },
  "outputVariableMapping": {
    string: string,
    ...
  },
  "respectResponseInterruptionSettings": boolean,
  "languageCodeVariable": string
}
Campi
agent

string

Obbligatorio. Il nome risorsa dell'agente Dialogflow. Formato: projects/{project}/locations/{location}/agents/{agent}
flowId

string

Facoltativo. L'ID del flusso nell'agente Dialogflow.
environmentId

string

Facoltativo. L'ID ambiente dell'agente Dialogflow da utilizzare per l'esecuzione dell'agente. Se non specificato, verrà utilizzato l'ambiente bozza.
inputVariableMapping

map (key: string, value: string)

Facoltativo. La mappatura dei nomi delle variabili dell'app ai nomi dei parametri di sessione di Dialogflow da inviare all'agente Dialogflow come input.

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

map (key: string, value: string)

Facoltativo. La mappatura dei nomi dei parametri della sessione Dialogflow ai nomi delle variabili dell'app da inviare all'agente CES al termine dell'esecuzione dell'agente Dialogflow.

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

boolean

Facoltativo. Indica se rispettare le impostazioni di interruzione a livello di messaggio configurate nell'agente Dialogflow.

  • Se false: tutti i messaggi di risposta dell'agente Dialogflow seguono le impostazioni di interruzione a livello di app.
  • Se true: solo i messaggi di risposta con allow_playback_interruption impostato su true saranno interrompibili, tutti gli altri messaggi seguono le impostazioni di interruzione a livello di app.
languageCodeVariable

string

Facoltativo. Il nome della variabile che contiene il codice lingua da utilizzare per la sessione di Dialogflow. Se non viene specificato, verrà utilizzato il codice lingua predefinito dell'agente Dialogflow.

InputVariableMappingEntry

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

string
value

string

OutputVariableMappingEntry

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

string
value

string

RemoteA2aAgent

Rappresentazione JSON 
{
  "a2aConfig": {
    object (RemoteA2aConfig)
  }
}
Campi
a2aConfig

object (RemoteA2aConfig)

Obbligatorio. La configurazione della connessione A2A.

RemoteA2aConfig

Rappresentazione JSON 
{
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "inputVariableMapping": {
    string: string,
    ...
  },
  "outputVariableMapping": {
    string: string,
    ...
  },
  "streamingEnabled": boolean,
  "contextId": string,

  // Union field agent_spec can be only one of the following:
  "agentCard": {
    object (AgentCard)
  },
  "agentRegistry": string
  // End of list of possible types for union field agent_spec.
}
Campi
apiAuthentication

object (ApiAuthentication)

Facoltativo. Configurazione dell'autenticazione per la chiamata dell'agente remoto. Facoltativo se il riferimento al registry gestisce già l'autenticazione.
inputVariableMapping

map (key: string, value: string)

Facoltativo. Mappatura dei nomi delle variabili di input dell'agente remoto ai nomi delle variabili GECX.

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

map (key: string, value: string)

Facoltativo. Mappatura dei nomi delle variabili di output dell'agente remoto ai nomi delle variabili GECX.

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

boolean

Facoltativo. Indica se lo streaming è abilitato per l'agente remoto.
contextId

string

Facoltativo. Se non è vuoto, le interazioni con l'agente A2A remoto utilizzeranno questo ID contesto. Questo campo context_id può fare riferimento a una variabile di sessione come $context.variables.order_agent_session_id.
Campo unione agent_spec. Specifica dell'agente remoto. agent_spec può essere solo uno dei seguenti tipi:
agentCard

object (AgentCard)

Facoltativo. La scheda dell'agente completa definita in linea.
agentRegistry

string

Facoltativo. Riferimento all'agente in Agent Registry. Formato: projects/{project}/locations/{location}/agents/{agent}

AgentCard

Rappresentazione JSON 
{
  "name": string,
  "description": string,
  "supportedInterfaces": [
    {
      object (AgentInterface)
    }
  ],
  "version": string,
  "skills": [
    {
      object (AgentSkill)
    }
  ]
}
Campi
name

string

Obbligatorio. Un nome leggibile per l'agente.
description

string

Obbligatorio. Una descrizione del dominio di azione/spazio della soluzione dell'agente.
supportedInterfaces[]

object (AgentInterface)

Obbligatorio. Elenco ordinato delle interfacce supportate. La prima voce è quella preferita.
version

string

Obbligatorio. La versione dell'agente.
skills[]

object (AgentSkill)

Obbligatorio. Le skill rappresentano un'unità di abilità che un agente può eseguire. Questo può sembrare un po' astratto, ma rappresenta un insieme di azioni più mirate che l'agente ha un'alta probabilità di portare a termine con successo.

AgentInterface

Rappresentazione JSON 
{
  "url": string,
  "protocolBinding": string,
  "tenant": string,
  "protocolVersion": string
}
Campi
url

string

Obbligatorio. L'URL in cui è disponibile questa interfaccia. Deve essere un URL HTTPS assoluto valido in produzione. Esempio: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
protocolBinding

string

Obbligatorio. L'associazione del protocollo supportata in questo URL. Si tratta di una stringa in formato aperto, che può essere facilmente estesa per altre associazioni del protocollo. Quelli principali supportati ufficialmente sono JSONRPC, GRPC e HTTP+JSON.
tenant

string

ID tenant da utilizzare nella richiesta quando si chiama l'agente.
protocolVersion

string

Obbligatorio. La versione del protocollo A2A esposta da questa interfaccia. Utilizza l'ultima versione secondaria supportata per versione principale. Esempi: "0.3", "1.0"

AgentSkill

Rappresentazione JSON 
{
  "id": string,
  "name": string,
  "description": string,
  "tags": [
    string
  ],
  "examples": [
    string
  ],
  "inputModes": [
    string
  ],
  "outputModes": [
    string
  ]
}
Campi
id

string

Obbligatorio. Un identificatore univoco per la competenza dell'agente.
name

string

Obbligatorio. Un nome leggibile per la skill.
description

string

Obbligatorio. Una descrizione dettagliata della skill.
tags[]

string

Obbligatorio. Un insieme di parole chiave che descrivono le funzionalità della skill.
examples[]

string

Prompt o scenari di esempio che questa skill può gestire.
inputModes[]

string

L'insieme di tipi di media di input supportati per questa skill, che sostituisce i valori predefiniti dell'agente.
outputModes[]

string

L'insieme di tipi di media di output supportati per questa skill, che sostituisce i valori predefiniti dell'agente.

ApiAuthentication

Rappresentazione JSON 
{

  // Union field auth_config can be only one of the following:
  "apiKeyConfig": {
    object (ApiKeyConfig)
  },
  "oauthConfig": {
    object (OAuthConfig)
  },
  "serviceAgentIdTokenAuthConfig": {
    object (ServiceAgentIdTokenAuthConfig)
  },
  "serviceAccountAuthConfig": {
    object (ServiceAccountAuthConfig)
  },
  "bearerTokenConfig": {
    object (BearerTokenConfig)
  }
  // End of list of possible types for union field auth_config.
}
Campi
Campo unione auth_config. La configurazione di autenticazione. auth_config può essere solo uno dei seguenti tipi:
apiKeyConfig

object (ApiKeyConfig)

Facoltativo. Configurazione per l'autenticazione con chiave API.
oauthConfig

object (OAuthConfig)

Facoltativo. Configurazione per OAuth.
serviceAgentIdTokenAuthConfig

object (ServiceAgentIdTokenAuthConfig)

Facoltativo. Configurazione per l'autenticazione del token ID generata dall'agente di servizio CES.
serviceAccountAuthConfig

object (ServiceAccountAuthConfig)

Facoltativo. Configurazione per l'autenticazione del account di servizio.
bearerTokenConfig

object (BearerTokenConfig)

Facoltativo. Configurazione per l'autenticazione del token di connessione.

ApiKeyConfig

Rappresentazione JSON 
{
  "keyName": string,
  "apiKeySecretVersion": string,
  "requestLocation": enum (RequestLocation)
}
Campi
keyName

string

Obbligatorio. Il nome del parametro o dell'intestazione della chiave API. Ad esempio, Se la richiesta API è "https://example.com/act?X-Api-Key=", "X-Api-Key" sarà il nome del parametro.
apiKeySecretVersion

string

Obbligatorio. Il nome della risorsa della versione del secret di Secret Manager che archivia la chiave API. Formato: projects/{project}/secrets/{secret}/versions/{version}

Nota: devi concedere il ruolo roles/secretmanager.secretAccessor all'agente di servizio CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
requestLocation

enum (RequestLocation)

Obbligatorio. Località della chiave nella richiesta.

OAuthConfig

Rappresentazione JSON 
{
  "oauthGrantType": enum (OauthGrantType),
  "clientId": string,
  "clientSecretVersion": string,
  "tokenEndpoint": string,
  "scopes": [
    string
  ]
}
Campi
oauthGrantType

enum (OauthGrantType)

Obbligatorio. Tipi di autorizzazione con OAuth.
clientId

string

Obbligatorio. L'ID client del provider OAuth.
clientSecretVersion

string

Obbligatorio. Il nome della risorsa della versione del secret di SecretManager che archivia il client secret. Formato: projects/{project}/secrets/{secret}/versions/{version}

Nota: devi concedere il ruolo roles/secretmanager.secretAccessor all'agente di servizio CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
tokenEndpoint

string

Obbligatorio. L'endpoint del token nel provider OAuth da scambiare con un token di accesso.
scopes[]

string

Facoltativo. Gli ambiti OAuth da concedere.

ServiceAccountAuthConfig

Rappresentazione JSON 
{
  "serviceAccount": string,
  "scopes": [
    string
  ]
}
Campi
serviceAccount

string

Obbligatorio. L'indirizzo email del account di servizio utilizzato per l'autenticazione. CES utilizza questo account di servizio per scambiare un token di accesso, che viene poi inviato nell'intestazione Authorization della richiesta.

Il account di servizio deve avere il ruolo roles/iam.serviceAccountTokenCreator concesso all'agente di servizio CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
scopes[]

string

Facoltativo. Gli ambiti OAuth da concedere. Se non viene specificato, viene utilizzato l'ambito predefinito https://www.googleapis.com/auth/cloud-platform.

BearerTokenConfig

Rappresentazione JSON 
{
  "token": string
}
Campi
token

string

Obbligatorio. Il token di connessione. Deve essere nel formato $context.variables.<name_of_variable>.

InputVariableMappingEntry

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

string
value

string

OutputVariableMappingEntry

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

string
value

string

Callback

Rappresentazione JSON 
{
  "description": string,
  "disabled": boolean,
  "proactiveExecutionEnabled": boolean,

  // Union field callback can be only one of the following:
  "pythonCode": string
  // End of list of possible types for union field callback.
}
Campi
description

string

Facoltativo. Descrizione leggibile del callback.
disabled

boolean

Facoltativo. Indica se il callback è disattivato. I callback disattivati vengono ignorati dall'agente.
proactiveExecutionEnabled

boolean

Facoltativo. Se abilitato, il callback verrà eseguito anche sugli output intermedi del modello. Questa impostazione influisce solo sul callback dopo il modello. ABILITARE CON CAUTELA. In genere, il callback after_model deve essere eseguito solo dopo aver ricevuto tutte le risposte del modello. L'abilitazione dell'esecuzione proattiva potrebbe avere implicazioni negative sui costi e sulla latenza di esecuzione e deve essere abilitata solo in rare situazioni.
Campo unione callback. Il callback da eseguire. callback può essere solo uno dei seguenti tipi:
pythonCode

string

Obbligatorio. Il codice Python da eseguire per il callback.

AgentToolset

Rappresentazione JSON 
{
  "toolset": string,
  "toolIds": [
    string
  ]
}
Campi
toolset

string

Obbligatorio. Il nome della risorsa del set di strumenti. Formato: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
toolIds[]

string

Facoltativo. Gli ID degli strumenti per filtrare il set di strumenti.

TransferRule

Rappresentazione JSON 
{
  "childAgent": string,
  "direction": enum (Direction),

  // Union field rule_type can be only one of the following:
  "deterministicTransfer": {
    object (DeterministicTransfer)
  },
  "disablePlannerTransfer": {
    object (DisablePlannerTransfer)
  }
  // End of list of possible types for union field rule_type.
}
Campi
childAgent

string

Obbligatorio. Il nome della risorsa dell'agente secondario a cui si applica la regola. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
direction

enum (Direction)

Obbligatorio. La direzione del trasferimento.
Campo unione rule_type. Il tipo di regola. rule_type può essere solo uno dei seguenti tipi:
deterministicTransfer

object (DeterministicTransfer)

Facoltativo. Una regola che trasferisce immediatamente all'agente di destinazione quando la condizione è soddisfatta.
disablePlannerTransfer

object (DisablePlannerTransfer)

Facoltativo. Regola che impedisce al planner di trasferire all'agente di destinazione.

DeterministicTransfer

Rappresentazione JSON 
{

  // Union field condition_type can be only one of the following:
  "expressionCondition": {
    object (ExpressionCondition)
  },
  "pythonCodeCondition": {
    object (PythonCodeCondition)
  }
  // End of list of possible types for union field condition_type.
}
Campi
Campo unione condition_type. La condizione da valutare. condition_type può essere solo uno dei seguenti tipi:
expressionCondition

object (ExpressionCondition)

Facoltativo. Una regola che valuta una condizione dello stato della sessione. Se la condizione restituisce true, il trasferimento viene eseguito.
pythonCodeCondition

object (PythonCodeCondition)

Facoltativo. Una regola che utilizza un blocco di codice Python per valutare le condizioni. Se la condizione restituisce true, il trasferimento viene eseguito.

ExpressionCondition

Rappresentazione JSON 
{
  "expression": string
}
Campi
expression

string

Obbligatorio. La rappresentazione di stringa della condizione cloud.api.Expression.

PythonCodeCondition

Rappresentazione JSON 
{
  "pythonCode": string
}
Campi
pythonCode

string

Obbligatorio. Il codice Python da eseguire.

DisablePlannerTransfer

Rappresentazione JSON 
{
  "expressionCondition": {
    object (ExpressionCondition)
  }
}
Campi
expressionCondition

object (ExpressionCondition)

Obbligatorio. Se la condizione restituisce true, il planner non potrà eseguire il trasferimento all'agente di destinazione.

Strumento

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,
  "executionType": enum (ExecutionType),
  "timeout": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "generatedSummary": string,
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },
  "readOnly": boolean,

  // Union field tool_type can be only one of the following:
  "clientFunction": {
    object (ClientFunction)
  },
  "openApiTool": {
    object (OpenApiTool)
  },
  "googleSearchTool": {
    object (GoogleSearchTool)
  },
  "connectorTool": {
    object (ConnectorTool)
  },
  "dataStoreTool": {
    object (DataStoreTool)
  },
  "pythonFunction": {
    object (PythonFunction)
  },
  "mcpTool": {
    object (McpTool)
  },
  "fileSearchTool": {
    object (FileSearchTool)
  },
  "systemTool": {
    object (SystemTool)
  },
  "agentTool": {
    object (AgentTool)
  },
  "widgetTool": {
    object (WidgetTool)
  },
  "remoteAgentTool": {
    object (RemoteAgentTool)
  }
  // End of list of possible types for union field tool_type.
}
Campi
name

string

Identificatore. Il nome della risorsa dello strumento. Formato:

  • projects/{project}/locations/{location}/apps/{app}/tools/{tool} per gli strumenti autonomi.
  • projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool} per gli strumenti recuperati da un set di strumenti.

Questi strumenti sono dinamici e solo di output; non è possibile farvi riferimento direttamente dove è previsto uno strumento.
displayName

string

Solo output. Il nome visualizzato dello strumento, derivato in base al tipo di strumento. Ad esempio, il nome visualizzato di una [ClientFunction][Tool.ClientFunction] deriva dalla sua proprietà name.
executionType

enum (ExecutionType)

Facoltativo. Il tipo di esecuzione dello strumento.
timeout

string (Duration format)

Facoltativo. Il timeout per l'esecuzione dello strumento. Se non viene impostato, il timeout predefinito è di 30 secondi per gli strumenti SYNCHRONOUS e di 60 secondi per gli strumenti ASYNCHRONOUS.

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

string (Timestamp format)

Solo output. Timestamp della creazione dello strumento.

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

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

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

string

Solo output. Se lo strumento è generato dall'assistente LLM, questo campo contiene un riepilogo descrittivo della generazione.
toolFakeConfig

object (ToolFakeConfig)

Facoltativo. Configurazione del comportamento dello strumento in modalità fittizia.
readOnly

boolean

Solo output. Indica se lo strumento è di sola lettura. Se impostato su true, lo strumento non può essere modificato dall'utente.
Campo unione tool_type. Il tipo di strumento. tool_type può essere solo uno dei seguenti tipi:
clientFunction

object (ClientFunction)

Facoltativo. La funzione client.
openApiTool

object (OpenApiTool)

Facoltativo. Lo strumento OpenAPI.
googleSearchTool

object (GoogleSearchTool)

Facoltativo. Lo strumento della Ricerca Google.
connectorTool

object (ConnectorTool)

Facoltativo. Lo strumento Integration Connector.
dataStoreTool

object (DataStoreTool)

Facoltativo. Lo strumento datastore.
pythonFunction

object (PythonFunction)

Facoltativo. Lo strumento per le funzioni Python.
mcpTool

object (McpTool)

Facoltativo. Lo strumento MCP. Uno strumento MCP non può essere creato o aggiornato direttamente e viene gestito dal set di strumenti MCP.
fileSearchTool

object (FileSearchTool)

Facoltativo. Lo strumento Ricerca file.
systemTool

object (SystemTool)

Facoltativo. Lo strumento di sistema.
agentTool

object (AgentTool)

Facoltativo. Lo strumento dell'agente.
widgetTool

object (WidgetTool)

Facoltativo. Lo strumento widget.
remoteAgentTool

object (RemoteAgentTool)

Facoltativo. Lo strumento dell'agente remoto.

ClientFunction

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

string

Obbligatorio. Il nome della funzione.
description

string

Facoltativo. La descrizione della funzione.
parameters

object (Schema)

Facoltativo. Lo schema dei parametri della funzione.
response

object (Schema)

Facoltativo. Lo schema della risposta della funzione.

OpenApiTool

Rappresentazione JSON 
{
  "openApiSchema": string,
  "name": string,
  "description": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
Campi
openApiSchema

string

Obbligatorio. Lo schema OpenAPI in formato JSON o YAML.
name

string

Facoltativo. Il nome dello strumento. Se non viene fornito, il nome dello strumento verrà derivato dallo schema OpenAPI, da operation.operationId.
description

string

Facoltativo. La descrizione dello strumento. Se non viene fornita, la descrizione dello strumento verrà derivata dallo schema OpenAPI, da operation.description o operation.summary.
apiAuthentication

object (ApiAuthentication)

Facoltativo. Informazioni di autenticazione richieste dall'API.
tlsConfig

object (TlsConfig)

Facoltativo. La configurazione TLS. Include i certificati del server personalizzati che il client considererà attendibili.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Facoltativo. Configurazione di Service Directory.
ignoreUnknownFields

boolean

Facoltativo. Se il valore è true, l'agente ignorerà i campi sconosciuti nella risposta dell'API.
url

string

Facoltativo. L'URL del server dello schema dell'API Open. Questo campo viene impostato solo negli strumenti delle dipendenze dell'ambiente durante il processo di esportazione se lo schema contiene un URL del server. Durante il processo di importazione, se questo URL è presente nelle dipendenze dell'ambiente e lo schema contiene il segnaposto $env_var, quest'ultimo verrà sostituito nello schema.

TlsConfig

Rappresentazione JSON 
{
  "caCerts": [
    {
      object (CaCert)
    }
  ]
}
Campi
caCerts[]

object (CaCert)

Obbligatorio. Specifica un elenco di certificati CA personalizzati consentiti per la verifica HTTPS.

CaCert

Rappresentazione JSON 
{
  "displayName": string,
  "cert": string
}
Campi
displayName

string

Obbligatorio. Il nome dei certificati CA personalizzati consentiti. Può essere utilizzato per evitare ambiguità tra i certificati CA personalizzati.
cert

string (bytes format)

Obbligatorio. I certificati CA personalizzati consentiti (in formato DER) per la verifica HTTPS. In questo modo viene eseguito l'override dell'archivio di attendibilità SSL predefinito. Se questo campo è vuoto o non specificato, CES utilizzerà l'archivio di attendibilità predefinito di Google per verificare i certificati. N.B. Assicurati che i certificati del server HTTPS siano firmati con "subject alt name". Ad esempio, un certificato può essere autofirmato utilizzando il seguente comando:

   openssl x509 -req -days 200 -in example.com.csr \
     -signkey example.com.key \
     -out example.com.crt \
     -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

Una stringa con codifica in base64.

ServiceDirectoryConfig

Rappresentazione JSON 
{
  "service": string
}
Campi
service

string

Obbligatorio. Il nome del servizio Service Directory. Formato: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. La località di Service Directory deve essere la stessa dell'app.

GoogleSearchTool

Rappresentazione JSON 
{
  "name": string,
  "description": string,
  "contextUrls": [
    string
  ],
  "preferredDomains": [
    string
  ],
  "excludeDomains": [
    string
  ],
  "promptConfig": {
    object (PromptConfig)
  }
}
Campi
name

string

Obbligatorio. Il nome dello strumento.
description

string

Facoltativo. Descrizione dello scopo dello strumento.
contextUrls[]

string

Facoltativo. I contenuti verranno recuperati direttamente da questi URL per il contesto e il grounding. Esempio: "https://example.com/path.html". Sono consentiti massimo 20 URL.
preferredDomains[]

string

Facoltativo. Specifica i domini a cui limitare i risultati di ricerca. Esempio: "example.com", "another.site". È possibile specificare un massimo di 20 domini.
excludeDomains[]

string

Facoltativo. Elenco di domini da escludere dai risultati di ricerca. Esempio: "example.com". È possibile escludere un massimo di 2000 domini.
promptConfig

object (PromptConfig)

Facoltativo. Istruzioni del prompt trasmesse al planner su come elaborare i risultati di ricerca per testo e voce.

PromptConfig

Rappresentazione JSON 
{
  "textPrompt": string,
  "voicePrompt": string
}
Campi
textPrompt

string

Facoltativo. Definisce il prompt utilizzato per le istruzioni di sistema durante l'interazione con l'agente nelle conversazioni in chat. Se non impostato, verrà utilizzato il prompt predefinito.
voicePrompt

string

Facoltativo. Definisce il prompt utilizzato per le istruzioni di sistema durante l'interazione con l'agente nelle conversazioni vocali. Se non impostato, verrà utilizzato il prompt predefinito.

ConnectorTool

Rappresentazione JSON 
{
  "connection": string,
  "action": {
    object (Action)
  },
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "name": string,
  "description": string
}
Campi
connection

string

Obbligatorio. Il nome completo della risorsa della connessione Integration Connectors a cui viene fatto riferimento. Formato: projects/{project}/locations/{location}/connections/{connection}
action

object (Action)

Obbligatorio. Azione che lo strumento deve utilizzare.
authConfig

object (EndUserAuthConfig)

Facoltativo. Configura il modo in cui viene gestita l'autenticazione in Integration Connectors. Per impostazione predefinita, nelle richieste API di Integration Connectors viene passata un'autenticazione amministratore. Puoi eseguirne l'override con una configurazione di autenticazione dell'utente finale diversa. Nota: per specificare una configurazione EUC qui, la connessione deve avere l'override dell'autenticazione abilitato, altrimenti la creazione di ConnectorTool non andrà a buon fine. Per maggiori dettagli, consulta https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override.
name

string

Facoltativo. Il nome dello strumento che può essere utilizzato dall'agente per decidere se chiamare questo ConnectorTool.
description

string

Facoltativo. La descrizione dello strumento che può essere utilizzato dall'agente per decidere se chiamare questo ConnectorTool.

Azione

Rappresentazione JSON 
{
  "inputFields": [
    string
  ],
  "outputFields": [
    string
  ],

  // Union field action_spec can be only one of the following:
  "connectionActionId": string,
  "entityOperation": {
    object (EntityOperation)
  }
  // End of list of possible types for union field action_spec.
}
Campi
inputFields[]

string

Facoltativo. Campi dell'entità da utilizzare come input per l'operazione. Se non vengono specificati campi, verranno utilizzati tutti i campi dell'entità.
outputFields[]

string

Facoltativo. Campi dell'entità da restituire dall'operazione. Se non vengono specificati campi, verranno restituiti tutti i campi dell'entità.
Campo unione action_spec. Specifica di un'azione da configurare per lo strumento da utilizzare. action_spec può essere solo uno dei seguenti tipi:
connectionActionId

string

ID di un'azione di connessione che lo strumento deve utilizzare.
entityOperation

object (EntityOperation)

Configurazione dell'operazione dell'entità che lo strumento deve utilizzare.

EntityOperation

Rappresentazione JSON 
{
  "entityId": string,
  "operation": enum (OperationType)
}
Campi
entityId

string

Obbligatorio. ID dell'entità.
operation

enum (OperationType)

Obbligatorio. Operazione da eseguire sull'entità.

EndUserAuthConfig

Rappresentazione JSON 
{

  // Union field auth_config can be only one of the following:
  "oauth2AuthCodeConfig": {
    object (Oauth2AuthCodeConfig)
  },
  "oauth2JwtBearerConfig": {
    object (Oauth2JwtBearerConfig)
  }
  // End of list of possible types for union field auth_config.
}
Campi
Campo unione auth_config. La configurazione di autenticazione. auth_config può essere solo uno dei seguenti tipi:
oauth2AuthCodeConfig

object (Oauth2AuthCodeConfig)

Autenticazione con codice di autorizzazione OAuth 2.0.
oauth2JwtBearerConfig

object (Oauth2JwtBearerConfig)

Autenticazione JWT Profile Oauth 2.0 Authorization Grant.

Oauth2AuthCodeConfig

Rappresentazione JSON 
{
  "oauthToken": string
}
Campi
oauthToken

string

Obbligatorio. Nome del parametro del token OAuth da passare. Deve essere nel formato $context.variables.<name_of_variable>.

Oauth2JwtBearerConfig

Rappresentazione JSON 
{
  "issuer": string,
  "subject": string,
  "clientKey": string
}
Campi
issuer

string

Obbligatorio. Nome del parameto dell'emittente da trasferire. Deve essere nel formato $context.variables.<name_of_variable>.
subject

string

Obbligatorio. Nome del parametro dell'oggetto da trasferire. Deve essere nel formato $context.variables.<name_of_variable>.
clientKey

string

Obbligatorio. Nome del parametro client da passare. Deve essere nel formato $context.variables.<name_of_variable>.

DataStoreTool

Rappresentazione JSON 
{
  "name": string,
  "description": string,
  "boostSpecs": [
    {
      object (BoostSpecs)
    }
  ],
  "modalityConfigs": [
    {
      object (ModalityConfig)
    }
  ],
  "filterParameterBehavior": enum (FilterParameterBehavior),

  // Union field search_source can be only one of the following:
  "dataStoreSource": {
    object (DataStoreSource)
  },
  "engineSource": {
    object (EngineSource)
  }
  // End of list of possible types for union field search_source.
}
Campi
name

string

Obbligatorio. Il nome dello strumento del datastore.
description

string

Facoltativo. La descrizione dello strumento.
boostSpecs[]

object (BoostSpecs)

Facoltativo. Specifica di boost per aumentare il ranking di determinati documenti.
modalityConfigs[]

object (ModalityConfig)

Facoltativo. Le configurazioni della modalità per il datastore.
filterParameterBehavior

enum (FilterParameterBehavior)

Facoltativo. Il comportamento del parametro di filtro.
Campo unione search_source. Definisce l'origine della ricerca, un singolo datastore o un motore. search_source può essere solo uno dei seguenti tipi:
dataStoreSource

object (DataStoreSource)

Facoltativo. Eseguire ricerche all'interno di un singolo datastore specifico.
engineSource

object (EngineSource)

Facoltativo. Esegui ricerche all'interno di un motore (potenzialmente in più datastore).

DataStoreSource

Rappresentazione JSON 
{
  "filter": string,
  "dataStore": {
    object (DataStore)
  }
}
Campi
filter

string

Facoltativo. Specifica del filtro per il datastore. Consulta: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
dataStore

object (DataStore)

Facoltativo. Il datastore.

DataStore

Rappresentazione JSON 
{
  "name": string,
  "type": enum (DataStoreType),
  "documentProcessingMode": enum (DocumentProcessingMode),
  "displayName": string,
  "createTime": string,
  "connectorConfig": {
    object (ConnectorConfig)
  }
}
Campi
name

string

Obbligatorio. Nome completo della risorsa del datastore. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
type

enum (DataStoreType)

Solo output. Il tipo di datastore. Questo campo è di sola lettura e viene compilato dal server.
documentProcessingMode

enum (DocumentProcessingMode)

Solo output. La modalità di elaborazione dei documenti per la connessione al datastore. Impostato solo per i datastore PUBLIC_WEB e UNSTRUCTURED.
displayName

string

Solo output. Il nome visualizzato del datastore.
createTime

string (Timestamp format)

Solo output. Timestamp di creazione del datastore.

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

object (ConnectorConfig)

Solo output. La configurazione del connettore per la connessione al datastore.

ConnectorConfig

Rappresentazione JSON 
{
  "collection": string,
  "collectionDisplayName": string,
  "dataSource": string
}
Campi
collection

string

Nome della risorsa della raccolta a cui appartiene il datastore.
collectionDisplayName

string

Nome visualizzato della raccolta a cui appartiene il datastore.
dataSource

string

Il nome dell'origine dati. Esempio: salesforce, jira, confluence, bigquery.

EngineSource

Rappresentazione JSON 
{
  "engine": string,
  "dataStoreSources": [
    {
      object (DataStoreSource)
    }
  ],
  "filter": string
}
Campi
engine

string

Obbligatorio. Nome completo della risorsa del motore. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
dataStoreSources[]

object (DataStoreSource)

Facoltativo. Utilizzalo per scegliere come target datastore specifici all'interno del motore. Se non viene specificato, la ricerca viene applicata a tutti i datastore associati all'engine.
filter

string

Facoltativo. Un filtro applicato alla ricerca nel motore. Non pertinente e non utilizzato se viene fornito "data_store_sources". Consulta: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

BoostSpecs

Rappresentazione JSON 
{
  "dataStores": [
    string
  ],
  "spec": [
    {
      object (BoostSpec)
    }
  ]
}
Campi
dataStores[]

string

Obbligatorio. Il datastore in cui viene applicata la configurazione di boosting. Nome completo della risorsa del datastore, ad esempio projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
spec[]

object (BoostSpec)

Obbligatorio. Un elenco di specifiche di boosting.

BoostSpec

Rappresentazione JSON 
{
  "conditionBoostSpecs": [
    {
      object (ConditionBoostSpec)
    }
  ]
}
Campi
conditionBoostSpecs[]

object (ConditionBoostSpec)

Obbligatorio. Un elenco di specifiche di boosting.

ConditionBoostSpec

Rappresentazione JSON 
{
  "condition": string,
  "boost": number,
  "boostControlSpec": {
    object (BoostControlSpec)
  }
}
Campi
condition

string

Obbligatorio. Un'espressione che specifica una condizione di boost. La sintassi è la stessa della sintassi delle espressioni di filtro. Al momento, l'unica condizione supportata è un elenco di codici lingua BCP-47. Esempio: per aumentare i suggerimenti nelle lingue en o fr: (lang_code: ANY("en", "fr"))
boost

number

Facoltativo. Intensità del boosting, che deve essere compresa tra -1 e 1. Un boosting negativo indica una retrocessione. Il valore predefinito è 0.0.

Se viene impostato su 1.0, i suggerimenti vengono promossi maggiormente. Tuttavia, non significa necessariamente che il risultato in cima alla prima pagina sarà un suggerimento con boosting.

Se viene impostato su -1.0, i suggerimenti vengono retrocessi in modo significativo. Tuttavia, potrebbero comunque essere mostrati altri suggerimenti pertinenti.

Se l'impostazione è 0.0, non viene applicato alcun boosting. La condizione di boosting viene ignorata.
boostControlSpec

object (BoostControlSpec)

Facoltativo. Specifica complessa per il ranking personalizzato in base al valore dell'attributo definito dal cliente.

BoostControlSpec

Rappresentazione JSON 
{
  "fieldName": string,
  "attributeType": enum (AttributeType),
  "interpolationType": enum (InterpolationType),
  "controlPoints": [
    {
      object (ControlPoint)
    }
  ]
}
Campi
fieldName

string

Facoltativo. Il nome del campo il cui valore verrà utilizzato per determinare l'importo del boost.
attributeType

enum (AttributeType)

Facoltativo. Il tipo di attributo da utilizzare per determinare l'importo del boost. Il valore dell'attributo può essere derivato dal valore del campo field_name specificato. Nel caso di valori numerici, è semplice, ovvero attribute_value = numerical_field_value. Tuttavia, nel caso della novità, attribute_value = (time.now() - datetime_field_value).
interpolationType

enum (InterpolationType)

Facoltativo. Il tipo di interpolazione da applicare per collegare i punti di controllo elencati di seguito.
controlPoints[]

object (ControlPoint)

Facoltativo. I punti di controllo utilizzati per definire la curva. La funzione monotona (definita tramite interpolation_type sopra) passa attraverso i punti di controllo elencati qui.

ControlPoint

Rappresentazione JSON 
{
  "attributeValue": string,
  "boostAmount": number
}
Campi
attributeValue

string

Facoltativo. Può essere uno dei seguenti: 1. Il valore numerico del campo. 2. La specifica della durata per la novità: il valore deve essere formattato come valore XSD dayTimeDuration (un sottoinsieme limitato di un valore di durata ISO 8601). Il pattern è: [nD][T[nH][nM][nS]].
boostAmount

number

Facoltativo. Il valore compreso tra -1 e 1 per aumentare il punteggio se attribute_value restituisce il valore specificato sopra.

ModalityConfig

Rappresentazione JSON 
{
  "modalityType": enum (ModalityType),
  "rewriterConfig": {
    object (RewriterConfig)
  },
  "summarizationConfig": {
    object (SummarizationConfig)
  },
  "groundingConfig": {
    object (GroundingConfig)
  },
  "snippetsConfig": {
    object (SnippetsConfig)
  }
}
Campi
modalityType

enum (ModalityType)

Obbligatorio. Il tipo di modalità.
rewriterConfig

object (RewriterConfig)

Facoltativo. La configurazione del rewriter.
summarizationConfig

object (SummarizationConfig)

Facoltativo. La configurazione del riassunto.
groundingConfig

object (GroundingConfig)

Facoltativo. La configurazione del grounding.
snippetsConfig

object (SnippetsConfig)

Facoltativo. La configurazione degli snippet.

RewriterConfig

Rappresentazione JSON 
{
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "disabled": boolean
}
Campi
modelSettings

object (ModelSettings)

Obbligatorio. Configurazioni per il modello LLM.
prompt

string

Facoltativo. La definizione del prompt. Se non impostato, verrà utilizzato il prompt predefinito.
disabled

boolean

Facoltativo. Indica se il rewriter è disabilitato.

SummarizationConfig

Rappresentazione JSON 
{
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "disabled": boolean
}
Campi
modelSettings

object (ModelSettings)

Facoltativo. Configurazioni per il modello LLM.
prompt

string

Facoltativo. La definizione del prompt. Se non impostato, verrà utilizzato il prompt predefinito.
disabled

boolean

Facoltativo. Indica se il riepilogo è disattivato.

GroundingConfig

Rappresentazione JSON 
{
  "groundingLevel": number,
  "disabled": boolean
}
Campi
groundingLevel

number

Facoltativo. La soglia di fondatezza della risposta in base alle fonti recuperate. Il valore ha un intervallo configurabile di [1, 5]. Il livello viene utilizzato per impostare la soglia di fondatezza della risposta, il che significa che tutte le risposte con un punteggio di fondatezza inferiore alla soglia verranno sostituite dalla restituzione di snippet pertinenti.

Ad esempio, un livello pari a 3 significa che il punteggio di radicamento deve essere pari o superiore a 3 affinché la risposta venga restituita.
disabled

boolean

Facoltativo. Indica se il grounding è disattivato.

SnippetsConfig

Rappresentazione JSON 
{
  "enableSnippets": boolean,
  "maxSnippets": integer
}
Campi
enableSnippets

boolean

Facoltativo. Se gli snippet sono abilitati.
maxSnippets

integer

Facoltativo. Numero di snippet da restituire per query. Se non viene impostato, per impostazione predefinita vengono restituiti tutti gli snippet del servizio.

PythonFunction

Rappresentazione JSON 
{
  "name": string,
  "pythonCode": string,
  "description": string,
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  }
}
Campi
name

string

Facoltativo. Il nome della funzione Python da eseguire. Deve corrispondere a un nome di funzione Python definito nel codice Python. Sensibile alle maiuscole. Se il nome non viene fornito, verrà utilizzata la prima funzione definita nel codice Python.
pythonCode

string

Facoltativo. Il codice Python da eseguire per lo strumento.
description

string

Solo output. La descrizione della funzione Python, analizzata dalla docstring del codice Python.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Facoltativo. Configurazione di Service Directory per lo strumento.

McpTool

Rappresentazione JSON 
{
  "name": string,
  "nameOverride": string,
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  },
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "state": enum (State)
}
Campi
name

string

Obbligatorio. Il nome dello strumento MCP.
nameOverride

string

Facoltativo. L'override del nome dello strumento MCP. Questo campo viene compilato se il nome è stato sostituito da un override del set di strumenti.
description

string

Facoltativo. La descrizione dello strumento MCP.
inputSchema

object (Schema)

Facoltativo. Lo schema degli argomenti di input dello strumento MCP.
outputSchema

object (Schema)

Facoltativo. Lo schema degli argomenti di output dello strumento MCP.
serverAddress

string

Obbligatorio. L'indirizzo del server MCP, ad esempio "https://example.com/mcp/". Se il server è creato con l'SDK MCP, l'URL deve avere il suffisso "/mcp/". Sono supportati solo i server basati sul trasporto Streamable HTTP. Questo è lo stesso di server_address in McpToolset. Per maggiori dettagli, consulta https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.
apiAuthentication

object (ApiAuthentication)

Facoltativo. Informazioni di autenticazione necessarie per eseguire lo strumento sul server MCP. Per l'autenticazione con token di connessione, il token si applica solo all'esecuzione dello strumento, non alla visualizzazione degli strumenti. Ciò richiede che gli strumenti possano essere elencati senza autenticazione.
tlsConfig

object (TlsConfig)

Facoltativo. La configurazione TLS. Include i certificati del server personalizzati che il client deve considerare attendibili.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Facoltativo. Configurazione di Service Directory per VPC-SC, utilizzata per risolvere i nomi dei servizi all'interno di un perimetro.
customHeaders

map (key: string, value: string)

Facoltativo. Le intestazioni personalizzate da inviare nella richiesta al server MCP. I valori devono essere nel formato $context.variables.<name_of_variable> e possono essere impostati nelle variabili di sessione. Per maggiori dettagli, consulta https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.

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

enum (State)

Solo output. Lo stato di disponibilità dinamica dello strumento sul server esterno.

CustomHeadersEntry

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

string
value

string

FileSearchTool

Rappresentazione JSON 
{
  "corpusType": enum (CorpusType),
  "name": string,
  "description": string,
  "fileCorpus": string
}
Campi
corpusType

enum (CorpusType)

Facoltativo. Il tipo di corpus. Il valore predefinito è FULLY_MANAGED.
name

string

Obbligatorio. Il nome dello strumento.
description

string

Facoltativo. La descrizione dello strumento.
fileCorpus

string

Facoltativo. Il corpus in cui sono archiviati i file. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

SystemTool

Rappresentazione JSON 
{
  "name": string,
  "description": string
}
Campi
name

string

Obbligatorio. Il nome dello strumento di sistema.
description

string

Solo output. La descrizione dello strumento di sistema.

AgentTool

Rappresentazione JSON 
{
  "name": string,
  "description": string,
  "agent": string
}
Campi
name

string

Obbligatorio. Il nome dello strumento dell'agente.
description

string

Facoltativo. Descrizione dello scopo dello strumento.
agent

string

Facoltativo. Il nome della risorsa dell'agente che funge da punto di accesso dello strumento. Formato: projects/{project}/locations/{location}/agents/{agent}

WidgetTool

Rappresentazione JSON 
{
  "name": string,
  "description": string,
  "widgetType": enum (WidgetType),
  "uiConfig": {
    object
  },
  "dataMapping": {
    object (DataMapping)
  },
  "textResponseConfig": {
    object (TextResponseConfig)
  },

  // Union field input can be only one of the following:
  "parameters": {
    object (Schema)
  }
  // End of list of possible types for union field input.
}
Campi
name

string

Obbligatorio. Il nome visualizzato dello strumento widget.
description

string

Facoltativo. La descrizione dello strumento widget.
widgetType

enum (WidgetType)

Facoltativo. Il tipo di strumento widget. Se non specificato, il tipo predefinito sarà CUSTOMIZED.
uiConfig

object (Struct format)

Facoltativo. Configurazione per il rendering del widget.
dataMapping

object (DataMapping)

Facoltativo. La mappatura che definisce il modo in cui i dati di uno strumento di origine vengono mappati ai parametri di input del widget.
textResponseConfig

object (TextResponseConfig)

Facoltativo. Configurazione per le risposte di testo sempre incluse.
Campo unione input. L'input dello strumento widget. input può essere solo uno dei seguenti tipi:
parameters

object (Schema)

Facoltativo. I parametri di input dello strumento widget.

DataMapping

Rappresentazione JSON 
{
  "sourceToolName": string,
  "fieldMappings": {
    string: string,
    ...
  },
  "pythonFunction": {
    object (PythonFunction)
  },
  "mode": enum (Mode),
  "pythonScript": string
}
Campi
sourceToolName

string

Facoltativo. Il nome della risorsa dello strumento che fornisce i dati per il widget (ad es. uno strumento di ricerca o una funzione personalizzata). Formato: projects/{project}/locations/{location}/agents/{agent}/tools/{tool}
fieldMappings

map (key: string, value: string)

Facoltativo. Una mappa dei campi dei parametri di input del widget ai campi di output corrispondenti dello strumento di origine.

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

object (PythonFunction)

Facoltativo. Configurazione di una funzione Python utilizzata per trasformare l'output dello strumento di origine nel formato di input del widget.
mode

enum (Mode)

Facoltativo. La modalità di mappatura dei dati.
pythonScript
(deprecated)

string

Ritirato: utilizza invece python_function.

FieldMappingsEntry

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

string
value

string

TextResponseConfig

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

enum (Type)

Facoltativo. La strategia per fornire la risposta di testo.
staticText

string

Facoltativo. La risposta di testo statico da restituire quando il tipo è STATIC.
textResponseInstruction

string

Facoltativo. Istruzione per l'LLM su come generare la risposta di testo. Utilizzato come descrizione per il parametro di risposta di testo se il tipo è LLM_GENERATED.

RemoteAgentTool

Rappresentazione JSON 
{
  "name": string,
  "description": string,
  "agentCard": {
    object (AgentCard)
  },
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "statefulAgent": boolean,
  "inputVariableMapping": {
    string: string,
    ...
  },
  "outputVariableMapping": {
    string: string,
    ...
  }
}
Campi
name

string

Obbligatorio. Il nome dello strumento.
description

string

Obbligatorio. La descrizione dello strumento.
agentCard

object (AgentCard)

Obbligatorio. La scheda dell'agente remoto richiamato da questo strumento.
apiAuthentication

object (ApiAuthentication)

Facoltativo. Configurazione dell'autenticazione per la chiamata dell'agente remoto.
statefulAgent

boolean

Facoltativo. Se abilitata, l'interazione tra l'app CXAS e l'agente remoto condividerà lo stesso contesto. Se l'agente remoto restituisce un context_id, questo verrà mantenuto per l'intera sessione per questo strumento dell'agente remoto.
inputVariableMapping

map (key: string, value: string)

Facoltativo. Mappatura dei nomi delle variabili di input dell'agente remoto ai nomi delle variabili GECX.

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

map (key: string, value: string)

Facoltativo. Mappatura dei nomi delle variabili di output dell'agente remoto ai nomi delle variabili GECX.

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

InputVariableMappingEntry

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

string
value

string

OutputVariableMappingEntry

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

string
value

string

ToolFakeConfig

Rappresentazione JSON 
{
  "enableFakeMode": boolean,

  // Union field tool_response can be only one of the following:
  "codeBlock": {
    object (CodeBlock)
  }
  // End of list of possible types for union field tool_response.
}
Campi
enableFakeMode

boolean

Facoltativo. Indica se lo strumento utilizza la modalità fittizia.
Campo unione tool_response. La risposta è statica o viene fornita da una funzione Python. tool_response può essere solo uno dei seguenti tipi:
codeBlock

object (CodeBlock)

Facoltativo. Blocco di codice che verrà eseguito al posto di una chiamata allo strumento reale.

CodeBlock

Rappresentazione JSON 
{
  "pythonCode": string
}
Campi
pythonCode

string

Obbligatorio. Codice Python che verrà richiamato in modalità fittizia dello strumento. Firma della funzione Python prevista - Per intercettare tutte le chiamate allo strumento: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Per intercettare una chiamata allo strumento specifica: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Se la funzione restituisce None, verrà richiamato lo strumento reale.

Esempio

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "entryAgent": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "invalid": boolean,
  "etag": string
}
Campi
name

string

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

string

Obbligatorio. Nome visualizzato dell'esempio.
description

string

Facoltativo. Descrizione leggibile dell'esempio.
entryAgent

string

Facoltativo. L'agente che gestisce inizialmente la conversazione. Se non specificato, l'esempio rappresenta una conversazione gestita dall'agente principale. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
messages[]

object (Message)

Facoltativo. La raccolta di messaggi che compongono la conversazione.
createTime

string (Timestamp format)

Solo output. Timestamp della creazione dell'esempio.

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

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

boolean

Solo output. L'esempio potrebbe non essere più valido se le risorse di riferimento vengono eliminate. Gli esempi non validi non verranno utilizzati come esempi few-shot.
etag

string

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.

Messaggio

Rappresentazione JSON 
{
  "role": string,
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "eventTime": string
}
Campi
role

string

Facoltativo. Il ruolo all'interno della conversazione, ad esempio utente, agente.
chunks[]

object (Chunk)

Facoltativo. Contenuto del messaggio sotto forma di serie di blocchi.
eventTime

string (Timestamp format)

Facoltativo. Timestamp di invio o ricezione del messaggio. Non deve essere utilizzato se il messaggio fa parte di un example.

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

Chunk

Rappresentazione JSON 
{

  // Union field data can be only one of the following:
  "text": string,
  "transcript": string,
  "blob": {
    object (Blob)
  },
  "payload": {
    object
  },
  "image": {
    object (Image)
  },
  "toolCall": {
    object (ToolCall)
  },
  "toolResponse": {
    object (ToolResponse)
  },
  "agentTransfer": {
    object (AgentTransfer)
  },
  "updatedVariables": {
    object
  },
  "defaultVariables": {
    object
  }
  // End of list of possible types for union field data.
}
Campi
Campo unione data. Dati in blocchi. data può essere solo uno dei seguenti tipi:
text

string

Facoltativo. Dati di testo.
transcript

string

Facoltativo. Trascrizione associata all'audio.
blob

object (Blob)

Facoltativo. Dati blob.
payload

object (Struct format)

Facoltativo. Dati di payload personalizzati.
image

object (Image)

Facoltativo. Dati immagine.
toolCall

object (ToolCall)

Facoltativo. Richiesta di esecuzione dello strumento.
toolResponse

object (ToolResponse)

Facoltativo. Risposta dell'esecuzione dello strumento.
agentTransfer

object (AgentTransfer)

Facoltativo. Evento di trasferimento dell'agente.
updatedVariables

object (Struct format)

Uno struct rappresenta le variabili aggiornate nella conversazione, con i nomi delle variabili come chiavi.
defaultVariables

object (Struct format)

Una struttura rappresenta le variabili predefinite all'inizio della conversazione, con i nomi delle variabili come chiavi.

Blob

Rappresentazione JSON 
{
  "mimeType": string,
  "data": string
}
Campi
mimeType

string

Obbligatorio. Il tipo MIME standard IANA dei dati di origine.
data

string (bytes format)

Obbligatorio. Byte non elaborati del blob.

Una stringa con codifica in base64.

Immagine

Rappresentazione JSON 
{
  "mimeType": string,
  "data": string,
  "altText": string
}
Campi
mimeType

string

Obbligatorio. Il tipo MIME standard IANA dei dati di origine. I tipi di immagini supportati includono: * image/png * image/jpeg * image/webp
data

string (bytes format)

Obbligatorio. Byte non elaborati dell'immagine.

Una stringa con codifica in base64.
altText

string

Facoltativo. Il testo alternativo dell'immagine.

ToolCall

Rappresentazione JSON 
{
  "id": string,
  "displayName": string,
  "args": {
    object
  },
  "parentToolCallId": string,
  "agentName": string,
  "targetApp": string,

  // Union field tool_identifier can be only one of the following:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of list of possible types for union field tool_identifier.
}
Campi
id

string

Facoltativo. L'identificatore univoco della chiamata allo strumento. Se compilato, il client deve restituire il risultato dell'esecuzione con l'ID corrispondenza in ToolResponse.
displayName

string

Solo output. Nome visualizzato dello strumento.
args

object (Struct format)

Facoltativo. I parametri e i valori di input per lo strumento in formato oggetto JSON.
parentToolCallId

string

Solo output. L'ID della chiamata allo strumento che ha causato questa chiamata, quando è stata emessa da un sub-agente che lavora per conto di una chiamata principale. Vuoto per le chiamate di primo livello. Consente a un client di raggruppare il lavoro di un sub-agente sotto la chiamata che lo ha avviato, anziché visualizzare ogni passaggio come elemento di pari livello.
agentName

string

Solo output. Nome leggibile dell'agente che ha emesso questa chiamata, ad esempio "Contract Architect". Vuoto quando è stato emesso dall'agente principale.
targetApp

string

Solo output. L'app a cui è destinata questa chiamata, derivata dall'assistente dagli argomenti della risorsa della chiamata: un nome della risorsa dell'app, PROJECT per gli strumenti con ambito di località o vuoto per gli strumenti locali della sessione. Impostato solo nelle sessioni dell'assistente con ambito di progetto.
Campo unione tool_identifier. L'identificatore dello strumento da eseguire. Potrebbe essere uno strumento persistente o uno strumento di un set di strumenti. tool_identifier può essere solo uno dei seguenti tipi:
tool

string

Facoltativo. Il nome dello strumento da eseguire. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

Facoltativo. Lo strumento del set di strumenti da eseguire.

ToolsetTool

Rappresentazione JSON 
{
  "toolset": string,
  "toolId": string
}
Campi
toolset

string

Obbligatorio. Il nome della risorsa del set di strumenti da cui deriva questo strumento. Formato: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
toolId

string

Facoltativo. L'ID dello strumento per filtrare gli strumenti per cui recuperare lo schema.

ToolResponse

Rappresentazione JSON 
{
  "id": string,
  "displayName": string,
  "response": {
    object
  },
  "parentToolCallId": string,
  "agentName": string,
  "targetApp": string,

  // Union field tool_identifier can be only one of the following:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of list of possible types for union field tool_identifier.
}
Campi
id

string

Facoltativo. L'ID corrispondenza della tool call a cui si riferisce la risposta.
displayName

string

Solo output. Nome visualizzato dello strumento.
response

object (Struct format)

Obbligatorio. Il risultato dell'esecuzione dello strumento in formato oggetto JSON. Utilizza la chiave "output" per specificare la risposta dello strumento e la chiave "error" per specificare i dettagli dell'errore (se presenti). Se le chiavi "output" ed "error" non sono specificate, l'intera "response" viene trattata come risultato dell'esecuzione dello strumento.
parentToolCallId

string

Solo output. L'ID della chiamata allo strumento che ha causato questa chiamata, quando è stata emessa da un sub-agente che lavora per conto di una chiamata principale. Vuoto per le chiamate di primo livello. Consente a un client di raggruppare il lavoro di un sub-agente sotto la chiamata che lo ha avviato, anziché visualizzare ogni passaggio come elemento di pari livello.
agentName

string

Solo output. Nome leggibile dell'agente che ha emesso questa chiamata, ad esempio "Contract Architect". Vuoto quando è stato emesso dall'agente principale.
targetApp

string

Solo output. L'app scelta come target dallo strumento eseguito; rispecchia ToolCall.target_app.
Campo unione tool_identifier. L'identificatore dello strumento eseguito. Potrebbe essere uno strumento persistente o uno strumento di un set di strumenti. tool_identifier può essere solo uno dei seguenti tipi:
tool

string

Facoltativo. Il nome dello strumento da eseguire. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

Facoltativo. Lo strumento del set di strumenti che è stato eseguito.

AgentTransfer

Rappresentazione JSON 
{
  "targetAgent": string,
  "displayName": string
}
Campi
targetAgent

string

Obbligatorio. L'agente a cui viene trasferita la conversazione. L'agente gestirà la conversazione da questo momento in poi. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
displayName

string

Solo output. Nome visualizzato dell'agente.

Guardrail

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "enabled": boolean,
  "action": {
    object (TriggerAction)
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,

  // Union field guardrail_type can be only one of the following:
  "contentFilter": {
    object (ContentFilter)
  },
  "llmPromptSecurity": {
    object (LlmPromptSecurity)
  },
  "llmPolicy": {
    object (LlmPolicy)
  },
  "modelSafety": {
    object (ModelSafety)
  },
  "codeCallback": {
    object (CodeCallback)
  },
  "supervisor": {
    object (Supervisor)
  }
  // End of list of possible types for union field guardrail_type.
}
Campi
name

string

Identificatore. L'identificatore univoco della regola di sicurezza. Formato: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
displayName

string

Obbligatorio. Nome visualizzato del guardrail.
description

string

Facoltativo. Descrizione della guardrail.
enabled

boolean

Facoltativo. Indica se il guardrail è abilitato.
action

object (TriggerAction)

Facoltativo. Azione da intraprendere quando viene attivato il guardrail.
createTime

string (Timestamp format)

Solo output. Timestamp della creazione della regola di protezione.

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 della regola di protezione.

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

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.
Campo unione guardrail_type. Tipo di guardrail. guardrail_type può essere solo uno dei seguenti tipi:
contentFilter

object (ContentFilter)

Facoltativo. Guardrail che vieta l'utilizzo di determinati contenuti nella conversazione.
llmPromptSecurity

object (LlmPromptSecurity)

Facoltativo. Guardrail che blocca la conversazione se il prompt è considerato non sicuro in base alla classificazione dell'LLM.
llmPolicy

object (LlmPolicy)

Facoltativo. Guardrail che blocca la conversazione se la risposta dell'LLM è considerata in violazione della policy in base alla classificazione dell'LLM.
modelSafety

object (ModelSafety)

Facoltativo. Guardrail che blocca la conversazione se la risposta dell'LLM è considerata non sicura in base alle impostazioni di sicurezza del modello.
codeCallback

object (CodeCallback)

Facoltativo. Guardrail che blocca potenzialmente la conversazione in base al risultato dell'esecuzione del callback.
supervisor

object (Supervisor)

Facoltativo. Guardrail che esegue l'intervento del supervisore.

ContentFilter

Rappresentazione JSON 
{
  "bannedContents": [
    string
  ],
  "bannedContentsInUserInput": [
    string
  ],
  "bannedContentsInAgentResponse": [
    string
  ],
  "matchType": enum (MatchType),
  "disregardDiacritics": boolean,
  "sensitiveWordsExemptions": [
    string
  ]
}
Campi
bannedContents[]

string

Facoltativo. Elenco di frasi vietate. Si applica sia agli input degli utenti sia alle risposte degli agenti.
bannedContentsInUserInput[]

string

Facoltativo. Elenco di frasi vietate. Si applica solo agli input degli utenti.
bannedContentsInAgentResponse[]

string

Facoltativo. Elenco di frasi vietate. Si applica solo alle risposte degli agenti.
matchType

enum (MatchType)

Obbligatorio. Tipo di corrispondenza per il filtro dei contenuti.
disregardDiacritics

boolean

Facoltativo. Se impostato su true, i segni diacritici vengono ignorati durante la ricerca di corrispondenze.
sensitiveWordsExemptions[]

string

Facoltativo. Voci dell'elenco di parole sensibili consentite da questo guardrail. Valido solo quando match_type è SENSITIVE_WORDS. Ogni valore deve corrispondere a una voce dell'elenco (senza distinzione tra maiuscole e minuscole, gli spazi vuoti circostanti vengono ignorati); altri valori non hanno alcun effetto. Si applica solo a questa regola di sicurezza. Massimo 1000 voci di massimo 256 caratteri ciascuna.

LlmPromptSecurity

Rappresentazione JSON 
{
  "failOpen": boolean,

  // Union field security_config can be only one of the following:
  "defaultSettings": {
    object (DefaultSecuritySettings)
  },
  "customPolicy": {
    object (LlmPolicy)
  }
  // End of list of possible types for union field security_config.
}
Campi
failOpen

boolean

Facoltativo. Determina il comportamento quando la barriera di protezione rileva un errore LLM. - Se true: il guardrail viene ignorato. - Se il valore è false (predefinito): il guardrail si attiva/blocca.

Nota: se viene fornita una policy personalizzata, questo campo viene ignorato a favore della configurazione "fail_open" della policy.
Campo unione security_config. Definisce la modalità di configurazione della sicurezza. L'utente deve scegliere una delle seguenti configurazioni. security_config può essere solo uno dei seguenti tipi:
defaultSettings

object (DefaultSecuritySettings)

Facoltativo. Utilizza le impostazioni di sicurezza predefinite del sistema. Per selezionare questa modalità, includi un messaggio "default_settings" vuoto nella richiesta. Il campo "default_prompt_template" all'interno verrà compilato dal server nella risposta.
customPolicy

object (LlmPolicy)

Facoltativo. Utilizza un LlmPolicy definito dall'utente per configurare il guardrail di sicurezza.

DefaultSecuritySettings

Rappresentazione JSON 
{
  "defaultPromptTemplate": string
}
Campi
defaultPromptTemplate

string

Solo output. Il template di prompt predefinito utilizzato dal sistema. Questo campo serve per mostrare all'utente il prompt utilizzato dal sistema per impostazione predefinita. È OUTPUT_ONLY.

LlmPolicy

Rappresentazione JSON 
{
  "maxConversationMessages": integer,
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "policyScope": enum (PolicyScope),
  "failOpen": boolean,
  "allowShortUtterance": boolean
}
Campi
maxConversationMessages

integer

Facoltativo. Quando controlli questa policy, considera gli ultimi "n" messaggi della conversazione. Se non viene impostato, verrà utilizzato il valore predefinito 10.
modelSettings

object (ModelSettings)

Facoltativo. Impostazioni del modello.
prompt

string

Obbligatorio. Prompt delle norme. Supporta i segnaposto delle variabili di sessione ({var}) e {agent_system_instruction} per inserire le istruzioni di sistema risolte dell'agente.
policyScope

enum (PolicyScope)

Obbligatorio. Definisce quando applicare il controllo delle policy durante la conversazione. Se impostata su POLICY_SCOPE_UNSPECIFIED, la policy verrà applicata all'input utente. Quando applichi la policy alla risposta dell'agente, verrà introdotta una latenza aggiuntiva prima che l'agente possa rispondere.
failOpen

boolean

Facoltativo. Se si verifica un errore durante il controllo della policy, l'operazione non va a buon fine e il guardrail non viene attivato.
allowShortUtterance

boolean

Facoltativo. Per impostazione predefinita, il controllo delle policy LLM viene ignorato per gli enunciati brevi. Se attivi questa impostazione, il controllo delle policy viene applicato a tutti gli enunciati, inclusi quelli che normalmente verrebbero ignorati.

ModelSafety

Rappresentazione JSON 
{
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ]
}
Campi
safetySettings[]

object (SafetySetting)

Obbligatorio. Elenco delle impostazioni di sicurezza.

SafetySetting

Rappresentazione JSON 
{
  "category": enum (HarmCategory),
  "threshold": enum (HarmBlockThreshold)
}
Campi
category

enum (HarmCategory)

Obbligatorio. La categoria di danno.
threshold

enum (HarmBlockThreshold)

Obbligatorio. La soglia di blocco dei contenuti dannosi.

CodeCallback

Rappresentazione JSON 
{
  "beforeAgentCallback": {
    object (Callback)
  },
  "afterAgentCallback": {
    object (Callback)
  },
  "beforeModelCallback": {
    object (Callback)
  },
  "afterModelCallback": {
    object (Callback)
  }
}
Campi
beforeAgentCallback

object (Callback)

Facoltativo. Il callback da eseguire prima della chiamata dell'agente. Ogni funzione di callback deve restituire una struttura (ad es. un dict o un oggetto) contenente almeno: - "decision": "OK" o "TRIGGER". - "reason": una stringa che spiega la decisione. Una decisione "TRIGGER" potrebbe interrompere l'ulteriore elaborazione.
afterAgentCallback

object (Callback)

Facoltativo. Il callback da eseguire dopo la chiamata dell'agente. Ogni funzione di callback deve restituire una struttura (ad es. un dict o un oggetto) contenente almeno: - "decision": "OK" o "TRIGGER". - "reason": una stringa che spiega la decisione. Una decisione "TRIGGER" potrebbe interrompere l'ulteriore elaborazione.
beforeModelCallback

object (Callback)

Facoltativo. Il callback da eseguire prima della chiamata del modello. Se il modello viene chiamato più volte, il callback verrà eseguito più volte. Ogni funzione di callback deve restituire una struttura (ad es. un dict o un oggetto) contenente almeno: - "decision": "OK" o "TRIGGER". - "reason": una stringa che spiega la decisione. Una decisione "TRIGGER" potrebbe interrompere l'ulteriore elaborazione.
afterModelCallback

object (Callback)

Facoltativo. Il callback da eseguire dopo la chiamata del modello. Se il modello viene chiamato più volte, il callback verrà eseguito più volte. Ogni funzione di callback deve restituire una struttura (ad es. un dict o un oggetto) contenente almeno: - "decision": "OK" o "TRIGGER". - "reason": una stringa che spiega la decisione. Una decisione "TRIGGER" potrebbe interrompere l'ulteriore elaborazione.

Supervisore

Rappresentazione JSON 
{
  "type": enum (Type),
  "detectionMode": enum (DetectionMode)
}
Campi
type

enum (Type)

Facoltativo. Il tipo di supervisore.
detectionMode

enum (DetectionMode)

Facoltativo. La modalità di rilevamento del supervisore.

TriggerAction

Rappresentazione JSON 
{

  // Union field action can be only one of the following:
  "respondImmediately": {
    object (RespondImmediately)
  },
  "transferAgent": {
    object (TransferAgent)
  },
  "generativeAnswer": {
    object (GenerativeAnswer)
  }
  // End of list of possible types for union field action.
}
Campi
Campo unione action. L'azione da eseguire. action può essere solo uno dei seguenti tipi:
respondImmediately

object (RespondImmediately)

Facoltativo. Rispondi immediatamente con una risposta preconfigurata.
transferAgent

object (TransferAgent)

Facoltativo. Trasferire la conversazione a un altro agente.
generativeAnswer

object (GenerativeAnswer)

Facoltativo. Rispondi con una risposta generativa.

RespondImmediately

Rappresentazione JSON 
{
  "responses": [
    {
      object (Response)
    }
  ]
}
Campi
responses[]

object (Response)

Obbligatorio. Le risposte predefinite tra cui l'agente può scegliere. La risposta viene scelta in modo casuale.

Risposta

Rappresentazione JSON 
{
  "text": string,
  "disabled": boolean
}
Campi
text

string

Obbligatorio. Testo con cui l'agente deve rispondere.
disabled

boolean

Facoltativo. Indica se la risposta è disattivata. Le risposte disattivate non vengono utilizzate dall'agente.

TransferAgent

Rappresentazione JSON 
{
  "agent": string
}
Campi
agent

string

Obbligatorio. Il nome dell'agente a cui trasferire la conversazione. L'agente deve trovarsi nella stessa app dell'agente corrente. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

GenerativeAnswer

Rappresentazione JSON 
{
  "prompt": string
}
Campi
prompt

string

Obbligatorio. Il prompt da utilizzare per la risposta generativa.

Toolset

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "timeout": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "executionType": enum (ExecutionType),
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },

  // Union field toolset_type can be only one of the following:
  "mcpToolset": {
    object (McpToolset)
  },
  "openApiToolset": {
    object (OpenApiToolset)
  },
  "connectorToolset": {
    object (ConnectorToolset)
  }
  // End of list of possible types for union field toolset_type.
}
Campi
name

string

Identificatore. L'identificatore univoco del set di strumenti. Formato: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
displayName

string

Facoltativo. Il nome visualizzato del set di strumenti. Deve essere univoco all'interno della stessa app.
description

string

Facoltativo. La descrizione del set di strumenti.
timeout

string (Duration format)

Facoltativo. Il timeout per l'esecuzione del set di strumenti. Se non viene impostato, il timeout predefinito è di 30 secondi per i set di strumenti SYNCHRONOUS e di 60 secondi per i set di strumenti ASYNCHRONOUS.

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

string (Timestamp format)

Solo output. Timestamp della creazione del set di strumenti.

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 del set di strumenti.

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

ETag utilizzato per garantire che l'oggetto non sia stato modificato durante un'operazione di lettura, modifica e scrittura. Se l'etag è vuoto, l'aggiornamento sovrascriverà eventuali modifiche simultanee.
executionType

enum (ExecutionType)

Facoltativo. Il tipo di esecuzione degli strumenti nel set di strumenti.
toolFakeConfig

object (ToolFakeConfig)

Facoltativo. Configurazione del comportamento degli strumenti in modalità fittizia.
Campo unione toolset_type. Il tipo di set di strumenti. toolset_type può essere solo uno dei seguenti tipi:
mcpToolset

object (McpToolset)

Facoltativo. Un set di strumenti che contiene un elenco di strumenti offerti dal server MCP.
openApiToolset

object (OpenApiToolset)

Facoltativo. Un set di strumenti che contiene un elenco di strumenti definiti da uno schema OpenAPI.
connectorToolset

object (ConnectorToolset)

Facoltativo. Un set di strumenti che genera strumenti da una connessione Integration Connectors.

McpToolset

Rappresentazione JSON 
{
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "toolOverrides": [
    {
      object (McpToolOverride)
    }
  ]
}
Campi
serverAddress

string

Obbligatorio. L'indirizzo del server MCP, ad esempio "https://example.com/mcp/". Se il server è creato con l'SDK MCP, l'URL deve avere il suffisso "/mcp/". Sono supportati solo i server basati sul trasporto Streamable HTTP. Per maggiori dettagli, consulta https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.
apiAuthentication

object (ApiAuthentication)

Facoltativo. Informazioni di autenticazione necessarie per accedere agli strumenti ed eseguire uno strumento sul server MCP. Per l'autenticazione con token di connessione, il token si applica solo all'esecuzione dello strumento, non alla visualizzazione degli strumenti. Ciò richiede che gli strumenti possano essere elencati senza autenticazione.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Facoltativo. Configurazione di Service Directory per VPC-SC, utilizzata per risolvere i nomi dei servizi all'interno di un perimetro.
tlsConfig

object (TlsConfig)

Facoltativo. La configurazione TLS. Include i certificati del server personalizzati che il client deve considerare attendibili.
customHeaders

map (key: string, value: string)

Facoltativo. Le intestazioni personalizzate da inviare nella richiesta al server MCP. I valori devono essere nel formato $context.variables.<name_of_variable> e possono essere impostati nelle variabili di sessione. Per maggiori dettagli, consulta https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.

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

object (McpToolOverride)

Facoltativo. Override per i singoli strumenti all'interno di questo set di strumenti. In questo modo è possibile eseguire l'override di dettagli specifici come descrizioni, nomi o bloccare gli stati degli strumenti in modo che non siano completamente dinamici.

CustomHeadersEntry

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

string
value

string

McpToolOverride

Rappresentazione JSON 
{
  "tool": string,
  "nameOverride": string,
  "descriptionOverride": string,
  "snapshot": {
    object (McpToolDefinition)
  }
}
Campi
tool

string

Obbligatorio. Il nome originale dello strumento così come viene emesso dal server MCP.
nameOverride

string

Facoltativo. Se presente, questo strumento utilizza questo nome nell'agente anziché il nome originale. Viene utilizzato principalmente come alias se il server MCP offre strumenti con nomi poco chiari.
descriptionOverride

string

Facoltativo. Se presente, questo strumento utilizza questa descrizione anziché quella originale del server.
snapshot

object (McpToolDefinition)

Solo output. Se presente, questo strumento è "Bloccato" e utilizza i valori dello snapshot come fallback se il server diventa temporaneamente non disponibile o se non è presente alcun override.

McpToolDefinition

Rappresentazione JSON 
{
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  }
}
Campi
description

string

Solo output. La descrizione dello strumento MCP. Questo valore può essere sostituito da description_override in McpToolOverride.
inputSchema

object (Schema)

Solo output. Lo schema degli argomenti di input dello strumento MCP.
outputSchema

object (Schema)

Solo output. Lo schema degli argomenti di output dello strumento MCP.

OpenApiToolset

Rappresentazione JSON 
{
  "openApiSchema": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
Campi
openApiSchema

string

Obbligatorio. Lo schema OpenAPI del set di strumenti.
apiAuthentication

object (ApiAuthentication)

Facoltativo. Informazioni di autenticazione richieste dall'API.
tlsConfig

object (TlsConfig)

Facoltativo. La configurazione TLS. Include i certificati del server personalizzati
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Facoltativo. Configurazione di Service Directory.
ignoreUnknownFields

boolean

Facoltativo. Se il valore è true, l'agente ignorerà i campi sconosciuti nella risposta dell'API per tutte le operazioni definite nello schema OpenAPI.
url

string

Facoltativo. L'URL del server dello schema dell'API Open. Questo campo viene impostato solo nei set di strumenti nelle dipendenze dell'ambiente durante il processo di esportazione se lo schema contiene un URL del server. Durante il processo di importazione, se questo URL è presente nelle dipendenze dell'ambiente e lo schema contiene il segnaposto $env_var, quest'ultimo verrà sostituito nello schema.

ConnectorToolset

Rappresentazione JSON 
{
  "connection": string,
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "connectorActions": [
    {
      object (Action)
    }
  ]
}
Campi
connection

string

Obbligatorio. Il nome completo della risorsa della connessione Integration Connectors a cui viene fatto riferimento. Formato: projects/{project}/locations/{location}/connections/{connection}
authConfig

object (EndUserAuthConfig)

Facoltativo. Configura il modo in cui viene gestita l'autenticazione in Integration Connectors. Per impostazione predefinita, nelle richieste API di Integration Connectors viene passata un'autenticazione amministratore. Puoi eseguirne l'override con una configurazione di autenticazione dell'utente finale diversa. Nota: per specificare una configurazione EUC qui, la connessione deve avere l'override dell'autenticazione abilitato, altrimenti la creazione del set di strumenti non andrà a buon fine. Consulta: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
connectorActions[]

object (Action)

Obbligatorio. L'elenco delle azioni del connettore/operazioni sulle entità per cui generare gli strumenti.

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.

RequestLocation

La posizione della chiave API nella richiesta.

Enum
REQUEST_LOCATION_UNSPECIFIED Non specificato. Questo valore non deve essere utilizzato.
HEADER Rappresenta la chiave nell'intestazione HTTP.
QUERY_STRING Rappresenta la chiave nella stringa di query.

OauthGrantType

Tipi di autorizzazione con OAuth. È supportata solo la concessione delle credenziali client.

Enum
OAUTH_GRANT_TYPE_UNSPECIFIED Non specificato. Il valore predefinito è CLIENT_CREDENTIAL.
CLIENT_CREDENTIAL Rappresenta il flusso delle credenziali client.

Direzione

La direzione del trasferimento.

Enum
DIRECTION_UNSPECIFIED Direzione non specificata.
PARENT_TO_CHILD Trasferimento dall'agente parent all'agente child.
CHILD_TO_PARENT Trasferimento dall'agente child all'agente parent.

OperationType

L'operazione da eseguire sull'entità.

Enum
OPERATION_TYPE_UNSPECIFIED Tipo di operazione non specificato. Non valido. La creazione/l'aggiornamento di ConnectorTool non riuscirà.
LIST Operazione di elenco.
GET Operazione Get.
CREATE Crea operazione.
UPDATE Operazione di aggiornamento.
DELETE Elimina operazione.

DataStoreType

Il tipo di datastore.

Enum
DATA_STORE_TYPE_UNSPECIFIED Non specificato. Questo valore indica che il tipo di datastore non è specificato, pertanto non verrà utilizzato durante la ricerca.
PUBLIC_WEB Un datastore che contiene contenuti web pubblici.
UNSTRUCTURED Un datastore che contiene dati privati non strutturati.
FAQ Un datastore che contiene dati strutturati utilizzati come domande frequenti.
CONNECTOR Un datastore che funge da connettore a un servizio proprietario o di terze parti.

DocumentProcessingMode

La modalità di elaborazione dei documenti del datastore.

Enum
DOCUMENT_PROCESSING_MODE_UNSPECIFIED Non specificato.
DOCUMENTS I documenti vengono elaborati come documenti.
CHUNKS I documenti vengono convertiti in blocchi.

AttributeType

L'attributo (o la funzione) a cui applicare il ranking personalizzato.

Enum
ATTRIBUTE_TYPE_UNSPECIFIED AttributeType non specificato.
NUMERICAL Il valore del campo numerico verrà utilizzato per aggiornare dinamicamente l'importo del boost. In questo caso, il valore attribute_value (il valore x) del punto di controllo sarà il valore effettivo del campo numerico per cui è specificato boost_amount.
FRESHNESS Per il caso d'uso della novità, il valore dell'attributo sarà la durata tra l'ora corrente e la data nel campo data/ora specificato. Il valore deve essere formattato come valore XSD dayTimeDuration (un sottoinsieme limitato di un valore di durata ISO 8601). Il pattern è: [nD][T[nH][nM][nS]]. Ad esempio 5D, 3DT12H30M, T24H.

InterpolationType

Il tipo di interpolazione da applicare. L'impostazione predefinita sarà lineare (lineare a tratti).

Enum
INTERPOLATION_TYPE_UNSPECIFIED Il tipo di interpolazione non è specificato. In questo caso, il valore predefinito è Lineare.
LINEAR Verrà applicata l'interpolazione lineare piecewise.

ModalityType

Il tipo di modalità.

Enum
MODALITY_TYPE_UNSPECIFIED Tipo di modalità non specificato.
TEXT Modalità testo.
AUDIO Modalità audio.

FilterParameterBehavior

Comportamento del parametro di filtro.

Enum
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED Comportamento predefinito del filtro. Includi il parametro filtro di inclusione per i datastore del connettore. Per gli altri tipi di datastore, il parametro di input del filtro viene omesso.
ALWAYS_INCLUDE Includi sempre il filtro di inclusione per tutti i tipi di datastore.
NEVER_INCLUDE Il parametro filter non è mai incluso nell'elenco dei parametri dello strumento, indipendentemente dal tipo di datastore.

Stato

Rappresenta lo stato di disponibilità dinamica dello strumento.

Enum
STATE_UNSPECIFIED Stato predefinito.
ACTIVE Lo strumento è disponibile e offerto attivamente dal server.
INACTIVE Lo strumento è configurato o bloccato, ma al momento non è offerto dal server.
STALE Lo strumento esiste sul server, ma non corrisponde alla versione sul server.

CorpusType

Il tipo di corpus Vertex RAG.

Enum
CORPUS_TYPE_UNSPECIFIED Tipo di corpus non specificato.
USER_OWNED Il corpus viene creato e posseduto dall'utente.
FULLY_MANAGED Il corpus viene creato dall'agente.

WidgetType

Tutti i tipi di widget disponibili. In futuro potrebbero essere aggiunti nuovi valori a questa enumerazione.

Enum
WIDGET_TYPE_UNSPECIFIED Tipo di widget non specificato.
CUSTOM Tipo di widget personalizzato.
PRODUCT_DETAILS Widget dei dettagli del prodotto.
QUICK_ACTIONS Widget Azioni rapide.
PRODUCT_COMPARISON Widget di confronto dei prodotti.
ADVANCED_PRODUCT_DETAILS Widget dei dettagli del prodotto avanzati.
SHORT_FORM Widget per i contenuti nel formato breve.
OVERALL_SATISFACTION Widget Soddisfazione generale.
ORDER_SUMMARY Widget di riepilogo dell'ordine.
APPOINTMENT_DETAILS Widget dei dettagli dell'appuntamento.
APPOINTMENT_SCHEDULER Widget di programmazione degli appuntamenti.
CONTACT_FORM Widget modulo di contatto.

Modalità

La strategia utilizzata per mappare i dati dallo strumento di origine al widget.

Enum
MODE_UNSPECIFIED Modalità non specificata.
FIELD_MAPPING Utilizza la mappa field_mappings per la trasformazione dei dati.
PYTHON_SCRIPT Utilizza python_script per la trasformazione dei dati.

Tipo

Definisce il modo in cui viene prodotta la risposta testuale.

Enum
TYPE_UNSPECIFIED Tipo non specificato.
NONE L'LLM decide dinamicamente se generare una risposta di testo insieme al widget in base al contesto della conversazione.
LLM_GENERATED All'LLM viene richiesto esplicitamente di generare una risposta di testo.
STATIC Viene sempre utilizzata una risposta di testo statico predefinita.

ExecutionType

Il tipo di esecuzione dello strumento o del set di strumenti.

Enum
EXECUTION_TYPE_UNSPECIFIED Il tipo di esecuzione non è specificato. Se non specificato, il valore predefinito è SYNCHRONOUS.
SYNCHRONOUS Lo strumento viene eseguito in modo sincrono. La sessione viene bloccata finché lo strumento non restituisce un risultato.
ASYNCHRONOUS Lo strumento viene eseguito in modo asincrono. La sessione continuerà mentre lo strumento è in esecuzione.

MatchType

Tipo di corrispondenza per il filtro dei contenuti.

Enum
MATCH_TYPE_UNSPECIFIED Il tipo di corrispondenza non è specificato.
SIMPLE_STRING_MATCH I contenuti vengono confrontati con le sottostringhe carattere per carattere.
WORD_BOUNDARY_STRING_MATCH I contenuti corrispondono solo se il pattern trovato nel testo è circondato da delimitatori di parole. Le frasi vietate possono contenere anche delimitatori di parole.
REGEXP_MATCH I contenuti vengono abbinati utilizzando la sintassi delle espressioni regolari.
SENSITIVE_WORDS I contenuti vengono confrontati con un elenco di parole e frasi sensibili gestito dal sistema. Se colleghi un guardrail con questo tipo di corrispondenza a un'app o a un agente, il filtro predefinito per le parole sensibili viene sostituito per gli agenti interessati. Disattiva il guardrail per disattivare il filtro predefinito.

PolicyScope

Definisce quando applicare il controllo delle policy durante la conversazione.

Enum
POLICY_SCOPE_UNSPECIFIED L'ambito della policy non è specificato.
USER_QUERY Il controllo delle norme viene attivato in base all'input utente.
AGENT_RESPONSE Il controllo delle policy viene attivato in base alla risposta dell'agente. L'applicazione di questo ambito della policy introdurrà una latenza aggiuntiva prima che l'agente possa rispondere.
USER_QUERY_AND_AGENT_RESPONSE Il controllo delle policy viene attivato sia sull'input utente dell'utente che sulla risposta dell'agente. L'applicazione di questo ambito della policy introdurrà una latenza aggiuntiva prima che l'agente possa rispondere.

HarmCategory

Categoria di danno.

Enum
HARM_CATEGORY_UNSPECIFIED La categoria di danno non è specificata.
HARM_CATEGORY_HATE_SPEECH La categoria di danno è l'incitamento all'odio.
HARM_CATEGORY_DANGEROUS_CONTENT La categoria di danno è Contenuti pericolosi.
HARM_CATEGORY_HARASSMENT La categoria di danno è molestie.
HARM_CATEGORY_SEXUALLY_EXPLICIT La categoria di danno è contenuti sessualmente espliciti.
HARM_CATEGORY_PROFANITY La categoria di danno è il linguaggio volgare.
HARM_CATEGORY_TOXIC La categoria di danno è tossica.

HarmBlockThreshold

Livelli di soglia basati sulla probabilità per il blocco.

Enum
HARM_BLOCK_THRESHOLD_UNSPECIFIED Soglia di blocco dei contenuti dannosi non specificata.
BLOCK_LOW_AND_ABOVE Blocca soglia bassa e superiore (ovvero blocca più contenuti).
BLOCK_MEDIUM_AND_ABOVE Blocca soglia media e superiore.
BLOCK_ONLY_HIGH Blocco solo soglia alta (ovvero blocco ridotto).
BLOCK_NONE Nessun blocco.
OFF Disattiva il filtro di sicurezza.

Tipo

Tipo di supervisore.

Enum
TYPE_UNSPECIFIED Il tipo non è specificato.
INVALID_TEXT Tipo di problema di testo non valido.
LANGUAGE_SHIFT Tipo di problema relativo al cambio di lingua.
SPEAKER_SHIFT Tipo di problema di spostamento dello speaker.
AUDIO_MISMATCH Tipo di problema di mancata corrispondenza audio.
MISSING_TOOL_CALL Tipo di problema di chiamata allo strumento mancante.
CUSTOM Tipo di problema personalizzato.
CHOPPY_AUDIO Tipo di problema: audio frammentato.
PROFANITY Tipo di problema relativo al linguaggio volgare dell'agente.

DetectionMode

Modalità di rilevamento del supervisore.

Enum
DETECTION_MODE_UNSPECIFIED La modalità di rilevamento non è specificata. Il valore predefinito è NON_BLOCKING.
NON_BLOCKING Modalità di rilevamento non bloccante. La risposta non viene bloccata quando è in corso il rilevamento del supervisore.
BLOCKING Modalità di rilevamento del blocco. La risposta viene bloccata quando è in corso il rilevamento del supervisore.

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.

Suggerimento distruttivo: ❌ | Suggerimento idempotente: ✅ | Suggerimento di sola lettura: ✅ | Suggerimento open world: ❌