Strumento: create_app_version
Crea una nuova versione dell'app nell'app specificata.
Il seguente esempio mostra come utilizzare curl per richiamare lo strumento MCP create_app_version.
| Curl Request |
|---|
curl --location 'https://ces.[REGION].rep.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "create_app_version", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
Schema di input
Messaggio di richiesta per AgentService.CreateAppVersion
CreateAppVersionRequest
| Rappresentazione JSON |
|---|
{
"parent": string,
"appVersionId": string,
"appVersion": {
object ( |
| Campi | |
|---|---|
parent |
Obbligatorio. Il nome della risorsa dell'app in cui creare una versione dell'app. |
appVersionId |
Facoltativo. L'ID da utilizzare per la versione dell'app, che diventerà il componente finale del nome della risorsa della versione dell'app. Se non viene fornito, verrà assegnato automaticamente un ID univoco per la versione dell'app. |
appVersion |
Obbligatorio. La versione dell'app da creare. |
AppVersion
| Rappresentazione JSON |
|---|
{
"name": string,
"displayName": string,
"description": string,
"creator": string,
"createTime": string,
"snapshot": {
object ( |
| Campi | |
|---|---|
name |
Identificatore. L'identificatore univoco della versione dell'app. Formato: |
displayName |
Facoltativo. Il nome visualizzato della versione dell'app. |
description |
Facoltativo. La descrizione della versione dell'app. |
creator |
Solo output. Email dell'utente che ha creato la versione dell'app. |
createTime |
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: |
snapshot |
Solo output. Lo snapshot dell'app al momento della creazione della versione. |
etag |
Solo output. 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. |
Timestamp
| Rappresentazione JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Campi | |
|---|---|
seconds |
Rappresenta i secondi di tempo UTC a partire dall'epoca Unix 1970-01-01T00:00:00Z. Deve essere compreso tra -62135596800 e 253402300799 inclusi (corrispondenti a 0001-01-01T00:00:00Z e 9999-12-31T23:59:59Z). |
nanos |
Frazioni di secondo non negative con risoluzione in nanosecondi. Questo campo è la parte in nanosecondi della durata, non un'alternativa ai secondi. I valori negativi dei secondi con frazioni devono comunque avere valori non negativi dei nanosecondi che vengono conteggiati in avanti nel tempo. Deve essere compreso tra 0 e 999.999.999 inclusi. |
AppSnapshot
| Rappresentazione JSON |
|---|
{ "app": { object ( |
| Campi | |
|---|---|
app |
Facoltativo. Le impostazioni di base per l'app. |
agents[] |
Facoltativo. Elenco degli agenti nell'app. |
tools[] |
Facoltativo. Elenco degli strumenti nell'app. |
examples[] |
Facoltativo. Elenco di esempi nell'app. |
guardrails[] |
Facoltativo. Elenco delle barriere protettive nell'app. |
toolsets[] |
Facoltativo. Elenco di toolset nell'app. |
App
| Rappresentazione JSON |
|---|
{ "name": string, "displayName": string, "description": string, "pinned": boolean, "rootAgent": string, "languageSettings": { object ( |
| Campi | |
|---|---|
name |
Identificatore. L'identificatore univoco dell'app. Formato: |
displayName |
Obbligatorio. Nome visualizzato dell'app. |
description |
Facoltativo. Descrizione dell'app leggibile. |
pinned |
Facoltativo. Indica se l'app è bloccata nell'elenco delle app. |
rootAgent |
Facoltativo. L'agente principale è l'entry point dell'app. Formato: |
languageSettings |
Facoltativo. Impostazioni della lingua dell'app. |
timeZoneSettings |
Facoltativo. Impostazioni del fuso orario dell'app. |
audioProcessingConfig |
Facoltativo. Configurazione dell'elaborazione audio dell'app. |
loggingSettings |
Facoltativo. Impostazioni di registrazione nel log dell'app. |
errorHandlingSettings |
Facoltativo. Impostazioni di gestione degli errori dell'app. |
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 |
Facoltativo. La modalità di esecuzione dello strumento per l'app. Se non viene fornita, il valore predefinito è PARALLEL. |
evaluationMetricsThresholds |
Facoltativo. Le soglie di valutazione per l'app. |
variableDeclarations[] |
Facoltativo. Le dichiarazioni delle variabili. |
predefinedVariableDeclarations[] |
Solo output. Le dichiarazioni delle variabili predefinite per l'app. |
globalInstruction |
Facoltativo. Istruzioni per tutti gli agenti nell'app. Puoi utilizzare questa istruzione per impostare un'identità o una personalità stabile per tutti gli agenti. |
guardrails[] |
Facoltativo. Elenco di misure di salvaguardia per l'app. Formato: |
dataStoreSettings |
Facoltativo. Le impostazioni del datastore per l'app. |
defaultChannelProfile |
Facoltativo. Il profilo del canale predefinito utilizzato dall'app. |
metadata |
Facoltativo. Metadati sull'app. Questo campo può essere utilizzato per memorizzare informazioni aggiuntive pertinenti ai dettagli o agli utilizzi previsti dell'app. Un oggetto contenente un elenco di coppie |
createTime |
Solo output. Timestamp di 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: |
updateTime |
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: |
etag |
Solo output. 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. |
deploymentCount |
Solo output. Numero di deployment nell'app. |
clientCertificateSettings |
Facoltativo. Le impostazioni predefinite del certificato client per l'app. |
locked |
Facoltativo. Indica se l'app è bloccata per le modifiche. Se l'app è bloccata, le modifiche alle risorse dell'app verranno rifiutate. |
LanguageSettings
| Rappresentazione JSON |
|---|
{ "defaultLanguageCode": string, "supportedLanguageCodes": [ string ], "enableMultilingualSupport": boolean, "fallbackAction": string } |
| Campi | |
|---|---|
defaultLanguageCode |
Facoltativo. Il codice lingua predefinito dell'app. |
supportedLanguageCodes[] |
Facoltativo. Elenco dei codici lingua supportati dall'app, oltre a |
enableMultilingualSupport |
Facoltativo. Consente il supporto multilingue. Se è true, gli agenti nell'app utilizzeranno istruzioni predefinite per migliorare la gestione dell'input multilingue. |
fallbackAction |
Facoltativo. L'azione da eseguire quando un agente riceve 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 risorsa completo di uno strumento, che attiva l'esecuzione di uno strumento specifico. - Un'azione di sistema predefinita, ad esempio "escalate" o "exit", che attiva un segnale |
TimeZoneSettings
| Rappresentazione JSON |
|---|
{ "timeZone": string } |
| Campi | |
|---|---|
timeZone |
Facoltativo. Il fuso orario dell'app dal database dei fusi orari, ad esempio: America/Los_Angeles, Europe/Paris. |
AudioProcessingConfig
| Rappresentazione JSON |
|---|
{ "synthesizeSpeechConfigs": { string: { object ( |
| Campi | |
|---|---|
synthesizeSpeechConfigs |
Facoltativo. Configurazione della sintesi della risposta dell'agente, mapping dal codice della lingua a 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 |
bargeInConfig |
Facoltativo. Configura il comportamento dell'agente per le attività di interruzione dell'utente. |
inactivityTimeout |
Facoltativo. La durata dell'inattività dell'utente (nessun comando vocale o interazione) prima che l'agente gli chieda di riprendere l'interazione. Se non viene impostato, l'agente non chiederà all'utente di riprendere l'interazione. Una durata in secondi con un massimo di nove cifre frazionarie, che termina con " |
ambientSoundConfig |
Facoltativo. Configurazione del suono ambientale da riprodurre con la risposta dell'agente sintetizzata, per migliorare la naturalezza della conversazione. |
SynthesizeSpeechConfigsEntry
| Rappresentazione JSON |
|---|
{
"key": string,
"value": {
object ( |
| Campi | |
|---|---|
key |
|
value |
|
SynthesizeSpeechConfig
| Rappresentazione JSON |
|---|
{ "voice": string, "speakingRate": number } |
| Campi | |
|---|---|
voice |
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 |
Facoltativo. La velocità di lettura nell'intervallo [0,25, 2,0]. 1.0 è la velocità nativa normale supportata dalla voce specifica. 2.0 è il doppio della velocità, mentre 0.5 è la metà della velocità. I valori al di fuori dell'intervallo [0,25, 2,0] restituiranno un errore. |
BargeInConfig
| Rappresentazione JSON |
|---|
{ "disableBargeIn": boolean, "bargeInAwareness": boolean } |
| Campi | |
|---|---|
disableBargeIn |
Facoltativo. Disattiva l'interruzione da parte dell'utente mentre l'agente sta parlando. Se è true, l'input utente durante la riproduzione della risposta dell'agente verrà ignorato. Deprecato: |
bargeInAwareness |
Facoltativo. Se abilitato, 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 negli scenari in cui le risposte dell'agente vengono visualizzate visivamente. |
Durata
| Rappresentazione JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Campi | |
|---|---|
seconds |
Secondi firmati dell'intervallo di tempo. Deve essere compreso tra -315.576.000.000 e +315.576.000.000 inclusi. Nota: questi limiti vengono calcolati in base a: 60 sec/min * 60 min/ora * 24 ore/giorno * 365,25 giorni/anno * 10.000 anni |
nanos |
Frazioni di secondo con segno con risoluzione in nanosecondi dell'intervallo di tempo. Le durate inferiori a un secondo sono rappresentate con un campo |
AmbientSoundConfig
| Rappresentazione JSON |
|---|
{ "volumeGainDb": number, // Union field |
| Campi | |
|---|---|
volumeGainDb |
Facoltativo. Guadagno di volume (in dB) del volume nativo normale supportato dal rumore ambientale, nell'intervallo [-96,0, 16,0]. Se non è impostato o è impostato su un valore di 0, 0 dB, verrà riprodotto con l'ampiezza del segnale nativo normale. Un valore di -6,0 dB verrà riprodotto a circa metà dell'ampiezza del segnale nativo normale. Un valore di +6,0 (dB) verrà riprodotto a un'ampiezza circa doppia rispetto a quella normale del segnale nativo. Ti consigliamo vivamente di non superare +10 (dB), in quanto di solito non si verifica un aumento effettivo del volume per valori superiori. |
Campo unione source. Rumore ambientale da riprodurre con la risposta dell'agente sintetizzata, per migliorare la naturalezza della conversazione. source può essere solo uno dei seguenti tipi: |
|
prebuiltAmbientNoise |
Facoltativo. Deprecato: |
gcsUri |
Facoltativo. Rumore ambientale come file WAV mono a 16 kHz archiviato in Cloud Storage. Nota: assicurati che il service agent CES |
prebuiltAmbientSound |
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" |
LoggingSettings
| Rappresentazione JSON |
|---|
{ "redactionConfig": { object ( |
| Campi | |
|---|---|
redactionConfig |
Facoltativo. Configurazione della modalità di oscuramento dei dati sensibili. |
audioRecordingConfig |
Facoltativo. Configurazione della modalità di registrazione delle interazioni audio. |
bigqueryExportSettings |
Facoltativo. Impostazioni per descrivere i comportamenti di esportazione BigQuery per l'app. Se abilitati, i dati delle conversazioni verranno esportati nelle tabelle BigQuery. |
cloudLoggingSettings |
Facoltativo. Impostazioni per descrivere i comportamenti di Cloud Logging per l'app. |
conversationLoggingSettings |
Facoltativo. Impostazioni per descrivere i comportamenti di registrazione delle conversazioni per l'app. |
evaluationAudioRecordingConfig |
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 |
Facoltativo. Impostazioni per descrivere i comportamenti di raccolta dei dati delle conversazioni per la pipeline di analisi LLM per l'app. |
RedactionConfig
| Rappresentazione JSON |
|---|
{ "enableRedaction": boolean, "inspectTemplate": string, "deidentifyTemplate": string } |
| Campi | |
|---|---|
enableRedaction |
Facoltativo. Se impostato su true, la redazione verrà applicata in vari scenari di logging, tra cui la cronologia delle conversazioni, Cloud Logging e la registrazione audio. |
inspectTemplate |
Facoltativo. Nome del modello di ispezione DLP per configurare il rilevamento dei tipi di dati sensibili. Formato: |
deidentifyTemplate |
Facoltativo. Nome del modello di anonimizzazione DLP per indicare come anonimizzare i contenuti. Formato: |
AudioRecordingConfig
| Rappresentazione JSON |
|---|
{ "gcsBucket": string, "gcsPathPrefix": string } |
| Campi | |
|---|---|
gcsBucket |
Facoltativo. Il bucket Cloud Storage in cui archiviare le registrazioni audio della sessione. L'URI deve iniziare con "gs://". Scegli una posizione del bucket che soddisfi i tuoi requisiti di residenza dei dati. Nota: se il bucket Cloud Storage si trova in un progetto diverso dall'app, devi concedere l'autorizzazione |
gcsPathPrefix |
Facoltativo. Il prefisso del percorso 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 |
BigQueryExportSettings
| Rappresentazione JSON |
|---|
{ "enabled": boolean, "project": string, "dataset": string } |
| Campi | |
|---|---|
enabled |
Facoltativo. Indica se l'esportazione in BigQuery è attivata. |
project |
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 dall'app, devi concedere il ruolo |
dataset |
Facoltativo. Il set di dati BigQuery in cui esportare i dati. |
CloudLoggingSettings
| Rappresentazione JSON |
|---|
{ "enableCloudLogging": boolean } |
| Campi | |
|---|---|
enableCloudLogging |
Facoltativo. Se abilitare Cloud Logging per le sessioni. |
ConversationLoggingSettings
| Rappresentazione JSON |
|---|
{ "disableConversationLogging": boolean } |
| Campi | |
|---|---|
disableConversationLogging |
Facoltativo. Se disattivare la registrazione delle conversazioni per le sessioni. |
MetricAnalysisSettings
| Rappresentazione JSON |
|---|
{ "llmMetricsOptedOut": boolean } |
| Campi | |
|---|---|
llmMetricsOptedOut |
Facoltativo. Se raccogliere i dati delle conversazioni per le metriche di analisi LLM. Se il valore è true, i dati delle conversazioni non verranno raccolti per le metriche di analisi LLM; in caso contrario, verranno raccolti. |
ErrorHandlingSettings
| Rappresentazione JSON |
|---|
{
"errorHandlingStrategy": enum ( |
| Campi | |
|---|---|
errorHandlingStrategy |
Facoltativo. La strategia da utilizzare per la gestione degli errori. |
ModelSettings
| Rappresentazione JSON |
|---|
{ "model": string, // Union field |
| Campi | |
|---|---|
model |
Facoltativo. Il modello LLM che l'agente deve utilizzare. Se non è impostato, l'agente erediterà il modello dall'agente principale. |
Campo unione
|
|
temperature |
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. Le temperature più alte producono risposte più creative. |
EvaluationMetricsThresholds
| Rappresentazione JSON |
|---|
{ "goldenEvaluationMetricsThresholds": { object ( |
| Campi | |
|---|---|
goldenEvaluationMetricsThresholds |
Facoltativo. Le soglie delle metriche di valutazione secondo regole d'oro. |
hallucinationMetricBehavior |
Facoltativo. Deprecato: utilizza |
goldenHallucinationMetricBehavior |
Facoltativo. Il comportamento della metrica delle allucinazioni per le valutazioni di riferimento. |
scenarioHallucinationMetricBehavior |
Facoltativo. Il comportamento della metrica di allucinazione per le valutazioni degli scenari. |
GoldenEvaluationMetricsThresholds
| Rappresentazione JSON |
|---|
{ "turnLevelMetricsThresholds": { object ( |
| Campi | |
|---|---|
turnLevelMetricsThresholds |
Facoltativo. Le soglie delle metriche a livello di turno. |
expectationLevelMetricsThresholds |
Facoltativo. Le soglie delle metriche del livello di aspettativa. |
toolMatchingSettings |
Facoltativo. Le impostazioni di corrispondenza dello strumento. Una chiamata allo strumento aggiuntiva è una chiamata allo strumento presente nell'esecuzione, ma che non corrisponde ad alcuna chiamata allo strumento nell'aspettativa di riferimento. |
TurnLevelMetricsThresholds
| Rappresentazione JSON |
|---|
{ "semanticSimilarityChannel": enum ( |
| Campi | |
|---|---|
semanticSimilarityChannel |
Facoltativo. Il canale di similarità semantica da utilizzare per la valutazione. |
Campo unione
|
|
semanticSimilaritySuccessThreshold |
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
|
|
overallToolInvocationCorrectnessThreshold |
Facoltativo. La soglia di successo per la correttezza complessiva dell'invocazione dello strumento. Deve essere un numero in virgola mobile compreso tra 0 e 1. Il valore predefinito è 1.0. |
ExpectationLevelMetricsThresholds
| Rappresentazione JSON |
|---|
{ // Union field |
| Campi | |
|---|---|
Campo unione
|
|
toolInvocationParameterCorrectnessThreshold |
Facoltativo. La soglia di successo per la correttezza dei parametri di chiamata dei singoli strumenti. Deve essere un numero in virgola mobile compreso tra 0 e 1. Il valore predefinito è 1.0. |
ToolMatchingSettings
| Rappresentazione JSON |
|---|
{
"extraToolCallBehavior": enum ( |
| Campi | |
|---|---|
extraToolCallBehavior |
Facoltativo. Comportamento per le chiamate di strumenti aggiuntivi. Il valore predefinito è FAIL. |
VariableDeclaration
| Rappresentazione JSON |
|---|
{
"name": string,
"description": string,
"schema": {
object ( |
| Campi | |
|---|---|
name |
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 |
Obbligatorio. La descrizione della variabile. |
schema |
Obbligatorio. Lo schema della variabile. |
Schema
| Rappresentazione JSON |
|---|
{ "type": enum ( |
| Campi | |
|---|---|
type |
Obbligatorio. Il tipo di dati. |
properties |
Facoltativo. Proprietà di Type.OBJECT. Un oggetto contenente un elenco di coppie |
required[] |
Facoltativo. Proprietà obbligatorie di Type.OBJECT. |
description |
Facoltativo. La descrizione dei dati. |
items |
Facoltativo. Schema degli elementi di Type.ARRAY. |
nullable |
Facoltativo. Indica se il valore può essere null. |
uniqueItems |
Facoltativo. Indica che gli elementi nell'array devono essere univoci. Si applica solo a TYPE.ARRAY. |
prefixItems[] |
Facoltativo. Schemi degli elementi iniziali di Type.ARRAY. |
additionalProperties |
Facoltativo. Può essere un valore booleano o un oggetto e controlla la presenza di proprietà aggiuntive. |
anyOf[] |
Facoltativo. Il valore deve essere convalidato rispetto a uno o più sottoschema nell'elenco. |
enum[] |
Facoltativo. Valori possibili 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 di appartamento come : {type:INTEGER, format:enum, enum:["101", "201", "301"]} |
default |
Facoltativo. Valore predefinito dei dati. |
ref |
Facoltativo. Consente riferimenti indiretti tra i nodi dello schema. Il valore deve essere un riferimento valido a un elemento secondario della radice Ad esempio, lo schema seguente definisce un riferimento a un nodo dello schema denominato "Pet": Il valore della proprietà "pet" è un riferimento al nodo dello schema denominato "Pet". Per maggiori dettagli, visita la pagina https://json-schema.org/understanding-json-schema/structuring. |
defs |
Facoltativo. Una mappa delle definizioni da utilizzare per Un oggetto contenente un elenco di coppie |
title |
Facoltativo. Il titolo dello schema. |
minItems |
Facoltativo. Numero minimo di elementi per Type.ARRAY. |
maxItems |
Facoltativo. Numero massimo di elementi per Type.ARRAY. |
Campo unione
|
|
minimum |
Facoltativo. Valore minimo per Type.INTEGER e Type.NUMBER. |
Campo unione
|
|
maximum |
Facoltativo. Valore massimo per Type.INTEGER e Type.NUMBER. |
PropertiesEntry
| Rappresentazione JSON |
|---|
{
"key": string,
"value": {
object ( |
| Campi | |
|---|---|
key |
|
value |
|
Valore
| Rappresentazione JSON |
|---|
{ // Union field |
| Campi | |
|---|---|
Campo unione kind. Il tipo di valore. kind può essere solo uno dei seguenti tipi: |
|
nullValue |
Rappresenta un valore null. |
numberValue |
Rappresenta un valore double. |
stringValue |
Rappresenta un valore stringa. |
boolValue |
Rappresenta un valore booleano. |
structValue |
Rappresenta un valore strutturato. |
listValue |
Rappresenta un |
Struct
| Rappresentazione JSON |
|---|
{ "fields": { string: value, ... } } |
| Campi | |
|---|---|
fields |
Mappa non ordinata di valori con tipo dinamico. Un oggetto contenente un elenco di coppie |
FieldsEntry
| Rappresentazione JSON |
|---|
{ "key": string, "value": value } |
| Campi | |
|---|---|
key |
|
value |
|
ListValue
| Rappresentazione JSON |
|---|
{ "values": [ value ] } |
| Campi | |
|---|---|
values[] |
Campo ripetuto di valori con tipo dinamico. |
DefsEntry
| Rappresentazione JSON |
|---|
{
"key": string,
"value": {
object ( |
| Campi | |
|---|---|
key |
|
value |
|
DataStoreSettings
| Rappresentazione JSON |
|---|
{
"engines": [
{
object ( |
| Campi | |
|---|---|
engines[] |
Solo output. I motori dell'app. |
Motore
| Rappresentazione JSON |
|---|
{
"name": string,
"type": enum ( |
| Campi | |
|---|---|
name |
Solo output. Il nome della risorsa del motore. Formato: |
type |
Solo output. Il tipo di motore. |
ChannelProfile
| Rappresentazione JSON |
|---|
{ "profileId": string, "channelType": enum ( |
| Campi | |
|---|---|
profileId |
Facoltativo. L'identificatore univoco del profilo del canale. |
channelType |
Facoltativo. Il tipo di profilo del canale. |
personaProperty |
Facoltativo. La proprietà della persona del profilo del canale. |
disableDtmf |
Facoltativo. Indica se disattivare la tecnologia multifrequenza a due toni (DTMF). |
disableBargeInControl |
Facoltativo. Se disattivare il controllo di interruzione 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. |
webWidgetConfig |
Facoltativo. La configurazione del widget web. |
noiseSuppressionLevel |
Facoltativo. Il livello di eliminazione del rumore del profilo del canale. I valori disponibili sono "low", "moderate", "high", "very_high". |
PersonaProperty
| Rappresentazione JSON |
|---|
{
"persona": enum ( |
| Campi | |
|---|---|
persona |
Facoltativo. La personalità del canale. |
WebWidgetConfig
| Rappresentazione JSON |
|---|
{ "modality": enum ( |
| Campi | |
|---|---|
modality |
Facoltativo. La modalità del widget web. |
theme |
Facoltativo. Il tema del widget web. |
webWidgetTitle |
Facoltativo. Il titolo del widget web. |
securitySettings |
Facoltativo. Le impostazioni di sicurezza del widget web. |
SecuritySettings
| Rappresentazione JSON |
|---|
{ "enablePublicAccess": boolean, "enableOriginCheck": boolean, "allowedOrigins": [ string ], "enableRecaptcha": boolean } |
| Campi | |
|---|---|
enablePublicAccess |
Facoltativo. Indica se l'accesso pubblico al widget web è abilitato. Se |
enableOriginCheck |
Facoltativo. Indica se il controllo dell'origine per il widget web è abilitato. Se |
allowedOrigins[] |
Facoltativo. Le origini autorizzate a ospitare il widget web. Un'origine è definita dalla RFC 6454. Se è vuoto, sono consentite tutte le origini. Sono consentite massimo 100 origini. Esempio: "https://example.com" |
enableRecaptcha |
Facoltativo. Indica se la verifica reCAPTCHA per il widget web è abilitata. |
MetadataEntry
| Rappresentazione JSON |
|---|
{ "key": string, "value": string } |
| Campi | |
|---|---|
key |
|
value |
|
ClientCertificateSettings
| Rappresentazione JSON |
|---|
{ "tlsCertificate": string, "privateKey": string, "passphrase": string } |
| Campi | |
|---|---|
tlsCertificate |
Obbligatorio. Il certificato TLS codificato in formato PEM. Questa stringa deve includere le righe di intestazione iniziale e piè di pagina finale. |
privateKey |
Obbligatorio. Il nome della risorsa della versione secret di Secret Manager che archivia la chiave privata codificata in formato PEM. Formato: |
passphrase |
Facoltativo. Il nome della risorsa della versione del secret SecretManager che archivia la passphrase per decriptare la chiave privata. Deve essere lasciato non impostato se la chiave privata non è criptata. Formato: |
Agente
| Rappresentazione JSON |
|---|
{ "name": string, "displayName": string, "description": string, "modelSettings": { object ( |
| Campi | |
|---|---|
name |
Identificatore. L'identificatore univoco dell'agente. Formato: |
displayName |
Obbligatorio. Il nome visualizzato dell'agente. |
description |
Facoltativo. Descrizione dell'agente leggibile. |
modelSettings |
Facoltativo. Configurazioni per il modello LLM. |
instruction |
Facoltativo. Istruzioni per il modello LLM per guidare il comportamento dell'agente. |
tools[] |
Facoltativo. Elenco degli strumenti disponibili per l'agente. Formato: |
childAgents[] |
Facoltativo. Elenco degli agenti secondari nell'albero degli agenti. Formato: |
beforeAgentCallbacks[] |
Facoltativo. Le funzioni di callback da eseguire prima di chiamare l'agente. Le callback fornite vengono eseguite in sequenza nell'ordine esatto in cui sono elencate. Se un callback restituisce una risposta sostituita, l'esecuzione si interrompe e tutti i callback rimanenti vengono ignorati. |
afterAgentCallbacks[] |
Facoltativo. I callback da eseguire dopo la chiamata all'agente. Le callback fornite vengono eseguite in sequenza nell'ordine esatto in cui sono elencate. Se un callback restituisce una risposta sostituita, l'esecuzione si interrompe e tutti i callback rimanenti vengono ignorati. |
beforeModelCallbacks[] |
Facoltativo. I callback da eseguire prima di chiamare il modello. Se vengono effettuate più chiamate al modello, il callback verrà eseguito più volte. Le callback fornite vengono eseguite in sequenza nell'ordine esatto in cui sono elencate. Se un callback restituisce una risposta sostituita, l'esecuzione si interrompe e tutti i callback rimanenti vengono ignorati. |
afterModelCallbacks[] |
Facoltativo. I callback da eseguire dopo la chiamata al modello. Se vengono effettuate più chiamate al modello, il callback verrà eseguito più volte. Le callback fornite vengono eseguite in sequenza nell'ordine esatto in cui sono elencate. Se un callback restituisce una risposta sostituita, l'esecuzione si interrompe e tutti i callback rimanenti vengono ignorati. |
beforeToolCallbacks[] |
Facoltativo. Le funzioni di callback da eseguire prima di richiamare lo strumento. Se ci sono più chiamate di strumenti, il callback verrà eseguito più volte. Le callback fornite vengono eseguite in sequenza nell'ordine esatto in cui sono elencate. Se un callback restituisce una risposta sostituita, l'esecuzione si interrompe e tutti i callback rimanenti vengono ignorati. |
afterToolCallbacks[] |
Facoltativo. I callback da eseguire dopo l'invocazione dello strumento. Se ci sono più chiamate di strumenti, il callback verrà eseguito più volte. Le callback fornite vengono eseguite in sequenza nell'ordine esatto in cui sono elencate. Se un callback restituisce una risposta sostituita, l'esecuzione si interrompe e tutti i callback rimanenti vengono ignorati. |
createTime |
Solo output. Timestamp di 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: |
updateTime |
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: |
guardrails[] |
Facoltativo. Elenco delle barriere protettive per l'agente. Formato: |
etag |
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. |
toolsets[] |
Facoltativo. Elenco dei toolset per l'agente. |
generatedSummary |
Solo output. Se l'agente viene generato dall'assistente LLM, questo campo contiene un riepilogo descrittivo della generazione. |
transferRules[] |
Facoltativo. Regole di trasferimento degli agenti. Se corrispondono più regole, verrà utilizzata la prima nell'elenco. |
Campo unione agent_type. Il tipo di agente. agent_type può essere solo uno dei seguenti tipi: |
|
llmAgent |
Facoltativo. Il tipo di agente predefinito. |
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 dall'app, devi concedere |
RemoteDialogflowAgent
| Rappresentazione JSON |
|---|
{ "agent": string, "flowId": string, "environmentId": string, "inputVariableMapping": { string: string, ... }, "outputVariableMapping": { string: string, ... }, "respectResponseInterruptionSettings": boolean } |
| Campi | |
|---|---|
agent |
Obbligatorio. Il nome risorsa dell'agente Dialogflow. Formato: |
flowId |
Facoltativo. L'ID del flusso nell'agente Dialogflow. |
environmentId |
Facoltativo. L'ID ambiente dell'agente Dialogflow da utilizzare per l'esecuzione dell'agente. Se non specificato, verrà utilizzato l'ambiente bozza. |
inputVariableMapping |
Facoltativo. Il mapping 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 |
outputVariableMapping |
Facoltativo. Il mapping dei nomi dei parametri di sessione di Dialogflow ai nomi delle variabili dell'app da inviare di nuovo all'agente CES al termine dell'esecuzione dell'agente Dialogflow. Un oggetto contenente un elenco di coppie |
respectResponseInterruptionSettings |
Facoltativo. Indica se rispettare le impostazioni di interruzione a livello di messaggio configurate nell'agente Dialogflow.
|
InputVariableMappingEntry
| Rappresentazione JSON |
|---|
{ "key": string, "value": string } |
| Campi | |
|---|---|
key |
|
value |
|
OutputVariableMappingEntry
| Rappresentazione JSON |
|---|
{ "key": string, "value": string } |
| Campi | |
|---|---|
key |
|
value |
|
Callback
| Rappresentazione JSON |
|---|
{ "description": string, "disabled": boolean, "proactiveExecutionEnabled": boolean, // Union field |
| Campi | |
|---|---|
description |
Facoltativo. Descrizione leggibile del callback. |
disabled |
Facoltativo. Indica se il callback è disattivato. I callback disattivati vengono ignorati dall'agente. |
proactiveExecutionEnabled |
Facoltativo. Se abilitata, la richiamata verrà eseguita anche sugli output intermedi del modello. Questa impostazione ha effetto solo dopo il callback del modello. ATTIVARE CON CAUTELA. In genere, il callback del modello deve essere eseguito solo dopo aver ricevuto tutte le risposte del modello. L'attivazione dell'esecuzione proattiva può avere implicazioni negative sul costo e sulla latenza dell'esecuzione e deve essere attivata solo in rare situazioni. |
Campo unione callback. Il callback da eseguire. callback può essere solo uno dei seguenti tipi: |
|
pythonCode |
Obbligatorio. Il codice Python da eseguire per il callback. |
AgentToolset
| Rappresentazione JSON |
|---|
{ "toolset": string, "toolIds": [ string ] } |
| Campi | |
|---|---|
toolset |
Obbligatorio. Il nome della risorsa del toolset. Formato: |
toolIds[] |
Facoltativo. Gli ID degli strumenti per filtrare il set di strumenti. |
TransferRule
| Rappresentazione JSON |
|---|
{ "childAgent": string, "direction": enum ( |
| Campi | |
|---|---|
childAgent |
Obbligatorio. Il nome della risorsa dell'agente secondario a cui si applica la regola. Formato: |
direction |
Obbligatorio. La direzione del trasferimento. |
Campo unione rule_type. Il tipo di regola. rule_type può essere solo uno dei seguenti tipi: |
|
deterministicTransfer |
Facoltativo. Una regola che viene trasferita immediatamente all'agente di destinazione quando la condizione viene soddisfatta. |
disablePlannerTransfer |
Facoltativo. Regola che impedisce al pianificatore di trasferire la chiamata all'agente di destinazione. |
DeterministicTransfer
| Rappresentazione JSON |
|---|
{ // Union field |
| Campi | |
|---|---|
Campo unione condition_type. La condizione da valutare. condition_type può essere solo uno dei seguenti tipi: |
|
expressionCondition |
Facoltativo. Una regola che valuta una condizione dello stato della sessione. Se la condizione restituisce il valore true, il trasferimento viene eseguito. |
pythonCodeCondition |
Facoltativo. Una regola che utilizza il blocco di codice Python per valutare le condizioni. Se la condizione restituisce il valore true, il trasferimento viene eseguito. |
ExpressionCondition
| Rappresentazione JSON |
|---|
{ "expression": string } |
| Campi | |
|---|---|
expression |
Obbligatorio. La rappresentazione di stringa della condizione cloud.api.Expression. |
PythonCodeCondition
| Rappresentazione JSON |
|---|
{ "pythonCode": string } |
| Campi | |
|---|---|
pythonCode |
Obbligatorio. Il codice Python da eseguire. |
DisablePlannerTransfer
| Rappresentazione JSON |
|---|
{
"expressionCondition": {
object ( |
| Campi | |
|---|---|
expressionCondition |
Obbligatorio. Se la condizione restituisce true, il pianificatore non potrà essere trasferito all'agente di destinazione. |
Strumento
| Rappresentazione JSON |
|---|
{ "name": string, "displayName": string, "executionType": enum ( |
| Campi | |
|---|---|
name |
Identificatore. L'identificatore univoco dello strumento. Formato: -
|
displayName |
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 relativa proprietà |
executionType |
Facoltativo. Il tipo di esecuzione dello strumento. |
createTime |
Solo output. Timestamp di 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: |
updateTime |
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: |
etag |
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. |
generatedSummary |
Solo output. Se lo strumento è generato dall'assistente LLM, questo campo contiene un riepilogo descrittivo della generazione. |
toolFakeConfig |
Facoltativo. Configurazione del comportamento dello strumento in modalità simulata. |
Campo unione tool_type. Il tipo di strumento. tool_type può essere solo uno dei seguenti tipi: |
|
clientFunction |
Facoltativo. La funzione client. |
openApiTool |
Facoltativo. Lo strumento API aperto. |
googleSearchTool |
Facoltativo. Lo strumento di ricerca di Google. |
connectorTool |
Facoltativo. Lo strumento Integration Connector. |
dataStoreTool |
Facoltativo. Lo strumento datastore. |
pythonFunction |
Facoltativo. Lo strumento per le funzioni Python. |
mcpTool |
Facoltativo. Lo strumento MCP. Uno strumento MCP non può essere creato o aggiornato direttamente ed è gestito dal set di strumenti MCP. |
fileSearchTool |
Facoltativo. Lo strumento di ricerca dei file. |
systemTool |
Facoltativo. Lo strumento di sistema. |
widgetTool |
Facoltativo. Lo strumento widget. |
ClientFunction
| Rappresentazione JSON |
|---|
{ "name": string, "description": string, "parameters": { object ( |
| Campi | |
|---|---|
name |
Obbligatorio. Il nome della funzione. |
description |
Facoltativo. La descrizione della funzione. |
parameters |
Facoltativo. Lo schema dei parametri della funzione. |
response |
Facoltativo. Lo schema della risposta della funzione. |
OpenApiTool
| Rappresentazione JSON |
|---|
{ "openApiSchema": string, "name": string, "description": string, "apiAuthentication": { object ( |
| Campi | |
|---|---|
openApiSchema |
Obbligatorio. Lo schema OpenAPI in formato JSON o YAML. |
name |
Facoltativo. Il nome dello strumento. Se non viene fornito, il nome dello strumento verrà derivato dallo schema OpenAPI, da |
description |
Facoltativo. La descrizione dello strumento. Se non viene fornita, la descrizione dello strumento verrà derivata dallo schema OpenAPI, da |
apiAuthentication |
Facoltativo. Informazioni di autenticazione richieste dall'API. |
tlsConfig |
Facoltativo. La configurazione TLS. Include i certificati del server personalizzati di cui il client si fiderà. |
serviceDirectoryConfig |
Facoltativo. Configurazione di Service Directory. |
ignoreUnknownFields |
Facoltativo. Se il valore è true, l'agente ignorerà i campi sconosciuti nella risposta dell'API. |
url |
Facoltativo. L'URL del server dello schema Open API. Questo campo viene impostato solo negli 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. |
ApiAuthentication
| Rappresentazione JSON |
|---|
{ // Union field |
| Campi | |
|---|---|
Campo unione auth_config. La configurazione di autenticazione. auth_config può essere solo uno dei seguenti tipi: |
|
apiKeyConfig |
Facoltativo. Configurazione per l'autenticazione della chiave API. |
oauthConfig |
Facoltativo. Configurazione per OAuth. |
serviceAgentIdTokenAuthConfig |
Facoltativo. Configurazione per l'autenticazione con token ID generato dall'agente di servizio CES. |
serviceAccountAuthConfig |
Facoltativo. Configurazione per l'autenticazione del account di servizio. |
bearerTokenConfig |
Facoltativo. Configurazione per l'autenticazione con token di connessione. |
ApiKeyConfig
| Rappresentazione JSON |
|---|
{
"keyName": string,
"apiKeySecretVersion": string,
"requestLocation": enum ( |
| Campi | |
|---|---|
keyName |
Obbligatorio. Il nome del parametro o dell'intestazione della chiave API. Ad esempio, Se la richiesta API è "https://example.com/act?X-Api-Key= |
apiKeySecretVersion |
Obbligatorio. Il nome della risorsa della versione del secret di Secret Manager che archivia la chiave API. Formato: Nota: devi concedere il ruolo |
requestLocation |
Obbligatorio. Posizione della chiave nella richiesta. |
OAuthConfig
| Rappresentazione JSON |
|---|
{
"oauthGrantType": enum ( |
| Campi | |
|---|---|
oauthGrantType |
Obbligatorio. Tipi di autorizzazione con OAuth. |
clientId |
Obbligatorio. L'ID client del provider OAuth. |
clientSecretVersion |
Obbligatorio. Il nome della risorsa della versione del secret di Secret Manager che archivia il client secret. Formato: Nota: devi concedere il ruolo |
tokenEndpoint |
Obbligatorio. L'endpoint token nel provider OAuth da scambiare con un token di accesso. |
scopes[] |
Facoltativo. Gli ambiti OAuth da concedere. |
ServiceAccountAuthConfig
| Rappresentazione JSON |
|---|
{ "serviceAccount": string, "scopes": [ string ] } |
| Campi | |
|---|---|
serviceAccount |
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 All'account di servizio deve essere concesso il ruolo |
scopes[] |
Facoltativo. Gli ambiti OAuth da concedere. Se non specificato, viene utilizzato l'ambito predefinito |
BearerTokenConfig
| Rappresentazione JSON |
|---|
{ "token": string } |
| Campi | |
|---|---|
token |
Obbligatorio. Il token di connessione. Deve essere nel formato |
TlsConfig
| Rappresentazione JSON |
|---|
{
"caCerts": [
{
object ( |
| Campi | |
|---|---|
caCerts[] |
Obbligatorio. Specifica un elenco di certificati CA personalizzati consentiti per la verifica HTTPS. |
CaCert
| Rappresentazione JSON |
|---|
{ "displayName": string, "cert": string } |
| Campi | |
|---|---|
displayName |
Obbligatorio. Il nome dei certificati CA personalizzati consentiti. Può essere utilizzato per disambiguare i certificati CA personalizzati. |
cert |
Obbligatorio. I certificati CA personalizzati consentiti (in formato DER) per la verifica HTTPS. Esegue l'override dell'archivio attendibilità SSL predefinito. Se questo campo è vuoto o non specificato, CES utilizzerà l'archivio attendibilità predefinito di Google per verificare i certificati. Nota: 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 |
Obbligatorio. Il nome del servizio Service Directory. Formato: |
GoogleSearchTool
| Rappresentazione JSON |
|---|
{
"name": string,
"description": string,
"contextUrls": [
string
],
"preferredDomains": [
string
],
"excludeDomains": [
string
],
"promptConfig": {
object ( |
| Campi | |
|---|---|
name |
Obbligatorio. Il nome dello strumento. |
description |
Facoltativo. Descrizione dello scopo dello strumento. |
contextUrls[] |
Facoltativo. I contenuti verranno recuperati direttamente da questi URL per il contesto e la base. Esempio: "https://example.com/path.html". Sono consentiti massimo 20 URL. |
preferredDomains[] |
Facoltativo. Specifica i domini a cui limitare i risultati di ricerca. Esempio: "example.com", "another.site". È possibile specificare un massimo di 20 domini. |
excludeDomains[] |
Facoltativo. Elenco dei domini da escludere dai risultati di ricerca. Esempio: "example.com". È possibile escludere un massimo di 2000 domini. |
promptConfig |
Facoltativo. Istruzioni del prompt trasmesse al planner su come devono essere elaborati i risultati di ricerca per il testo e la voce. |
PromptConfig
| Rappresentazione JSON |
|---|
{ "textPrompt": string, "voicePrompt": string } |
| Campi | |
|---|---|
textPrompt |
Facoltativo. Definisce il prompt utilizzato per le istruzioni di sistema quando interagisci con l'agente nelle conversazioni di chat. Se non impostato, verrà utilizzato il prompt predefinito. |
voicePrompt |
Facoltativo. Definisce il prompt utilizzato per le istruzioni di sistema quando interagisci con l'agente nelle conversazioni vocali. Se non impostato, verrà utilizzato il prompt predefinito. |
ConnectorTool
| Rappresentazione JSON |
|---|
{ "connection": string, "action": { object ( |
| Campi | |
|---|---|
connection |
Obbligatorio. Il nome completo della risorsa della connessione Integration Connectors a cui viene fatto riferimento. Formato: |
action |
Obbligatorio. Azione da utilizzare per lo strumento. |
authConfig |
Facoltativo. Configura la gestione dell'autenticazione in Integration Connectors. Per impostazione predefinita, un'autenticazione amministratore viene trasmessa nelle richieste dell'API Integration Connectors. Puoi ignorarlo con una configurazione di autenticazione dell'utente finale diversa. Nota: per specificare una configurazione EUC qui, l'override dell'autenticazione deve essere abilitato nella connessione. In caso contrario, la creazione di ConnectorTool non riuscirà. Per i dettagli, vedi https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override. |
name |
Facoltativo. Il nome dello strumento che può essere utilizzato dall'agente per decidere se chiamare questo ConnectorTool. |
description |
Facoltativo. La descrizione dello strumento che può essere utilizzata dall'agente per decidere se chiamare questo ConnectorTool. |
Azione
| Rappresentazione JSON |
|---|
{ "inputFields": [ string ], "outputFields": [ string ], // Union field |
| Campi | |
|---|---|
inputFields[] |
Facoltativo. Campi dell'entità da utilizzare come input per l'operazione. Se non vengono specificati campi, verranno utilizzati tutti i campi dell'entità. |
outputFields[] |
Facoltativo. Campi dell'entità da restituire dall'operazione. Se non vengono specificati campi, vengono restituiti tutti i campi dell'entità. |
Campo unione action_spec. Specifica di un'azione da configurare per l'utilizzo dello strumento. action_spec può essere solo uno dei seguenti tipi: |
|
connectionActionId |
ID di un'azione di connessione da utilizzare per lo strumento. |
entityOperation |
Configurazione dell'operazione dell'entità da utilizzare per lo strumento. |
EntityOperation
| Rappresentazione JSON |
|---|
{
"entityId": string,
"operation": enum ( |
| Campi | |
|---|---|
entityId |
Obbligatorio. ID dell'entità. |
operation |
Obbligatorio. Operazione da eseguire sull'entità. |
EndUserAuthConfig
| Rappresentazione JSON |
|---|
{ // Union field |
| Campi | |
|---|---|
Campo unione auth_config. La configurazione di autenticazione. auth_config può essere solo uno dei seguenti tipi: |
|
oauth2AuthCodeConfig |
Autenticazione con codice di autorizzazione OAuth 2.0. |
oauth2JwtBearerConfig |
Autenticazione della concessione di autorizzazione OAuth 2.0 del profilo JWT. |
Oauth2AuthCodeConfig
| Rappresentazione JSON |
|---|
{ "oauthToken": string } |
| Campi | |
|---|---|
oauthToken |
Obbligatorio. Nome del parametro del token OAuth da trasferire. Deve essere nel formato |
Oauth2JwtBearerConfig
| Rappresentazione JSON |
|---|
{ "issuer": string, "subject": string, "clientKey": string } |
| Campi | |
|---|---|
issuer |
Obbligatorio. Nome del parametro dell'emittente da trasferire. Deve essere nel formato |
subject |
Obbligatorio. Nome del parametro oggetto da trasferire. Deve essere nel formato |
clientKey |
Obbligatorio. Nome del parametro client da trasferire. Deve essere nel formato |
DataStoreTool
| Rappresentazione JSON |
|---|
{ "name": string, "description": string, "boostSpecs": [ { object ( |
| Campi | |
|---|---|
name |
Obbligatorio. Il nome dello strumento datastore. |
description |
Facoltativo. La descrizione dello strumento. |
boostSpecs[] |
Facoltativo. Aumenta la specifica per aumentare la visibilità di determinati documenti. |
modalityConfigs[] |
Facoltativo. Le configurazioni della modalità per il datastore. |
filterParameterBehavior |
Facoltativo. Il comportamento del parametro di filtro. |
Campo unione search_source. Definisce l'origine di ricerca, ovvero un singolo datastore o un motore. search_source può essere solo uno dei seguenti tipi: |
|
dataStoreSource |
Facoltativo. Eseguire ricerche all'interno di un singolo DataStore specifico. |
engineSource |
Facoltativo. Cerca all'interno di un motore (potenzialmente in più datastore). |
DataStoreSource
| Rappresentazione JSON |
|---|
{
"filter": string,
"dataStore": {
object ( |
| Campi | |
|---|---|
filter |
Facoltativo. Specifica del filtro per il datastore. Consulta: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata |
dataStore |
Facoltativo. Il datastore. |
DataStore
| Rappresentazione JSON |
|---|
{ "name": string, "type": enum ( |
| Campi | |
|---|---|
name |
Obbligatorio. Nome completo della risorsa del datastore. Formato: |
type |
Solo output. Il tipo di datastore. Questo campo è di sola lettura e viene compilato dal server. |
documentProcessingMode |
Solo output. La modalità di elaborazione dei documenti per la connessione dell'datastore. Impostato solo per i datastore PUBLIC_WEB e UNSTRUCTURED. |
displayName |
Solo output. Il nome visualizzato del datastore. |
createTime |
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: |
connectorConfig |
Solo output. La configurazione del connettore per la connessione al datastore. |
ConnectorConfig
| Rappresentazione JSON |
|---|
{ "collection": string, "collectionDisplayName": string, "dataSource": string } |
| Campi | |
|---|---|
collection |
Il nome della risorsa della raccolta a cui appartiene il datastore. |
collectionDisplayName |
Nome visualizzato della raccolta a cui appartiene il datastore. |
dataSource |
Il nome dell'origine dati. Esempio: |
EngineSource
| Rappresentazione JSON |
|---|
{
"engine": string,
"dataStoreSources": [
{
object ( |
| Campi | |
|---|---|
engine |
Obbligatorio. Nome completo della risorsa del motore. Formato: |
dataStoreSources[] |
Facoltativo. Utilizza questo campo per scegliere come target DataStore specifici all'interno del motore. Se vuoto, la ricerca viene applicata a tutti i Data Store associati al motore. |
filter |
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 ( |
| Campi | |
|---|---|
dataStores[] |
Obbligatorio. Il datastore in cui viene applicata la configurazione del boosting. Nome completo della risorsa DataStore, ad esempio projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}. |
spec[] |
Obbligatorio. Un elenco di specifiche di boosting. |
BoostSpec
| Rappresentazione JSON |
|---|
{
"conditionBoostSpecs": [
{
object ( |
| Campi | |
|---|---|
conditionBoostSpecs[] |
Obbligatorio. Un elenco di specifiche di boosting. |
ConditionBoostSpec
| Rappresentazione JSON |
|---|
{
"condition": string,
"boost": number,
"boostControlSpec": {
object ( |
| Campi | |
|---|---|
condition |
Obbligatorio. Un'espressione che specifica una condizione di aumento. La sintassi è la stessa delle espressioni di filtro. Al momento, l'unica condizione supportata è un elenco di codici lingua BCP-47. Esempio: per aumentare i suggerimenti nelle lingue inglese o francese: (lang_code: ANY("en", "fr")) |
boost |
Facoltativo. L'intensità del boost, che deve essere compresa tra -1 e 1. Un boosting negativo indica una retrocessione. Il valore predefinito è 0.0. Se il boosting 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 il valore viene impostato su -1.0, i suggerimenti vengono declassati in modo significativo. Tuttavia, potrebbero comunque essere mostrati altri suggerimenti pertinenti. Se il valore è impostato su 0,0, non viene applicato alcun boost. La condizione di incremento viene ignorata. |
boostControlSpec |
Facoltativo. Specifica complessa per il ranking personalizzato in base al valore dell'attributo definito dal cliente. |
BoostControlSpec
| Rappresentazione JSON |
|---|
{ "fieldName": string, "attributeType": enum ( |
| Campi | |
|---|---|
fieldName |
Facoltativo. Il nome del campo il cui valore verrà utilizzato per determinare l'importo dell'aggiustamento. |
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, ad esempio attribute_value = numerical_field_value. Nel caso della freschezza, attribute_value = (time.now() - datetime_field_value). |
interpolationType |
Facoltativo. Il tipo di interpolazione da applicare per collegare i punti di controllo elencati di seguito. |
controlPoints[] |
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 |
Facoltativo. Può essere uno dei seguenti: 1. Il valore del campo numerico. 2. La specifica della durata per l'aggiornamento: il valore deve essere formattato come valore XSD |
boostAmount |
Facoltativo. Il valore compreso tra -1 e 1 in base al quale aumentare il punteggio se attribute_value restituisce il valore specificato sopra. |
ModalityConfig
| Rappresentazione JSON |
|---|
{ "modalityType": enum ( |
| Campi | |
|---|---|
modalityType |
Obbligatorio. Il tipo di modalità. |
rewriterConfig |
Facoltativo. La configurazione dello strumento di riscrittura. |
summarizationConfig |
Facoltativo. La configurazione del riepilogo. |
groundingConfig |
Facoltativo. La configurazione di messa a terra. |
RewriterConfig
| Rappresentazione JSON |
|---|
{
"modelSettings": {
object ( |
| Campi | |
|---|---|
modelSettings |
Obbligatorio. Configurazioni per il modello LLM. |
prompt |
Facoltativo. La definizione del prompt. Se non impostato, verrà utilizzato il prompt predefinito. |
disabled |
Facoltativo. Indica se il rewriter è disattivato. |
SummarizationConfig
| Rappresentazione JSON |
|---|
{
"modelSettings": {
object ( |
| Campi | |
|---|---|
modelSettings |
Facoltativo. Configurazioni per il modello LLM. |
prompt |
Facoltativo. La definizione del prompt. Se non impostato, verrà utilizzato il prompt predefinito. |
disabled |
Facoltativo. Indica se il riepilogo è disattivato. |
GroundingConfig
| Rappresentazione JSON |
|---|
{ "groundingLevel": number, "disabled": boolean } |
| Campi | |
|---|---|
groundingLevel |
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 una soglia per la fondatezza della risposta, il che significa che tutte le risposte con un punteggio di fondatezza inferiore alla soglia torneranno a restituire solo snippet pertinenti. Ad esempio, un livello 3 significa che il punteggio di fondatezza deve essere pari o superiore a 3 affinché la risposta venga restituita. |
disabled |
Facoltativo. Indica se la messa a terra è disattivata. |
PythonFunction
| Rappresentazione JSON |
|---|
{ "name": string, "pythonCode": string, "description": string } |
| Campi | |
|---|---|
name |
Facoltativo. Il nome della funzione Python da eseguire. Deve corrispondere al nome di una funzione Python definita nel codice Python. Sensibile alle maiuscole. Se il nome non viene fornito, verrà utilizzata la prima funzione definita nel codice Python. |
pythonCode |
Facoltativo. Il codice Python da eseguire per lo strumento. |
description |
Solo output. La descrizione della funzione Python, analizzata dalla docstring del codice Python. |
McpTool
| Rappresentazione JSON |
|---|
{ "name": string, "description": string, "inputSchema": { object ( |
| Campi | |
|---|---|
name |
Obbligatorio. Il nome dello strumento MCP. |
description |
Facoltativo. La descrizione dello strumento MCP. |
inputSchema |
Facoltativo. Lo schema degli argomenti di input dello strumento MCP. |
outputSchema |
Facoltativo. Lo schema degli argomenti di output dello strumento MCP. |
serverAddress |
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 HTTP in streaming. È uguale a server_address in McpToolset. Per ulteriori dettagli, consulta la pagina https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http. |
apiAuthentication |
Facoltativo. Informazioni di autenticazione necessarie per eseguire lo strumento sul server MCP. Per l'autenticazione con token di autenticazione, il token si applica solo all'esecuzione dello strumento, non agli strumenti di inserzione. Ciò richiede che gli strumenti possano essere elencati senza autenticazione. |
tlsConfig |
Facoltativo. La configurazione TLS. Include i certificati del server personalizzati che il client deve considerare attendibili. |
serviceDirectoryConfig |
Facoltativo. Configurazione di Service Directory per VPC-SC, utilizzata per risolvere i nomi dei servizi all'interno di un perimetro. |
FileSearchTool
| Rappresentazione JSON |
|---|
{
"corpusType": enum ( |
| Campi | |
|---|---|
corpusType |
Facoltativo. Il tipo di corpus. Il valore predefinito è FULLY_MANAGED. |
name |
Obbligatorio. Il nome dello strumento. |
description |
Facoltativo. La descrizione dello strumento. |
fileCorpus |
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 |
Obbligatorio. Il nome dello strumento di sistema. |
description |
Solo output. La descrizione dello strumento di sistema. |
WidgetTool
| Rappresentazione JSON |
|---|
{ "name": string, "description": string, "widgetType": enum ( |
| Campi | |
|---|---|
name |
Obbligatorio. Il nome visualizzato dello strumento widget. |
description |
Facoltativo. La descrizione dello strumento widget. |
widgetType |
Facoltativo. Il tipo di strumento widget. Se non specificato, il tipo predefinito sarà CUSTOMIZED. |
Campo unione input. L'input dello strumento widget. input può essere solo uno dei seguenti tipi: |
|
parameters |
Facoltativo. I parametri di input dello strumento widget. |
ToolFakeConfig
| Rappresentazione JSON |
|---|
{ "enableFakeMode": boolean, // Union field |
| Campi | |
|---|---|
enableFakeMode |
Facoltativo. Indica se lo strumento utilizza la modalità Falso. |
Campo unione tool_response. La risposta è statica o fornita da una funzione Python. tool_response può essere solo uno dei seguenti tipi: |
|
codeBlock |
Facoltativo. Blocco di codice che verrà eseguito al posto di una chiamata allo strumento reale. |
CodeBlock
| Rappresentazione JSON |
|---|
{ "pythonCode": string } |
| Campi | |
|---|---|
pythonCode |
Obbligatorio. Codice Python che verrà richiamato in modalità di simulazione dello strumento. Firma della funzione Python prevista: per intercettare tutte le chiamate di strumenti: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: per intercettare una chiamata di strumenti 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 ( |
| Campi | |
|---|---|
name |
Identificatore. L'identificatore univoco dell'esempio. Formato: |
displayName |
Obbligatorio. Nome visualizzato dell'esempio. |
description |
Facoltativo. Descrizione leggibile dell'esempio. |
entryAgent |
Facoltativo. L'agente che gestisce inizialmente la conversazione. Se non specificato, l'esempio rappresenta una conversazione gestita dall'agente principale. Formato: |
messages[] |
Facoltativo. L'insieme dei messaggi che compongono la conversazione. |
createTime |
Solo output. Timestamp di 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: |
updateTime |
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: |
invalid |
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 |
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. |
Messaggio
| Rappresentazione JSON |
|---|
{
"role": string,
"chunks": [
{
object ( |
| Campi | |
|---|---|
role |
Facoltativo. Il ruolo all'interno della conversazione, ad esempio utente, agente. |
chunks[] |
Facoltativo. Contenuto del messaggio come una serie di blocchi. |
eventTime |
Facoltativo. Timestamp di invio o ricezione del messaggio. Non deve essere utilizzato se il messaggio fa parte di un 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: |
Chunk
| Rappresentazione JSON |
|---|
{ // Union field |
| Campi | |
|---|---|
Campo unione data. Dividi i dati in blocchi. data può essere solo uno dei seguenti tipi: |
|
text |
Facoltativo. Dati di testo. |
transcript |
Facoltativo. Trascrizione associata all'audio. |
blob |
Facoltativo. Dati blob. |
payload |
Facoltativo. Dati di payload personalizzati. |
image |
Facoltativo. Dati immagine. |
toolCall |
Facoltativo. Richiesta di esecuzione dello strumento. |
toolResponse |
Facoltativo. Risposta all'esecuzione dello strumento. |
agentTransfer |
Facoltativo. Evento di trasferimento dell'agente. |
updatedVariables |
Una struct rappresenta le variabili aggiornate nella conversazione, identificate dai nomi delle variabili. |
defaultVariables |
Una struct rappresenta le variabili predefinite all'inizio della conversazione, identificate dai nomi delle variabili. |
Blob
| Rappresentazione JSON |
|---|
{ "mimeType": string, "data": string } |
| Campi | |
|---|---|
mimeType |
Obbligatorio. Il tipo MIME standard IANA dei dati di origine. |
data |
Obbligatorio. Byte non elaborati del blob. Una stringa con codifica in base64. |
Immagine
| Rappresentazione JSON |
|---|
{ "mimeType": string, "data": string } |
| Campi | |
|---|---|
mimeType |
Obbligatorio. Il tipo MIME standard IANA dei dati di origine. I tipi di immagini supportati includono: * image/png * image/jpeg * image/webp |
data |
Obbligatorio. Byte non elaborati dell'immagine. Una stringa con codifica in base64. |
ToolCall
| Rappresentazione JSON |
|---|
{ "id": string, "displayName": string, "args": { object }, // Union field |
| Campi | |
|---|---|
id |
Facoltativo. L'identificatore univoco della chiamata allo strumento. Se compilato, il client deve restituire il risultato dell'esecuzione con l'ID corrispondenza in |
displayName |
Solo output. Nome visualizzato dello strumento. |
args |
Facoltativo. I parametri e i valori di input per lo strumento in formato oggetto JSON. |
Campo unione tool_identifier. L'identificatore dello strumento da eseguire. Può trattarsi di uno strumento persistente o di uno strumento di un insieme di strumenti. tool_identifier può essere solo uno dei seguenti tipi: |
|
tool |
Facoltativo. Il nome dello strumento da eseguire. Formato: |
toolsetTool |
Facoltativo. Lo strumento del toolset da eseguire. |
ToolsetTool
| Rappresentazione JSON |
|---|
{ "toolset": string, "toolId": string } |
| Campi | |
|---|---|
toolset |
Obbligatorio. Il nome della risorsa del Toolset da cui deriva questo strumento. Formato: |
toolId |
Facoltativo. L'ID dello strumento per filtrare gli strumenti per cui recuperare lo schema. |
ToolResponse
| Rappresentazione JSON |
|---|
{ "id": string, "displayName": string, "response": { object }, // Union field |
| Campi | |
|---|---|
id |
Facoltativo. L'ID corrispondente di |
displayName |
Solo output. Nome visualizzato dello strumento. |
response |
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. |
Campo unione tool_identifier. L'identificatore dello strumento eseguito. Può trattarsi di uno strumento persistente o di uno strumento di un insieme di strumenti. tool_identifier può essere solo uno dei seguenti tipi: |
|
tool |
Facoltativo. Il nome dello strumento da eseguire. Formato: |
toolsetTool |
Facoltativo. Lo strumento del toolset che è stato eseguito. |
AgentTransfer
| Rappresentazione JSON |
|---|
{ "targetAgent": string, "displayName": string } |
| Campi | |
|---|---|
targetAgent |
Obbligatorio. L'agente a cui viene trasferita la conversazione. L'agente gestirà la conversazione da questo punto in poi. Formato: |
displayName |
Solo output. Il nome visualizzato dell'agente. |
Guardrail
| Rappresentazione JSON |
|---|
{ "name": string, "displayName": string, "description": string, "enabled": boolean, "action": { object ( |
| Campi | |
|---|---|
name |
Identificatore. L'identificatore univoco della barriera protettiva. Formato: |
displayName |
Obbligatorio. Nome visualizzato della barriera protettiva. |
description |
Facoltativo. Descrizione della barriera protettiva. |
enabled |
Facoltativo. Indica se la barriera protettiva è attiva. |
action |
Facoltativo. Azione da intraprendere quando viene attivata la protezione. |
createTime |
Solo output. Timestamp di creazione della barriera protettiva. 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: |
updateTime |
Solo output. Timestamp dell'ultimo aggiornamento della barriera protettiva. 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: |
etag |
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. |
Campo unione guardrail_type. Tipo di guardrail. guardrail_type può essere solo uno dei seguenti tipi: |
|
contentFilter |
Facoltativo. Barriera protettiva che impedisce l'utilizzo di determinati contenuti nella conversazione. |
llmPromptSecurity |
Facoltativo. Barriera protettiva che blocca la conversazione se il prompt viene considerato non sicuro in base alla classificazione LLM. |
llmPolicy |
Facoltativo. Barriera protettiva che blocca la conversazione se la risposta dell'LLM viene considerata una violazione delle norme in base alla classificazione dell'LLM. |
modelSafety |
Facoltativo. Barriera protettiva che blocca la conversazione se la risposta del LLM è considerata non sicura in base alle impostazioni di sicurezza del modello. |
codeCallback |
Facoltativo. Barriera protettiva che blocca potenzialmente la conversazione in base al risultato dell'esecuzione del callback. |
ContentFilter
| Rappresentazione JSON |
|---|
{
"bannedContents": [
string
],
"bannedContentsInUserInput": [
string
],
"bannedContentsInAgentResponse": [
string
],
"matchType": enum ( |
| Campi | |
|---|---|
bannedContents[] |
Facoltativo. Elenco di frasi vietate. Si applica sia agli input dell'utente sia alle risposte dell'agente. |
bannedContentsInUserInput[] |
Facoltativo. Elenco di frasi vietate. Si applica solo agli input degli utenti. |
bannedContentsInAgentResponse[] |
Facoltativo. Elenco di frasi vietate. Si applica solo alle risposte degli agenti. |
matchType |
Obbligatorio. Tipo di corrispondenza per il filtro dei contenuti. |
disregardDiacritics |
Facoltativo. Se true, i segni diacritici vengono ignorati durante la ricerca di corrispondenze. |
LlmPromptSecurity
| Rappresentazione JSON |
|---|
{ "failOpen": boolean, // Union field |
| Campi | |
|---|---|
failOpen |
Facoltativo. Determina il comportamento quando la barriera di protezione rileva un errore del modello linguistico di grandi dimensioni. - Se true: la barriera di protezione viene bypassata. - Se il valore è false (impostazione predefinita), il guardrail viene attivato/bloccato. Nota: se viene fornita una norma personalizzata, questo campo viene ignorato a favore della configurazione "fail_open" della norma. |
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 |
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" al suo interno verrà compilato dal server nella risposta. |
customPolicy |
Facoltativo. Utilizza una LlmPolicy definita dall'utente per configurare la barriera di sicurezza. |
DefaultSecuritySettings
| Rappresentazione JSON |
|---|
{ "defaultPromptTemplate": string } |
| Campi | |
|---|---|
defaultPromptTemplate |
Solo output. Il modello di prompt predefinito utilizzato dal sistema. Questo campo viene visualizzato per mostrare all'utente il prompt utilizzato dal sistema per impostazione predefinita. È OUTPUT_ONLY. |
LlmPolicy
| Rappresentazione JSON |
|---|
{ "maxConversationMessages": integer, "modelSettings": { object ( |
| Campi | |
|---|---|
maxConversationMessages |
Facoltativo. Quando controlli questa norma, considera gli ultimi "n" messaggi della conversazione. Se non viene impostato, viene utilizzato un valore predefinito di 10. |
modelSettings |
Facoltativo. Impostazioni del modello. |
prompt |
Obbligatorio. Prompt delle norme. |
policyScope |
Obbligatorio. Definisce quando applicare il controllo delle norme durante la conversazione. Se impostato su |
failOpen |
Facoltativo. Se si verifica un errore durante il controllo delle norme, non eseguire l'operazione e non attivare la protezione. |
allowShortUtterance |
Facoltativo. Per impostazione predefinita, il controllo delle norme LLM viene ignorato per le espressioni brevi. Se attivi questa impostazione, il controllo delle norme viene applicato a tutte le espressioni, incluse quelle che normalmente verrebbero ignorate. |
ModelSafety
| Rappresentazione JSON |
|---|
{
"safetySettings": [
{
object ( |
| Campi | |
|---|---|
safetySettings[] |
Obbligatorio. Elenco delle impostazioni di sicurezza. |
SafetySetting
| Rappresentazione JSON |
|---|
{ "category": enum ( |
| Campi | |
|---|---|
category |
Obbligatorio. La categoria del danno. |
threshold |
Obbligatorio. Soglia di blocco dei contenuti dannosi. |
CodeCallback
| Rappresentazione JSON |
|---|
{ "beforeAgentCallback": { object ( |
| Campi | |
|---|---|
beforeAgentCallback |
Facoltativo. Il callback da eseguire prima di chiamare l'agente. Ogni funzione di callback deve restituire una struttura (ad es. un dizionario 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 |
Facoltativo. Il callback da eseguire dopo la chiamata all'agente. Ogni funzione di callback deve restituire una struttura (ad es. un dizionario 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 |
Facoltativo. Il callback da eseguire prima della chiamata al modello. Se vengono effettuate più chiamate al modello, il callback verrà eseguito più volte. Ogni funzione di callback deve restituire una struttura (ad es. un dizionario 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 |
Facoltativo. Il callback da eseguire dopo la chiamata al modello. Se vengono effettuate più chiamate al modello, il callback verrà eseguito più volte. Ogni funzione di callback deve restituire una struttura (ad es. un dizionario o un oggetto) contenente almeno: - "decision": "OK" o "TRIGGER". - "reason": una stringa che spiega la decisione. Una decisione "TRIGGER" potrebbe interrompere l'ulteriore elaborazione. |
TriggerAction
| Rappresentazione JSON |
|---|
{ // Union field |
| Campi | |
|---|---|
Campo unione action. L'azione da intraprendere. action può essere solo uno dei seguenti tipi: |
|
respondImmediately |
Facoltativo. Rispondere immediatamente con una risposta preconfigurata. |
transferAgent |
Facoltativo. Trasferire la conversazione a un altro agente. |
generativeAnswer |
Facoltativo. Rispondi con una risposta generativa. |
RespondImmediately
| Rappresentazione JSON |
|---|
{
"responses": [
{
object ( |
| Campi | |
|---|---|
responses[] |
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 |
Obbligatorio. Testo con cui l'agente deve rispondere. |
disabled |
Facoltativo. Indica se la risposta è disattivata. Le risposte disattivate non vengono utilizzate dall'agente. |
TransferAgent
| Rappresentazione JSON |
|---|
{ "agent": string } |
| Campi | |
|---|---|
agent |
Obbligatorio. Il nome dell'agente a cui trasferire la conversazione. L'agente deve trovarsi nella stessa app dell'agente attuale. Formato: |
GenerativeAnswer
| Rappresentazione JSON |
|---|
{ "prompt": string } |
| Campi | |
|---|---|
prompt |
Obbligatorio. Il prompt da utilizzare per la risposta generativa. |
Toolset
| Rappresentazione JSON |
|---|
{ "name": string, "displayName": string, "description": string, "createTime": string, "updateTime": string, "etag": string, "executionType": enum ( |
| Campi | |
|---|---|
name |
Identificatore. L'identificatore univoco del set di strumenti. Formato: |
displayName |
Facoltativo. Il nome visualizzato del toolset. Deve essere univoco all'interno della stessa app. |
description |
Facoltativo. La descrizione del set di strumenti. |
createTime |
Solo output. Timestamp di creazione del toolset. 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: |
updateTime |
Solo output. Timestamp dell'ultimo aggiornamento del toolset. 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: |
etag |
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 |
Facoltativo. Il tipo di esecuzione degli strumenti nel toolset. |
toolFakeConfig |
Facoltativo. Configurazione del comportamento degli strumenti in modalità simulata. |
Campo unione toolset_type. Il tipo di toolset. toolset_type può essere solo uno dei seguenti tipi: |
|
mcpToolset |
Facoltativo. Un insieme di strumenti che contiene un elenco di strumenti offerti dal server MCP. |
openApiToolset |
Facoltativo. Un insieme di strumenti che contiene un elenco di strumenti definiti da uno schema OpenAPI. |
connectorToolset |
Facoltativo. Un insieme di strumenti che genera strumenti da una connessione Integration Connectors. |
McpToolset
| Rappresentazione JSON |
|---|
{ "serverAddress": string, "apiAuthentication": { object ( |
| Campi | |
|---|---|
serverAddress |
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 HTTP in streaming. Per ulteriori dettagli, consulta la pagina https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http. |
apiAuthentication |
Facoltativo. Informazioni di autenticazione necessarie per accedere agli strumenti ed eseguire uno strumento sul server MCP. Per l'autenticazione con token di autenticazione, il token si applica solo all'esecuzione dello strumento, non agli strumenti di inserzione. Ciò richiede che gli strumenti possano essere elencati senza autenticazione. |
serviceDirectoryConfig |
Facoltativo. Configurazione di Service Directory per VPC-SC, utilizzata per risolvere i nomi dei servizi all'interno di un perimetro. |
tlsConfig |
Facoltativo. La configurazione TLS. Include i certificati del server personalizzati che il client deve considerare attendibili. |
OpenApiToolset
| Rappresentazione JSON |
|---|
{ "openApiSchema": string, "apiAuthentication": { object ( |
| Campi | |
|---|---|
openApiSchema |
Obbligatorio. Lo schema OpenAPI del set di strumenti. |
apiAuthentication |
Facoltativo. Informazioni di autenticazione richieste dall'API. |
tlsConfig |
Facoltativo. La configurazione TLS. Include i certificati del server personalizzati |
serviceDirectoryConfig |
Facoltativo. Configurazione di Service Directory. |
ignoreUnknownFields |
Facoltativo. Se il valore è true, l'agente ignorerà i campi sconosciuti nella risposta API per tutte le operazioni definite nello schema OpenAPI. |
url |
Facoltativo. L'URL del server dello schema Open API. Questo campo viene impostato solo nei toolset 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 ( |
| Campi | |
|---|---|
connection |
Obbligatorio. Il nome completo della risorsa della connessione Integration Connectors a cui viene fatto riferimento. Formato: |
authConfig |
Facoltativo. Configura la gestione dell'autenticazione in Integration Connectors. Per impostazione predefinita, un'autenticazione amministratore viene trasmessa nelle richieste dell'API Integration Connectors. Puoi ignorarlo con una configurazione di autenticazione dell'utente finale diversa. Nota: per specificare una configurazione EUC qui, l'override dell'autenticazione deve essere abilitato per la connessione. In caso contrario, la creazione del Toolset non riuscirà. Consulta: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override |
connectorActions[] |
Obbligatorio. L'elenco delle azioni/operazioni sulle entità del connettore per cui generare gli strumenti. |
Schema di output
In Customer Engagement Suite (CES), una versione dell'app è un'istantanea dell'app in un momento specifico. È immutabile e non può essere modificato una volta creato.
AppVersion
| Rappresentazione JSON |
|---|
{
"name": string,
"displayName": string,
"description": string,
"creator": string,
"createTime": string,
"snapshot": {
object ( |
| Campi | |
|---|---|
name |
Identificatore. L'identificatore univoco della versione dell'app. Formato: |
displayName |
Facoltativo. Il nome visualizzato della versione dell'app. |
description |
Facoltativo. La descrizione della versione dell'app. |
creator |
Solo output. Email dell'utente che ha creato la versione dell'app. |
createTime |
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: |
snapshot |
Solo output. Lo snapshot dell'app al momento della creazione della versione. |
etag |
Solo output. 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. |
Timestamp
| Rappresentazione JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Campi | |
|---|---|
seconds |
Rappresenta i secondi di tempo UTC a partire dall'epoca Unix 1970-01-01T00:00:00Z. Deve essere compreso tra -62135596800 e 253402300799 inclusi (corrispondenti a 0001-01-01T00:00:00Z e 9999-12-31T23:59:59Z). |
nanos |
Frazioni di secondo non negative con risoluzione in nanosecondi. Questo campo è la parte in nanosecondi della durata, non un'alternativa ai secondi. I valori negativi dei secondi con frazioni devono comunque avere valori non negativi dei nanosecondi che vengono conteggiati in avanti nel tempo. Deve essere compreso tra 0 e 999.999.999 inclusi. |
AppSnapshot
| Rappresentazione JSON |
|---|
{ "app": { object ( |
| Campi | |
|---|---|
app |
Facoltativo. Le impostazioni di base per l'app. |
agents[] |
Facoltativo. Elenco degli agenti nell'app. |
tools[] |
Facoltativo. Elenco degli strumenti nell'app. |
examples[] |
Facoltativo. Elenco di esempi nell'app. |
guardrails[] |
Facoltativo. Elenco delle barriere protettive nell'app. |
toolsets[] |
Facoltativo. Elenco di toolset nell'app. |
App
| Rappresentazione JSON |
|---|
{ "name": string, "displayName": string, "description": string, "pinned": boolean, "rootAgent": string, "languageSettings": { object ( |
| Campi | |
|---|---|
name |
Identificatore. L'identificatore univoco dell'app. Formato: |
displayName |
Obbligatorio. Nome visualizzato dell'app. |
description |
Facoltativo. Descrizione dell'app leggibile. |
pinned |
Facoltativo. Indica se l'app è bloccata nell'elenco delle app. |
rootAgent |
Facoltativo. L'agente principale è l'entry point dell'app. Formato: |
languageSettings |
Facoltativo. Impostazioni della lingua dell'app. |
timeZoneSettings |
Facoltativo. Impostazioni del fuso orario dell'app. |
audioProcessingConfig |
Facoltativo. Configurazione dell'elaborazione audio dell'app. |
loggingSettings |
Facoltativo. Impostazioni di registrazione nel log dell'app. |
errorHandlingSettings |
Facoltativo. Impostazioni di gestione degli errori dell'app. |
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 |
Facoltativo. La modalità di esecuzione dello strumento per l'app. Se non viene fornita, il valore predefinito è PARALLEL. |
evaluationMetricsThresholds |
Facoltativo. Le soglie di valutazione per l'app. |
variableDeclarations[] |
Facoltativo. Le dichiarazioni delle variabili. |
predefinedVariableDeclarations[] |
Solo output. Le dichiarazioni delle variabili predefinite per l'app. |
globalInstruction |
Facoltativo. Istruzioni per tutti gli agenti nell'app. Puoi utilizzare questa istruzione per impostare un'identità o una personalità stabile per tutti gli agenti. |
guardrails[] |
Facoltativo. Elenco di misure di salvaguardia per l'app. Formato: |
dataStoreSettings |
Facoltativo. Le impostazioni del datastore per l'app. |
defaultChannelProfile |
Facoltativo. Il profilo del canale predefinito utilizzato dall'app. |
metadata |
Facoltativo. Metadati sull'app. Questo campo può essere utilizzato per memorizzare informazioni aggiuntive pertinenti ai dettagli o agli utilizzi previsti dell'app. Un oggetto contenente un elenco di coppie |
createTime |
Solo output. Timestamp di 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: |
updateTime |
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: |
etag |
Solo output. 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. |
deploymentCount |
Solo output. Numero di deployment nell'app. |
clientCertificateSettings |
Facoltativo. Le impostazioni predefinite del certificato client per l'app. |
locked |
Facoltativo. Indica se l'app è bloccata per le modifiche. Se l'app è bloccata, le modifiche alle risorse dell'app verranno rifiutate. |
LanguageSettings
| Rappresentazione JSON |
|---|
{ "defaultLanguageCode": string, "supportedLanguageCodes": [ string ], "enableMultilingualSupport": boolean, "fallbackAction": string } |
| Campi | |
|---|---|
defaultLanguageCode |
Facoltativo. Il codice lingua predefinito dell'app. |
supportedLanguageCodes[] |
Facoltativo. Elenco dei codici lingua supportati dall'app, oltre a |
enableMultilingualSupport |
Facoltativo. Consente il supporto multilingue. Se è true, gli agenti nell'app utilizzeranno istruzioni predefinite per migliorare la gestione dell'input multilingue. |
fallbackAction |
Facoltativo. L'azione da eseguire quando un agente riceve 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 risorsa completo di uno strumento, che attiva l'esecuzione di uno strumento specifico. - Un'azione di sistema predefinita, ad esempio "escalate" o "exit", che attiva un segnale |
TimeZoneSettings
| Rappresentazione JSON |
|---|
{ "timeZone": string } |
| Campi | |
|---|---|
timeZone |
Facoltativo. Il fuso orario dell'app dal database dei fusi orari, ad esempio: America/Los_Angeles, Europe/Paris. |
AudioProcessingConfig
| Rappresentazione JSON |
|---|
{ "synthesizeSpeechConfigs": { string: { object ( |
| Campi | |
|---|---|
synthesizeSpeechConfigs |
Facoltativo. Configurazione della sintesi della risposta dell'agente, mapping dal codice della lingua a 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 |
bargeInConfig |
Facoltativo. Configura il comportamento dell'agente per le attività di interruzione dell'utente. |
inactivityTimeout |
Facoltativo. La durata dell'inattività dell'utente (nessun comando vocale o interazione) prima che l'agente gli chieda di riprendere l'interazione. Se non viene impostato, l'agente non chiederà all'utente di riprendere l'interazione. Una durata in secondi con un massimo di nove cifre frazionarie, che termina con " |
ambientSoundConfig |
Facoltativo. Configurazione del suono ambientale da riprodurre con la risposta dell'agente sintetizzata, per migliorare la naturalezza della conversazione. |
SynthesizeSpeechConfigsEntry
| Rappresentazione JSON |
|---|
{
"key": string,
"value": {
object ( |
| Campi | |
|---|---|
key |
|
value |
|
SynthesizeSpeechConfig
| Rappresentazione JSON |
|---|
{ "voice": string, "speakingRate": number } |
| Campi | |
|---|---|
voice |
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 |
Facoltativo. La velocità di lettura nell'intervallo [0,25, 2,0]. 1.0 è la velocità nativa normale supportata dalla voce specifica. 2.0 è il doppio della velocità, mentre 0.5 è la metà della velocità. I valori al di fuori dell'intervallo [0,25, 2,0] restituiranno un errore. |
BargeInConfig
| Rappresentazione JSON |
|---|
{ "disableBargeIn": boolean, "bargeInAwareness": boolean } |
| Campi | |
|---|---|
disableBargeIn |
Facoltativo. Disattiva l'interruzione da parte dell'utente mentre l'agente sta parlando. Se è true, l'input utente durante la riproduzione della risposta dell'agente verrà ignorato. Deprecato: |
bargeInAwareness |
Facoltativo. Se abilitato, 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 negli scenari in cui le risposte dell'agente vengono visualizzate visivamente. |
Durata
| Rappresentazione JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Campi | |
|---|---|
seconds |
Secondi firmati dell'intervallo di tempo. Deve essere compreso tra -315.576.000.000 e +315.576.000.000 inclusi. Nota: questi limiti vengono calcolati in base a: 60 sec/min * 60 min/ora * 24 ore/giorno * 365,25 giorni/anno * 10.000 anni |
nanos |
Frazioni di secondo con segno con risoluzione in nanosecondi dell'intervallo di tempo. Le durate inferiori a un secondo sono rappresentate con un campo |
AmbientSoundConfig
| Rappresentazione JSON |
|---|
{ "volumeGainDb": number, // Union field |
| Campi | |
|---|---|
volumeGainDb |
Facoltativo. Guadagno di volume (in dB) del volume nativo normale supportato dal rumore ambientale, nell'intervallo [-96,0, 16,0]. Se non è impostato o è impostato su un valore di 0, 0 dB, verrà riprodotto con l'ampiezza del segnale nativo normale. Un valore di -6,0 dB verrà riprodotto a circa metà dell'ampiezza del segnale nativo normale. Un valore di +6,0 (dB) verrà riprodotto a un'ampiezza circa doppia rispetto a quella normale del segnale nativo. Ti consigliamo vivamente di non superare +10 (dB), in quanto di solito non si verifica un aumento effettivo del volume per valori superiori. |
Campo unione source. Rumore ambientale da riprodurre con la risposta dell'agente sintetizzata, per migliorare la naturalezza della conversazione. source può essere solo uno dei seguenti tipi: |
|
prebuiltAmbientNoise |
Facoltativo. Deprecato: |
gcsUri |
Facoltativo. Rumore ambientale come file WAV mono a 16 kHz archiviato in Cloud Storage. Nota: assicurati che il service agent CES |
prebuiltAmbientSound |
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" |
LoggingSettings
| Rappresentazione JSON |
|---|
{ "redactionConfig": { object ( |
| Campi | |
|---|---|
redactionConfig |
Facoltativo. Configurazione della modalità di oscuramento dei dati sensibili. |
audioRecordingConfig |
Facoltativo. Configurazione della modalità di registrazione delle interazioni audio. |
bigqueryExportSettings |
Facoltativo. Impostazioni per descrivere i comportamenti di esportazione BigQuery per l'app. Se abilitati, i dati delle conversazioni verranno esportati nelle tabelle BigQuery. |
cloudLoggingSettings |
Facoltativo. Impostazioni per descrivere i comportamenti di Cloud Logging per l'app. |
conversationLoggingSettings |
Facoltativo. Impostazioni per descrivere i comportamenti di registrazione delle conversazioni per l'app. |
evaluationAudioRecordingConfig |
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 |
Facoltativo. Impostazioni per descrivere i comportamenti di raccolta dei dati delle conversazioni per la pipeline di analisi LLM per l'app. |
RedactionConfig
| Rappresentazione JSON |
|---|
{ "enableRedaction": boolean, "inspectTemplate": string, "deidentifyTemplate": string } |
| Campi | |
|---|---|
enableRedaction |
Facoltativo. Se impostato su true, la redazione verrà applicata in vari scenari di logging, tra cui la cronologia delle conversazioni, Cloud Logging e la registrazione audio. |
inspectTemplate |
Facoltativo. Nome del modello di ispezione DLP per configurare il rilevamento dei tipi di dati sensibili. Formato: |
deidentifyTemplate |
Facoltativo. Nome del modello di anonimizzazione DLP per indicare come anonimizzare i contenuti. Formato: |
AudioRecordingConfig
| Rappresentazione JSON |
|---|
{ "gcsBucket": string, "gcsPathPrefix": string } |
| Campi | |
|---|---|
gcsBucket |
Facoltativo. Il bucket Cloud Storage in cui archiviare le registrazioni audio della sessione. L'URI deve iniziare con "gs://". Scegli una posizione del bucket che soddisfi i tuoi requisiti di residenza dei dati. Nota: se il bucket Cloud Storage si trova in un progetto diverso dall'app, devi concedere l'autorizzazione |
gcsPathPrefix |
Facoltativo. Il prefisso del percorso 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 |
BigQueryExportSettings
| Rappresentazione JSON |
|---|
{ "enabled": boolean, "project": string, "dataset": string } |
| Campi | |
|---|---|
enabled |
Facoltativo. Indica se l'esportazione in BigQuery è attivata. |
project |
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 dall'app, devi concedere il ruolo |
dataset |
Facoltativo. Il set di dati BigQuery in cui esportare i dati. |
CloudLoggingSettings
| Rappresentazione JSON |
|---|
{ "enableCloudLogging": boolean } |
| Campi | |
|---|---|
enableCloudLogging |
Facoltativo. Se abilitare Cloud Logging per le sessioni. |
ConversationLoggingSettings
| Rappresentazione JSON |
|---|
{ "disableConversationLogging": boolean } |
| Campi | |
|---|---|
disableConversationLogging |
Facoltativo. Se disattivare la registrazione delle conversazioni per le sessioni. |
MetricAnalysisSettings
| Rappresentazione JSON |
|---|
{ "llmMetricsOptedOut": boolean } |
| Campi | |
|---|---|
llmMetricsOptedOut |
Facoltativo. Se raccogliere i dati delle conversazioni per le metriche di analisi LLM. Se il valore è true, i dati delle conversazioni non verranno raccolti per le metriche di analisi LLM; in caso contrario, verranno raccolti. |
ErrorHandlingSettings
| Rappresentazione JSON |
|---|
{
"errorHandlingStrategy": enum ( |
| Campi | |
|---|---|
errorHandlingStrategy |
Facoltativo. La strategia da utilizzare per la gestione degli errori. |
ModelSettings
| Rappresentazione JSON |
|---|
{ "model": string, // Union field |
| Campi | |
|---|---|
model |
Facoltativo. Il modello LLM che l'agente deve utilizzare. Se non è impostato, l'agente erediterà il modello dall'agente principale. |
Campo unione
|
|
temperature |
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. Le temperature più alte producono risposte più creative. |
EvaluationMetricsThresholds
| Rappresentazione JSON |
|---|
{ "goldenEvaluationMetricsThresholds": { object ( |
| Campi | |
|---|---|
goldenEvaluationMetricsThresholds |
Facoltativo. Le soglie delle metriche di valutazione secondo regole d'oro. |
hallucinationMetricBehavior |
Facoltativo. Deprecato: utilizza |
goldenHallucinationMetricBehavior |
Facoltativo. Il comportamento della metrica delle allucinazioni per le valutazioni di riferimento. |
scenarioHallucinationMetricBehavior |
Facoltativo. Il comportamento della metrica di allucinazione per le valutazioni degli scenari. |
GoldenEvaluationMetricsThresholds
| Rappresentazione JSON |
|---|
{ "turnLevelMetricsThresholds": { object ( |
| Campi | |
|---|---|
turnLevelMetricsThresholds |
Facoltativo. Le soglie delle metriche a livello di turno. |
expectationLevelMetricsThresholds |
Facoltativo. Le soglie delle metriche del livello di aspettativa. |
toolMatchingSettings |
Facoltativo. Le impostazioni di corrispondenza dello strumento. Una chiamata allo strumento aggiuntiva è una chiamata allo strumento presente nell'esecuzione, ma che non corrisponde ad alcuna chiamata allo strumento nell'aspettativa di riferimento. |
TurnLevelMetricsThresholds
| Rappresentazione JSON |
|---|
{ "semanticSimilarityChannel": enum ( |
| Campi | |
|---|---|
semanticSimilarityChannel |
Facoltativo. Il canale di similarità semantica da utilizzare per la valutazione. |
Campo unione
|
|
semanticSimilaritySuccessThreshold |
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
|
|
overallToolInvocationCorrectnessThreshold |
Facoltativo. La soglia di successo per la correttezza complessiva dell'invocazione dello strumento. Deve essere un numero in virgola mobile compreso tra 0 e 1. Il valore predefinito è 1.0. |
ExpectationLevelMetricsThresholds
| Rappresentazione JSON |
|---|
{ // Union field |
| Campi | |
|---|---|
Campo unione
|
|
toolInvocationParameterCorrectnessThreshold |
Facoltativo. La soglia di successo per la correttezza dei parametri di chiamata dei singoli strumenti. Deve essere un numero in virgola mobile compreso tra 0 e 1. Il valore predefinito è 1.0. |
ToolMatchingSettings
| Rappresentazione JSON |
|---|
{
"extraToolCallBehavior": enum ( |
| Campi | |
|---|---|
extraToolCallBehavior |
Facoltativo. Comportamento per le chiamate di strumenti aggiuntivi. Il valore predefinito è FAIL. |
VariableDeclaration
| Rappresentazione JSON |
|---|
{
"name": string,
"description": string,
"schema": {
object ( |
| Campi | |
|---|---|
name |
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 |
Obbligatorio. La descrizione della variabile. |
schema |
Obbligatorio. Lo schema della variabile. |
Schema
| Rappresentazione JSON |
|---|
{ "type": enum ( |
| Campi | |
|---|---|
type |
Obbligatorio. Il tipo di dati. |
properties |
Facoltativo. Proprietà di Type.OBJECT. Un oggetto contenente un elenco di coppie |
required[] |
Facoltativo. Proprietà obbligatorie di Type.OBJECT. |
description |
Facoltativo. La descrizione dei dati. |
items |
Facoltativo. Schema degli elementi di Type.ARRAY. |
nullable |
Facoltativo. Indica se il valore può essere null. |
uniqueItems |
Facoltativo. Indica che gli elementi nell'array devono essere univoci. Si applica solo a TYPE.ARRAY. |
prefixItems[] |
Facoltativo. Schemi degli elementi iniziali di Type.ARRAY. |
additionalProperties |
Facoltativo. Può essere un valore booleano o un oggetto e controlla la presenza di proprietà aggiuntive. |
anyOf[] |
Facoltativo. Il valore deve essere convalidato rispetto a uno o più sottoschema nell'elenco. |
enum[] |
Facoltativo. Valori possibili 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 di appartamento come : {type:INTEGER, format:enum, enum:["101", "201", "301"]} |
default |
Facoltativo. Valore predefinito dei dati. |
ref |
Facoltativo. Consente riferimenti indiretti tra i nodi dello schema. Il valore deve essere un riferimento valido a un elemento secondario della radice Ad esempio, lo schema seguente definisce un riferimento a un nodo dello schema denominato "Pet": Il valore della proprietà "pet" è un riferimento al nodo dello schema denominato "Pet". Per maggiori dettagli, visita la pagina https://json-schema.org/understanding-json-schema/structuring. |
defs |
Facoltativo. Una mappa delle definizioni da utilizzare per Un oggetto contenente un elenco di coppie |
title |
Facoltativo. Il titolo dello schema. |
minItems |
Facoltativo. Numero minimo di elementi per Type.ARRAY. |
maxItems |
Facoltativo. Numero massimo di elementi per Type.ARRAY. |
Campo unione
|
|
minimum |
Facoltativo. Valore minimo per Type.INTEGER e Type.NUMBER. |
Campo unione
|
|
maximum |
Facoltativo. Valore massimo per Type.INTEGER e Type.NUMBER. |
PropertiesEntry
| Rappresentazione JSON |
|---|
{
"key": string,
"value": {
object ( |
| Campi | |
|---|---|
key |
|
value |
|
Valore
| Rappresentazione JSON |
|---|
{ // Union field |
| Campi | |
|---|---|
Campo unione kind. Il tipo di valore. kind può essere solo uno dei seguenti tipi: |
|
nullValue |
Rappresenta un valore null. |
numberValue |
Rappresenta un valore double. |
stringValue |
Rappresenta un valore stringa. |
boolValue |
Rappresenta un valore booleano. |
structValue |
Rappresenta un valore strutturato. |
listValue |
Rappresenta un |
Struct
| Rappresentazione JSON |
|---|
{ "fields": { string: value, ... } } |
| Campi | |
|---|---|
fields |
Mappa non ordinata di valori con tipo dinamico. Un oggetto contenente un elenco di coppie |
FieldsEntry
| Rappresentazione JSON |
|---|
{ "key": string, "value": value } |
| Campi | |
|---|---|
key |
|
value |
|
ListValue
| Rappresentazione JSON |
|---|
{ "values": [ value ] } |
| Campi | |
|---|---|
values[] |
Campo ripetuto di valori con tipo dinamico. |
DefsEntry
| Rappresentazione JSON |
|---|
{
"key": string,
"value": {
object ( |
| Campi | |
|---|---|
key |
|
value |
|
DataStoreSettings
| Rappresentazione JSON |
|---|
{
"engines": [
{
object ( |
| Campi | |
|---|---|
engines[] |
Solo output. I motori dell'app. |
Motore
| Rappresentazione JSON |
|---|
{
"name": string,
"type": enum ( |
| Campi | |
|---|---|
name |
Solo output. Il nome della risorsa del motore. Formato: |
type |
Solo output. Il tipo di motore. |
ChannelProfile
| Rappresentazione JSON |
|---|
{ "profileId": string, "channelType": enum ( |
| Campi | |
|---|---|
profileId |
Facoltativo. L'identificatore univoco del profilo del canale. |
channelType |
Facoltativo. Il tipo di profilo del canale. |
personaProperty |
Facoltativo. La proprietà della persona del profilo del canale. |
disableDtmf |
Facoltativo. Indica se disattivare la tecnologia multifrequenza a due toni (DTMF). |
disableBargeInControl |
Facoltativo. Se disattivare il controllo di interruzione 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. |
webWidgetConfig |
Facoltativo. La configurazione del widget web. |
noiseSuppressionLevel |
Facoltativo. Il livello di eliminazione del rumore del profilo del canale. I valori disponibili sono "low", "moderate", "high", "very_high". |
PersonaProperty
| Rappresentazione JSON |
|---|
{
"persona": enum ( |
| Campi | |
|---|---|
persona |
Facoltativo. La personalità del canale. |
WebWidgetConfig
| Rappresentazione JSON |
|---|
{ "modality": enum ( |
| Campi | |
|---|---|
modality |
Facoltativo. La modalità del widget web. |
theme |
Facoltativo. Il tema del widget web. |
webWidgetTitle |
Facoltativo. Il titolo del widget web. |
securitySettings |
Facoltativo. Le impostazioni di sicurezza del widget web. |
SecuritySettings
| Rappresentazione JSON |
|---|
{ "enablePublicAccess": boolean, "enableOriginCheck": boolean, "allowedOrigins": [ string ], "enableRecaptcha": boolean } |
| Campi | |
|---|---|
enablePublicAccess |
Facoltativo. Indica se l'accesso pubblico al widget web è abilitato. Se |
enableOriginCheck |
Facoltativo. Indica se il controllo dell'origine per il widget web è abilitato. Se |
allowedOrigins[] |
Facoltativo. Le origini autorizzate a ospitare il widget web. Un'origine è definita dalla RFC 6454. Se è vuoto, sono consentite tutte le origini. Sono consentite massimo 100 origini. Esempio: "https://example.com" |
enableRecaptcha |
Facoltativo. Indica se la verifica reCAPTCHA per il widget web è abilitata. |
MetadataEntry
| Rappresentazione JSON |
|---|
{ "key": string, "value": string } |
| Campi | |
|---|---|
key |
|
value |
|
ClientCertificateSettings
| Rappresentazione JSON |
|---|
{ "tlsCertificate": string, "privateKey": string, "passphrase": string } |
| Campi | |
|---|---|
tlsCertificate |
Obbligatorio. Il certificato TLS codificato in formato PEM. Questa stringa deve includere le righe di intestazione iniziale e piè di pagina finale. |
privateKey |
Obbligatorio. Il nome della risorsa della versione secret di Secret Manager che archivia la chiave privata codificata in formato PEM. Formato: |
passphrase |
Facoltativo. Il nome della risorsa della versione del secret SecretManager che archivia la passphrase per decriptare la chiave privata. Deve essere lasciato non impostato se la chiave privata non è criptata. Formato: |
Agente
| Rappresentazione JSON |
|---|
{ "name": string, "displayName": string, "description": string, "modelSettings": { object ( |
| Campi | |
|---|---|
name |
Identificatore. L'identificatore univoco dell'agente. Formato: |
displayName |
Obbligatorio. Il nome visualizzato dell'agente. |
description |
Facoltativo. Descrizione dell'agente leggibile. |
modelSettings |
Facoltativo. Configurazioni per il modello LLM. |
instruction |
Facoltativo. Istruzioni per il modello LLM per guidare il comportamento dell'agente. |
tools[] |
Facoltativo. Elenco degli strumenti disponibili per l'agente. Formato: |
childAgents[] |
Facoltativo. Elenco degli agenti secondari nell'albero degli agenti. Formato: |
beforeAgentCallbacks[] |
Facoltativo. Le funzioni di callback da eseguire prima di chiamare l'agente. Le callback fornite vengono eseguite in sequenza nell'ordine esatto in cui sono elencate. Se un callback restituisce una risposta sostituita, l'esecuzione si interrompe e tutti i callback rimanenti vengono ignorati. |
afterAgentCallbacks[] |
Facoltativo. I callback da eseguire dopo la chiamata all'agente. Le callback fornite vengono eseguite in sequenza nell'ordine esatto in cui sono elencate. Se un callback restituisce una risposta sostituita, l'esecuzione si interrompe e tutti i callback rimanenti vengono ignorati. |
beforeModelCallbacks[] |
Facoltativo. I callback da eseguire prima di chiamare il modello. Se vengono effettuate più chiamate al modello, il callback verrà eseguito più volte. Le callback fornite vengono eseguite in sequenza nell'ordine esatto in cui sono elencate. Se un callback restituisce una risposta sostituita, l'esecuzione si interrompe e tutti i callback rimanenti vengono ignorati. |
afterModelCallbacks[] |
Facoltativo. I callback da eseguire dopo la chiamata al modello. Se vengono effettuate più chiamate al modello, il callback verrà eseguito più volte. Le callback fornite vengono eseguite in sequenza nell'ordine esatto in cui sono elencate. Se un callback restituisce una risposta sostituita, l'esecuzione si interrompe e tutti i callback rimanenti vengono ignorati. |
beforeToolCallbacks[] |
Facoltativo. Le funzioni di callback da eseguire prima di richiamare lo strumento. Se ci sono più chiamate di strumenti, il callback verrà eseguito più volte. Le callback fornite vengono eseguite in sequenza nell'ordine esatto in cui sono elencate. Se un callback restituisce una risposta sostituita, l'esecuzione si interrompe e tutti i callback rimanenti vengono ignorati. |
afterToolCallbacks[] |
Facoltativo. I callback da eseguire dopo l'invocazione dello strumento. Se ci sono più chiamate di strumenti, il callback verrà eseguito più volte. Le callback fornite vengono eseguite in sequenza nell'ordine esatto in cui sono elencate. Se un callback restituisce una risposta sostituita, l'esecuzione si interrompe e tutti i callback rimanenti vengono ignorati. |
createTime |
Solo output. Timestamp di 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: |
updateTime |
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: |
guardrails[] |
Facoltativo. Elenco delle barriere protettive per l'agente. Formato: |
etag |
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. |
toolsets[] |
Facoltativo. Elenco dei toolset per l'agente. |
generatedSummary |
Solo output. Se l'agente viene generato dall'assistente LLM, questo campo contiene un riepilogo descrittivo della generazione. |
transferRules[] |
Facoltativo. Regole di trasferimento degli agenti. Se corrispondono più regole, verrà utilizzata la prima nell'elenco. |
Campo unione agent_type. Il tipo di agente. agent_type può essere solo uno dei seguenti tipi: |
|
llmAgent |
Facoltativo. Il tipo di agente predefinito. |
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 dall'app, devi concedere |
RemoteDialogflowAgent
| Rappresentazione JSON |
|---|
{ "agent": string, "flowId": string, "environmentId": string, "inputVariableMapping": { string: string, ... }, "outputVariableMapping": { string: string, ... }, "respectResponseInterruptionSettings": boolean } |
| Campi | |
|---|---|
agent |
Obbligatorio. Il nome risorsa dell'agente Dialogflow. Formato: |
flowId |
Facoltativo. L'ID del flusso nell'agente Dialogflow. |
environmentId |
Facoltativo. L'ID ambiente dell'agente Dialogflow da utilizzare per l'esecuzione dell'agente. Se non specificato, verrà utilizzato l'ambiente bozza. |
inputVariableMapping |
Facoltativo. Il mapping 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 |
outputVariableMapping |
Facoltativo. Il mapping dei nomi dei parametri di sessione di Dialogflow ai nomi delle variabili dell'app da inviare di nuovo all'agente CES al termine dell'esecuzione dell'agente Dialogflow. Un oggetto contenente un elenco di coppie |
respectResponseInterruptionSettings |
Facoltativo. Indica se rispettare le impostazioni di interruzione a livello di messaggio configurate nell'agente Dialogflow.
|
InputVariableMappingEntry
| Rappresentazione JSON |
|---|
{ "key": string, "value": string } |
| Campi | |
|---|---|
key |
|
value |
|
OutputVariableMappingEntry
| Rappresentazione JSON |
|---|
{ "key": string, "value": string } |
| Campi | |
|---|---|
key |
|
value |
|
Callback
| Rappresentazione JSON |
|---|
{ "description": string, "disabled": boolean, "proactiveExecutionEnabled": boolean, // Union field |
| Campi | |
|---|---|
description |
Facoltativo. Descrizione leggibile del callback. |
disabled |
Facoltativo. Indica se il callback è disattivato. I callback disattivati vengono ignorati dall'agente. |
proactiveExecutionEnabled |
Facoltativo. Se abilitata, la richiamata verrà eseguita anche sugli output intermedi del modello. Questa impostazione ha effetto solo dopo il callback del modello. ATTIVARE CON CAUTELA. In genere, il callback del modello deve essere eseguito solo dopo aver ricevuto tutte le risposte del modello. L'attivazione dell'esecuzione proattiva può avere implicazioni negative sul costo e sulla latenza dell'esecuzione e deve essere attivata solo in rare situazioni. |
Campo unione callback. Il callback da eseguire. callback può essere solo uno dei seguenti tipi: |
|
pythonCode |
Obbligatorio. Il codice Python da eseguire per il callback. |
AgentToolset
| Rappresentazione JSON |
|---|
{ "toolset": string, "toolIds": [ string ] } |
| Campi | |
|---|---|
toolset |
Obbligatorio. Il nome della risorsa del toolset. Formato: |
toolIds[] |
Facoltativo. Gli ID degli strumenti per filtrare il set di strumenti. |
TransferRule
| Rappresentazione JSON |
|---|
{ "childAgent": string, "direction": enum ( |
| Campi | |
|---|---|
childAgent |
Obbligatorio. Il nome della risorsa dell'agente secondario a cui si applica la regola. Formato: |
direction |
Obbligatorio. La direzione del trasferimento. |
Campo unione rule_type. Il tipo di regola. rule_type può essere solo uno dei seguenti tipi: |
|
deterministicTransfer |
Facoltativo. Una regola che viene trasferita immediatamente all'agente di destinazione quando la condizione viene soddisfatta. |
disablePlannerTransfer |
Facoltativo. Regola che impedisce al pianificatore di trasferire la chiamata all'agente di destinazione. |
DeterministicTransfer
| Rappresentazione JSON |
|---|
{ // Union field |
| Campi | |
|---|---|
Campo unione condition_type. La condizione da valutare. condition_type può essere solo uno dei seguenti tipi: |
|
expressionCondition |
Facoltativo. Una regola che valuta una condizione dello stato della sessione. Se la condizione restituisce il valore true, il trasferimento viene eseguito. |
pythonCodeCondition |
Facoltativo. Una regola che utilizza il blocco di codice Python per valutare le condizioni. Se la condizione restituisce il valore true, il trasferimento viene eseguito. |
ExpressionCondition
| Rappresentazione JSON |
|---|
{ "expression": string } |
| Campi | |
|---|---|
expression |
Obbligatorio. La rappresentazione di stringa della condizione cloud.api.Expression. |
PythonCodeCondition
| Rappresentazione JSON |
|---|
{ "pythonCode": string } |
| Campi | |
|---|---|
pythonCode |
Obbligatorio. Il codice Python da eseguire. |
DisablePlannerTransfer
| Rappresentazione JSON |
|---|
{
"expressionCondition": {
object ( |
| Campi | |
|---|---|
expressionCondition |
Obbligatorio. Se la condizione restituisce true, il pianificatore non potrà essere trasferito all'agente di destinazione. |
Strumento
| Rappresentazione JSON |
|---|
{ "name": string, "displayName": string, "executionType": enum ( |
| Campi | |
|---|---|
name |
Identificatore. L'identificatore univoco dello strumento. Formato: -
|
displayName |
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 relativa proprietà |
executionType |
Facoltativo. Il tipo di esecuzione dello strumento. |
createTime |
Solo output. Timestamp di 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: |
updateTime |
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: |
etag |
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. |
generatedSummary |
Solo output. Se lo strumento è generato dall'assistente LLM, questo campo contiene un riepilogo descrittivo della generazione. |
toolFakeConfig |
Facoltativo. Configurazione del comportamento dello strumento in modalità simulata. |
Campo unione tool_type. Il tipo di strumento. tool_type può essere solo uno dei seguenti tipi: |
|
clientFunction |
Facoltativo. La funzione client. |
openApiTool |
Facoltativo. Lo strumento API aperto. |
googleSearchTool |
Facoltativo. Lo strumento di ricerca di Google. |
connectorTool |
Facoltativo. Lo strumento Integration Connector. |
dataStoreTool |
Facoltativo. Lo strumento datastore. |
pythonFunction |
Facoltativo. Lo strumento per le funzioni Python. |
mcpTool |
Facoltativo. Lo strumento MCP. Uno strumento MCP non può essere creato o aggiornato direttamente ed è gestito dal set di strumenti MCP. |
fileSearchTool |
Facoltativo. Lo strumento di ricerca dei file. |
systemTool |
Facoltativo. Lo strumento di sistema. |
widgetTool |
Facoltativo. Lo strumento widget. |
ClientFunction
| Rappresentazione JSON |
|---|
{ "name": string, "description": string, "parameters": { object ( |
| Campi | |
|---|---|
name |
Obbligatorio. Il nome della funzione. |
description |
Facoltativo. La descrizione della funzione. |
parameters |
Facoltativo. Lo schema dei parametri della funzione. |
response |
Facoltativo. Lo schema della risposta della funzione. |
OpenApiTool
| Rappresentazione JSON |
|---|
{ "openApiSchema": string, "name": string, "description": string, "apiAuthentication": { object ( |
| Campi | |
|---|---|
openApiSchema |
Obbligatorio. Lo schema OpenAPI in formato JSON o YAML. |
name |
Facoltativo. Il nome dello strumento. Se non viene fornito, il nome dello strumento verrà derivato dallo schema OpenAPI, da |
description |
Facoltativo. La descrizione dello strumento. Se non viene fornita, la descrizione dello strumento verrà derivata dallo schema OpenAPI, da |
apiAuthentication |
Facoltativo. Informazioni di autenticazione richieste dall'API. |
tlsConfig |
Facoltativo. La configurazione TLS. Include i certificati del server personalizzati di cui il client si fiderà. |
serviceDirectoryConfig |
Facoltativo. Configurazione di Service Directory. |
ignoreUnknownFields |
Facoltativo. Se il valore è true, l'agente ignorerà i campi sconosciuti nella risposta dell'API. |
url |
Facoltativo. L'URL del server dello schema Open API. Questo campo viene impostato solo negli 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. |
ApiAuthentication
| Rappresentazione JSON |
|---|
{ // Union field |
| Campi | |
|---|---|
Campo unione auth_config. La configurazione di autenticazione. auth_config può essere solo uno dei seguenti tipi: |
|
apiKeyConfig |
Facoltativo. Configurazione per l'autenticazione della chiave API. |
oauthConfig |
Facoltativo. Configurazione per OAuth. |
serviceAgentIdTokenAuthConfig |
Facoltativo. Configurazione per l'autenticazione con token ID generato dall'agente di servizio CES. |
serviceAccountAuthConfig |
Facoltativo. Configurazione per l'autenticazione del account di servizio. |
bearerTokenConfig |
Facoltativo. Configurazione per l'autenticazione con token di connessione. |
ApiKeyConfig
| Rappresentazione JSON |
|---|
{
"keyName": string,
"apiKeySecretVersion": string,
"requestLocation": enum ( |
| Campi | |
|---|---|
keyName |
Obbligatorio. Il nome del parametro o dell'intestazione della chiave API. Ad esempio, Se la richiesta API è "https://example.com/act?X-Api-Key= |
apiKeySecretVersion |
Obbligatorio. Il nome della risorsa della versione del secret di Secret Manager che archivia la chiave API. Formato: Nota: devi concedere il ruolo |
requestLocation |
Obbligatorio. Posizione della chiave nella richiesta. |
OAuthConfig
| Rappresentazione JSON |
|---|
{
"oauthGrantType": enum ( |
| Campi | |
|---|---|
oauthGrantType |
Obbligatorio. Tipi di autorizzazione con OAuth. |
clientId |
Obbligatorio. L'ID client del provider OAuth. |
clientSecretVersion |
Obbligatorio. Il nome della risorsa della versione del secret di Secret Manager che archivia il client secret. Formato: Nota: devi concedere il ruolo |
tokenEndpoint |
Obbligatorio. L'endpoint token nel provider OAuth da scambiare con un token di accesso. |
scopes[] |
Facoltativo. Gli ambiti OAuth da concedere. |
ServiceAccountAuthConfig
| Rappresentazione JSON |
|---|
{ "serviceAccount": string, "scopes": [ string ] } |
| Campi | |
|---|---|
serviceAccount |
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 All'account di servizio deve essere concesso il ruolo |
scopes[] |
Facoltativo. Gli ambiti OAuth da concedere. Se non specificato, viene utilizzato l'ambito predefinito |
BearerTokenConfig
| Rappresentazione JSON |
|---|
{ "token": string } |
| Campi | |
|---|---|
token |
Obbligatorio. Il token di connessione. Deve essere nel formato |
TlsConfig
| Rappresentazione JSON |
|---|
{
"caCerts": [
{
object ( |
| Campi | |
|---|---|
caCerts[] |
Obbligatorio. Specifica un elenco di certificati CA personalizzati consentiti per la verifica HTTPS. |
CaCert
| Rappresentazione JSON |
|---|
{ "displayName": string, "cert": string } |
| Campi | |
|---|---|
displayName |
Obbligatorio. Il nome dei certificati CA personalizzati consentiti. Può essere utilizzato per disambiguare i certificati CA personalizzati. |
cert |
Obbligatorio. I certificati CA personalizzati consentiti (in formato DER) per la verifica HTTPS. Esegue l'override dell'archivio attendibilità SSL predefinito. Se questo campo è vuoto o non specificato, CES utilizzerà l'archivio attendibilità predefinito di Google per verificare i certificati. Nota: 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 |
Obbligatorio. Il nome del servizio Service Directory. Formato: |
GoogleSearchTool
| Rappresentazione JSON |
|---|
{
"name": string,
"description": string,
"contextUrls": [
string
],
"preferredDomains": [
string
],
"excludeDomains": [
string
],
"promptConfig": {
object ( |
| Campi | |
|---|---|
name |
Obbligatorio. Il nome dello strumento. |
description |
Facoltativo. Descrizione dello scopo dello strumento. |
contextUrls[] |
Facoltativo. I contenuti verranno recuperati direttamente da questi URL per il contesto e la base. Esempio: "https://example.com/path.html". Sono consentiti massimo 20 URL. |
preferredDomains[] |
Facoltativo. Specifica i domini a cui limitare i risultati di ricerca. Esempio: "example.com", "another.site". È possibile specificare un massimo di 20 domini. |
excludeDomains[] |
Facoltativo. Elenco dei domini da escludere dai risultati di ricerca. Esempio: "example.com". È possibile escludere un massimo di 2000 domini. |
promptConfig |
Facoltativo. Istruzioni del prompt trasmesse al planner su come devono essere elaborati i risultati di ricerca per il testo e la voce. |
PromptConfig
| Rappresentazione JSON |
|---|
{ "textPrompt": string, "voicePrompt": string } |
| Campi | |
|---|---|
textPrompt |
Facoltativo. Definisce il prompt utilizzato per le istruzioni di sistema quando interagisci con l'agente nelle conversazioni di chat. Se non impostato, verrà utilizzato il prompt predefinito. |
voicePrompt |
Facoltativo. Definisce il prompt utilizzato per le istruzioni di sistema quando interagisci con l'agente nelle conversazioni vocali. Se non impostato, verrà utilizzato il prompt predefinito. |
ConnectorTool
| Rappresentazione JSON |
|---|
{ "connection": string, "action": { object ( |
| Campi | |
|---|---|
connection |
Obbligatorio. Il nome completo della risorsa della connessione Integration Connectors a cui viene fatto riferimento. Formato: |
action |
Obbligatorio. Azione da utilizzare per lo strumento. |
authConfig |
Facoltativo. Configura la gestione dell'autenticazione in Integration Connectors. Per impostazione predefinita, un'autenticazione amministratore viene trasmessa nelle richieste dell'API Integration Connectors. Puoi ignorarlo con una configurazione di autenticazione dell'utente finale diversa. Nota: per specificare una configurazione EUC qui, l'override dell'autenticazione deve essere abilitato nella connessione. In caso contrario, la creazione di ConnectorTool non riuscirà. Per i dettagli, vedi https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override. |
name |
Facoltativo. Il nome dello strumento che può essere utilizzato dall'agente per decidere se chiamare questo ConnectorTool. |
description |
Facoltativo. La descrizione dello strumento che può essere utilizzata dall'agente per decidere se chiamare questo ConnectorTool. |
Azione
| Rappresentazione JSON |
|---|
{ "inputFields": [ string ], "outputFields": [ string ], // Union field |
| Campi | |
|---|---|
inputFields[] |
Facoltativo. Campi dell'entità da utilizzare come input per l'operazione. Se non vengono specificati campi, verranno utilizzati tutti i campi dell'entità. |
outputFields[] |
Facoltativo. Campi dell'entità da restituire dall'operazione. Se non vengono specificati campi, vengono restituiti tutti i campi dell'entità. |
Campo unione action_spec. Specifica di un'azione da configurare per l'utilizzo dello strumento. action_spec può essere solo uno dei seguenti tipi: |
|
connectionActionId |
ID di un'azione di connessione da utilizzare per lo strumento. |
entityOperation |
Configurazione dell'operazione dell'entità da utilizzare per lo strumento. |
EntityOperation
| Rappresentazione JSON |
|---|
{
"entityId": string,
"operation": enum ( |
| Campi | |
|---|---|
entityId |
Obbligatorio. ID dell'entità. |
operation |
Obbligatorio. Operazione da eseguire sull'entità. |
EndUserAuthConfig
| Rappresentazione JSON |
|---|
{ // Union field |
| Campi | |
|---|---|
Campo unione auth_config. La configurazione di autenticazione. auth_config può essere solo uno dei seguenti tipi: |
|
oauth2AuthCodeConfig |
Autenticazione con codice di autorizzazione OAuth 2.0. |
oauth2JwtBearerConfig |
Autenticazione della concessione di autorizzazione OAuth 2.0 del profilo JWT. |
Oauth2AuthCodeConfig
| Rappresentazione JSON |
|---|
{ "oauthToken": string } |
| Campi | |
|---|---|
oauthToken |
Obbligatorio. Nome del parametro del token OAuth da trasferire. Deve essere nel formato |
Oauth2JwtBearerConfig
| Rappresentazione JSON |
|---|
{ "issuer": string, "subject": string, "clientKey": string } |
| Campi | |
|---|---|
issuer |
Obbligatorio. Nome del parametro dell'emittente da trasferire. Deve essere nel formato |
subject |
Obbligatorio. Nome del parametro oggetto da trasferire. Deve essere nel formato |
clientKey |
Obbligatorio. Nome del parametro client da trasferire. Deve essere nel formato |
DataStoreTool
| Rappresentazione JSON |
|---|
{ "name": string, "description": string, "boostSpecs": [ { object ( |
| Campi | |
|---|---|
name |
Obbligatorio. Il nome dello strumento datastore. |
description |
Facoltativo. La descrizione dello strumento. |
boostSpecs[] |
Facoltativo. Aumenta la specifica per aumentare la visibilità di determinati documenti. |
modalityConfigs[] |
Facoltativo. Le configurazioni della modalità per il datastore. |
filterParameterBehavior |
Facoltativo. Il comportamento del parametro di filtro. |
Campo unione search_source. Definisce l'origine di ricerca, ovvero un singolo datastore o un motore. search_source può essere solo uno dei seguenti tipi: |
|
dataStoreSource |
Facoltativo. Eseguire ricerche all'interno di un singolo DataStore specifico. |
engineSource |
Facoltativo. Cerca all'interno di un motore (potenzialmente in più datastore). |
DataStoreSource
| Rappresentazione JSON |
|---|
{
"filter": string,
"dataStore": {
object ( |
| Campi | |
|---|---|
filter |
Facoltativo. Specifica del filtro per il datastore. Consulta: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata |
dataStore |
Facoltativo. Il datastore. |
DataStore
| Rappresentazione JSON |
|---|
{ "name": string, "type": enum ( |
| Campi | |
|---|---|
name |
Obbligatorio. Nome completo della risorsa del datastore. Formato: |
type |
Solo output. Il tipo di datastore. Questo campo è di sola lettura e viene compilato dal server. |
documentProcessingMode |
Solo output. La modalità di elaborazione dei documenti per la connessione dell'datastore. Impostato solo per i datastore PUBLIC_WEB e UNSTRUCTURED. |
displayName |
Solo output. Il nome visualizzato del datastore. |
createTime |
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: |
connectorConfig |
Solo output. La configurazione del connettore per la connessione al datastore. |
ConnectorConfig
| Rappresentazione JSON |
|---|
{ "collection": string, "collectionDisplayName": string, "dataSource": string } |
| Campi | |
|---|---|
collection |
Il nome della risorsa della raccolta a cui appartiene il datastore. |
collectionDisplayName |
Nome visualizzato della raccolta a cui appartiene il datastore. |
dataSource |
Il nome dell'origine dati. Esempio: |
EngineSource
| Rappresentazione JSON |
|---|
{
"engine": string,
"dataStoreSources": [
{
object ( |
| Campi | |
|---|---|
engine |
Obbligatorio. Nome completo della risorsa del motore. Formato: |
dataStoreSources[] |
Facoltativo. Utilizza questo campo per scegliere come target DataStore specifici all'interno del motore. Se vuoto, la ricerca viene applicata a tutti i Data Store associati al motore. |
filter |
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 ( |
| Campi | |
|---|---|
dataStores[] |
Obbligatorio. Il datastore in cui viene applicata la configurazione del boosting. Nome completo della risorsa DataStore, ad esempio projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}. |
spec[] |
Obbligatorio. Un elenco di specifiche di boosting. |
BoostSpec
| Rappresentazione JSON |
|---|
{
"conditionBoostSpecs": [
{
object ( |
| Campi | |
|---|---|
conditionBoostSpecs[] |
Obbligatorio. Un elenco di specifiche di boosting. |
ConditionBoostSpec
| Rappresentazione JSON |
|---|
{
"condition": string,
"boost": number,
"boostControlSpec": {
object ( |
| Campi | |
|---|---|
condition |
Obbligatorio. Un'espressione che specifica una condizione di aumento. La sintassi è la stessa delle espressioni di filtro. Al momento, l'unica condizione supportata è un elenco di codici lingua BCP-47. Esempio: per aumentare i suggerimenti nelle lingue inglese o francese: (lang_code: ANY("en", "fr")) |
boost |
Facoltativo. L'intensità del boost, che deve essere compresa tra -1 e 1. Un boosting negativo indica una retrocessione. Il valore predefinito è 0.0. Se il boosting 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 il valore viene impostato su -1.0, i suggerimenti vengono declassati in modo significativo. Tuttavia, potrebbero comunque essere mostrati altri suggerimenti pertinenti. Se il valore è impostato su 0,0, non viene applicato alcun boost. La condizione di incremento viene ignorata. |
boostControlSpec |
Facoltativo. Specifica complessa per il ranking personalizzato in base al valore dell'attributo definito dal cliente. |
BoostControlSpec
| Rappresentazione JSON |
|---|
{ "fieldName": string, "attributeType": enum ( |
| Campi | |
|---|---|
fieldName |
Facoltativo. Il nome del campo il cui valore verrà utilizzato per determinare l'importo dell'aggiustamento. |
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, ad esempio attribute_value = numerical_field_value. Nel caso della freschezza, attribute_value = (time.now() - datetime_field_value). |
interpolationType |
Facoltativo. Il tipo di interpolazione da applicare per collegare i punti di controllo elencati di seguito. |
controlPoints[] |
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 |
Facoltativo. Può essere uno dei seguenti: 1. Il valore del campo numerico. 2. La specifica della durata per l'aggiornamento: il valore deve essere formattato come valore XSD |
boostAmount |
Facoltativo. Il valore compreso tra -1 e 1 in base al quale aumentare il punteggio se attribute_value restituisce il valore specificato sopra. |
ModalityConfig
| Rappresentazione JSON |
|---|
{ "modalityType": enum ( |
| Campi | |
|---|---|
modalityType |
Obbligatorio. Il tipo di modalità. |
rewriterConfig |
Facoltativo. La configurazione dello strumento di riscrittura. |
summarizationConfig |
Facoltativo. La configurazione del riepilogo. |
groundingConfig |
Facoltativo. La configurazione di messa a terra. |
RewriterConfig
| Rappresentazione JSON |
|---|
{
"modelSettings": {
object ( |
| Campi | |
|---|---|
modelSettings |
Obbligatorio. Configurazioni per il modello LLM. |
prompt |
Facoltativo. La definizione del prompt. Se non impostato, verrà utilizzato il prompt predefinito. |
disabled |
Facoltativo. Indica se il rewriter è disattivato. |
SummarizationConfig
| Rappresentazione JSON |
|---|
{
"modelSettings": {
object ( |
| Campi | |
|---|---|
modelSettings |
Facoltativo. Configurazioni per il modello LLM. |
prompt |
Facoltativo. La definizione del prompt. Se non impostato, verrà utilizzato il prompt predefinito. |
disabled |
Facoltativo. Indica se il riepilogo è disattivato. |
GroundingConfig
| Rappresentazione JSON |
|---|
{ "groundingLevel": number, "disabled": boolean } |
| Campi | |
|---|---|
groundingLevel |
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 una soglia per la fondatezza della risposta, il che significa che tutte le risposte con un punteggio di fondatezza inferiore alla soglia torneranno a restituire solo snippet pertinenti. Ad esempio, un livello 3 significa che il punteggio di fondatezza deve essere pari o superiore a 3 affinché la risposta venga restituita. |
disabled |
Facoltativo. Indica se la messa a terra è disattivata. |
PythonFunction
| Rappresentazione JSON |
|---|
{ "name": string, "pythonCode": string, "description": string } |
| Campi | |
|---|---|
name |
Facoltativo. Il nome della funzione Python da eseguire. Deve corrispondere al nome di una funzione Python definita nel codice Python. Sensibile alle maiuscole. Se il nome non viene fornito, verrà utilizzata la prima funzione definita nel codice Python. |
pythonCode |
Facoltativo. Il codice Python da eseguire per lo strumento. |
description |
Solo output. La descrizione della funzione Python, analizzata dalla docstring del codice Python. |
McpTool
| Rappresentazione JSON |
|---|
{ "name": string, "description": string, "inputSchema": { object ( |
| Campi | |
|---|---|
name |
Obbligatorio. Il nome dello strumento MCP. |
description |
Facoltativo. La descrizione dello strumento MCP. |
inputSchema |
Facoltativo. Lo schema degli argomenti di input dello strumento MCP. |
outputSchema |
Facoltativo. Lo schema degli argomenti di output dello strumento MCP. |
serverAddress |
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 HTTP in streaming. È uguale a server_address in McpToolset. Per ulteriori dettagli, consulta la pagina https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http. |
apiAuthentication |
Facoltativo. Informazioni di autenticazione necessarie per eseguire lo strumento sul server MCP. Per l'autenticazione con token di autenticazione, il token si applica solo all'esecuzione dello strumento, non agli strumenti di inserzione. Ciò richiede che gli strumenti possano essere elencati senza autenticazione. |
tlsConfig |
Facoltativo. La configurazione TLS. Include i certificati del server personalizzati che il client deve considerare attendibili. |
serviceDirectoryConfig |
Facoltativo. Configurazione di Service Directory per VPC-SC, utilizzata per risolvere i nomi dei servizi all'interno di un perimetro. |
FileSearchTool
| Rappresentazione JSON |
|---|
{
"corpusType": enum ( |
| Campi | |
|---|---|
corpusType |
Facoltativo. Il tipo di corpus. Il valore predefinito è FULLY_MANAGED. |
name |
Obbligatorio. Il nome dello strumento. |
description |
Facoltativo. La descrizione dello strumento. |
fileCorpus |
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 |
Obbligatorio. Il nome dello strumento di sistema. |
description |
Solo output. La descrizione dello strumento di sistema. |
WidgetTool
| Rappresentazione JSON |
|---|
{ "name": string, "description": string, "widgetType": enum ( |
| Campi | |
|---|---|
name |
Obbligatorio. Il nome visualizzato dello strumento widget. |
description |
Facoltativo. La descrizione dello strumento widget. |
widgetType |
Facoltativo. Il tipo di strumento widget. Se non specificato, il tipo predefinito sarà CUSTOMIZED. |
Campo unione input. L'input dello strumento widget. input può essere solo uno dei seguenti tipi: |
|
parameters |
Facoltativo. I parametri di input dello strumento widget. |
ToolFakeConfig
| Rappresentazione JSON |
|---|
{ "enableFakeMode": boolean, // Union field |
| Campi | |
|---|---|
enableFakeMode |
Facoltativo. Indica se lo strumento utilizza la modalità Falso. |
Campo unione tool_response. La risposta è statica o fornita da una funzione Python. tool_response può essere solo uno dei seguenti tipi: |
|
codeBlock |
Facoltativo. Blocco di codice che verrà eseguito al posto di una chiamata allo strumento reale. |
CodeBlock
| Rappresentazione JSON |
|---|
{ "pythonCode": string } |
| Campi | |
|---|---|
pythonCode |
Obbligatorio. Codice Python che verrà richiamato in modalità di simulazione dello strumento. Firma della funzione Python prevista: per intercettare tutte le chiamate di strumenti: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: per intercettare una chiamata di strumenti 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 ( |
| Campi | |
|---|---|
name |
Identificatore. L'identificatore univoco dell'esempio. Formato: |
displayName |
Obbligatorio. Nome visualizzato dell'esempio. |
description |
Facoltativo. Descrizione leggibile dell'esempio. |
entryAgent |
Facoltativo. L'agente che gestisce inizialmente la conversazione. Se non specificato, l'esempio rappresenta una conversazione gestita dall'agente principale. Formato: |
messages[] |
Facoltativo. L'insieme dei messaggi che compongono la conversazione. |
createTime |
Solo output. Timestamp di 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: |
updateTime |
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: |
invalid |
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 |
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. |
Messaggio
| Rappresentazione JSON |
|---|
{
"role": string,
"chunks": [
{
object ( |
| Campi | |
|---|---|
role |
Facoltativo. Il ruolo all'interno della conversazione, ad esempio utente, agente. |
chunks[] |
Facoltativo. Contenuto del messaggio come una serie di blocchi. |
eventTime |
Facoltativo. Timestamp di invio o ricezione del messaggio. Non deve essere utilizzato se il messaggio fa parte di un 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: |
Chunk
| Rappresentazione JSON |
|---|
{ // Union field |
| Campi | |
|---|---|
Campo unione data. Dividi i dati in blocchi. data può essere solo uno dei seguenti tipi: |
|
text |
Facoltativo. Dati di testo. |
transcript |
Facoltativo. Trascrizione associata all'audio. |
blob |
Facoltativo. Dati blob. |
payload |
Facoltativo. Dati di payload personalizzati. |
image |
Facoltativo. Dati immagine. |
toolCall |
Facoltativo. Richiesta di esecuzione dello strumento. |
toolResponse |
Facoltativo. Risposta all'esecuzione dello strumento. |
agentTransfer |
Facoltativo. Evento di trasferimento dell'agente. |
updatedVariables |
Una struct rappresenta le variabili aggiornate nella conversazione, identificate dai nomi delle variabili. |
defaultVariables |
Una struct rappresenta le variabili predefinite all'inizio della conversazione, identificate dai nomi delle variabili. |
Blob
| Rappresentazione JSON |
|---|
{ "mimeType": string, "data": string } |
| Campi | |
|---|---|
mimeType |
Obbligatorio. Il tipo MIME standard IANA dei dati di origine. |
data |
Obbligatorio. Byte non elaborati del blob. Una stringa con codifica in base64. |
Immagine
| Rappresentazione JSON |
|---|
{ "mimeType": string, "data": string } |
| Campi | |
|---|---|
mimeType |
Obbligatorio. Il tipo MIME standard IANA dei dati di origine. I tipi di immagini supportati includono: * image/png * image/jpeg * image/webp |
data |
Obbligatorio. Byte non elaborati dell'immagine. Una stringa con codifica in base64. |
ToolCall
| Rappresentazione JSON |
|---|
{ "id": string, "displayName": string, "args": { object }, // Union field |
| Campi | |
|---|---|
id |
Facoltativo. L'identificatore univoco della chiamata allo strumento. Se compilato, il client deve restituire il risultato dell'esecuzione con l'ID corrispondenza in |
displayName |
Solo output. Nome visualizzato dello strumento. |
args |
Facoltativo. I parametri e i valori di input per lo strumento in formato oggetto JSON. |
Campo unione tool_identifier. L'identificatore dello strumento da eseguire. Può trattarsi di uno strumento persistente o di uno strumento di un insieme di strumenti. tool_identifier può essere solo uno dei seguenti tipi: |
|
tool |
Facoltativo. Il nome dello strumento da eseguire. Formato: |
toolsetTool |
Facoltativo. Lo strumento del toolset da eseguire. |
ToolsetTool
| Rappresentazione JSON |
|---|
{ "toolset": string, "toolId": string } |
| Campi | |
|---|---|
toolset |
Obbligatorio. Il nome della risorsa del Toolset da cui deriva questo strumento. Formato: |
toolId |
Facoltativo. L'ID dello strumento per filtrare gli strumenti per cui recuperare lo schema. |
ToolResponse
| Rappresentazione JSON |
|---|
{ "id": string, "displayName": string, "response": { object }, // Union field |
| Campi | |
|---|---|
id |
Facoltativo. L'ID corrispondente di |
displayName |
Solo output. Nome visualizzato dello strumento. |
response |
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. |
Campo unione tool_identifier. L'identificatore dello strumento eseguito. Può trattarsi di uno strumento persistente o di uno strumento di un insieme di strumenti. tool_identifier può essere solo uno dei seguenti tipi: |
|
tool |
Facoltativo. Il nome dello strumento da eseguire. Formato: |
toolsetTool |
Facoltativo. Lo strumento del toolset che è stato eseguito. |
AgentTransfer
| Rappresentazione JSON |
|---|
{ "targetAgent": string, "displayName": string } |
| Campi | |
|---|---|
targetAgent |
Obbligatorio. L'agente a cui viene trasferita la conversazione. L'agente gestirà la conversazione da questo punto in poi. Formato: |
displayName |
Solo output. Il nome visualizzato dell'agente. |
Guardrail
| Rappresentazione JSON |
|---|
{ "name": string, "displayName": string, "description": string, "enabled": boolean, "action": { object ( |
| Campi | |
|---|---|
name |
Identificatore. L'identificatore univoco della barriera protettiva. Formato: |
displayName |
Obbligatorio. Nome visualizzato della barriera protettiva. |
description |
Facoltativo. Descrizione della barriera protettiva. |
enabled |
Facoltativo. Indica se la barriera protettiva è attiva. |
action |
Facoltativo. Azione da intraprendere quando viene attivata la protezione. |
createTime |
Solo output. Timestamp di creazione della barriera protettiva. 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: |
updateTime |
Solo output. Timestamp dell'ultimo aggiornamento della barriera protettiva. 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: |
etag |
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. |
Campo unione guardrail_type. Tipo di guardrail. guardrail_type può essere solo uno dei seguenti tipi: |
|
contentFilter |
Facoltativo. Barriera protettiva che impedisce l'utilizzo di determinati contenuti nella conversazione. |
llmPromptSecurity |
Facoltativo. Barriera protettiva che blocca la conversazione se il prompt viene considerato non sicuro in base alla classificazione LLM. |
llmPolicy |
Facoltativo. Barriera protettiva che blocca la conversazione se la risposta dell'LLM viene considerata una violazione delle norme in base alla classificazione dell'LLM. |
modelSafety |
Facoltativo. Barriera protettiva che blocca la conversazione se la risposta del LLM è considerata non sicura in base alle impostazioni di sicurezza del modello. |
codeCallback |
Facoltativo. Barriera protettiva che blocca potenzialmente la conversazione in base al risultato dell'esecuzione del callback. |
ContentFilter
| Rappresentazione JSON |
|---|
{
"bannedContents": [
string
],
"bannedContentsInUserInput": [
string
],
"bannedContentsInAgentResponse": [
string
],
"matchType": enum ( |
| Campi | |
|---|---|
bannedContents[] |
Facoltativo. Elenco di frasi vietate. Si applica sia agli input dell'utente sia alle risposte dell'agente. |
bannedContentsInUserInput[] |
Facoltativo. Elenco di frasi vietate. Si applica solo agli input degli utenti. |
bannedContentsInAgentResponse[] |
Facoltativo. Elenco di frasi vietate. Si applica solo alle risposte degli agenti. |
matchType |
Obbligatorio. Tipo di corrispondenza per il filtro dei contenuti. |
disregardDiacritics |
Facoltativo. Se true, i segni diacritici vengono ignorati durante la ricerca di corrispondenze. |
LlmPromptSecurity
| Rappresentazione JSON |
|---|
{ "failOpen": boolean, // Union field |
| Campi | |
|---|---|
failOpen |
Facoltativo. Determina il comportamento quando la barriera di protezione rileva un errore del modello linguistico di grandi dimensioni. - Se true: la barriera di protezione viene bypassata. - Se il valore è false (impostazione predefinita), il guardrail viene attivato/bloccato. Nota: se viene fornita una norma personalizzata, questo campo viene ignorato a favore della configurazione "fail_open" della norma. |
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 |
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" al suo interno verrà compilato dal server nella risposta. |
customPolicy |
Facoltativo. Utilizza una LlmPolicy definita dall'utente per configurare la barriera di sicurezza. |
DefaultSecuritySettings
| Rappresentazione JSON |
|---|
{ "defaultPromptTemplate": string } |
| Campi | |
|---|---|
defaultPromptTemplate |
Solo output. Il modello di prompt predefinito utilizzato dal sistema. Questo campo viene visualizzato per mostrare all'utente il prompt utilizzato dal sistema per impostazione predefinita. È OUTPUT_ONLY. |
LlmPolicy
| Rappresentazione JSON |
|---|
{ "maxConversationMessages": integer, "modelSettings": { object ( |
| Campi | |
|---|---|
maxConversationMessages |
Facoltativo. Quando controlli questa norma, considera gli ultimi "n" messaggi della conversazione. Se non viene impostato, viene utilizzato un valore predefinito di 10. |
modelSettings |
Facoltativo. Impostazioni del modello. |
prompt |
Obbligatorio. Prompt delle norme. |
policyScope |
Obbligatorio. Definisce quando applicare il controllo delle norme durante la conversazione. Se impostato su |
failOpen |
Facoltativo. Se si verifica un errore durante il controllo delle norme, non eseguire l'operazione e non attivare la protezione. |
allowShortUtterance |
Facoltativo. Per impostazione predefinita, il controllo delle norme LLM viene ignorato per le espressioni brevi. Se attivi questa impostazione, il controllo delle norme viene applicato a tutte le espressioni, incluse quelle che normalmente verrebbero ignorate. |
ModelSafety
| Rappresentazione JSON |
|---|
{
"safetySettings": [
{
object ( |
| Campi | |
|---|---|
safetySettings[] |
Obbligatorio. Elenco delle impostazioni di sicurezza. |
SafetySetting
| Rappresentazione JSON |
|---|
{ "category": enum ( |
| Campi | |
|---|---|
category |
Obbligatorio. La categoria del danno. |
threshold |
Obbligatorio. Soglia di blocco dei contenuti dannosi. |
CodeCallback
| Rappresentazione JSON |
|---|
{ "beforeAgentCallback": { object ( |
| Campi | |
|---|---|
beforeAgentCallback |
Facoltativo. Il callback da eseguire prima di chiamare l'agente. Ogni funzione di callback deve restituire una struttura (ad es. un dizionario 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 |
Facoltativo. Il callback da eseguire dopo la chiamata all'agente. Ogni funzione di callback deve restituire una struttura (ad es. un dizionario 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 |
Facoltativo. Il callback da eseguire prima della chiamata al modello. Se vengono effettuate più chiamate al modello, il callback verrà eseguito più volte. Ogni funzione di callback deve restituire una struttura (ad es. un dizionario 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 |
Facoltativo. Il callback da eseguire dopo la chiamata al modello. Se vengono effettuate più chiamate al modello, il callback verrà eseguito più volte. Ogni funzione di callback deve restituire una struttura (ad es. un dizionario o un oggetto) contenente almeno: - "decision": "OK" o "TRIGGER". - "reason": una stringa che spiega la decisione. Una decisione "TRIGGER" potrebbe interrompere l'ulteriore elaborazione. |
TriggerAction
| Rappresentazione JSON |
|---|
{ // Union field |
| Campi | |
|---|---|
Campo unione action. L'azione da intraprendere. action può essere solo uno dei seguenti tipi: |
|
respondImmediately |
Facoltativo. Rispondere immediatamente con una risposta preconfigurata. |
transferAgent |
Facoltativo. Trasferire la conversazione a un altro agente. |
generativeAnswer |
Facoltativo. Rispondi con una risposta generativa. |
RespondImmediately
| Rappresentazione JSON |
|---|
{
"responses": [
{
object ( |
| Campi | |
|---|---|
responses[] |
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 |
Obbligatorio. Testo con cui l'agente deve rispondere. |
disabled |
Facoltativo. Indica se la risposta è disattivata. Le risposte disattivate non vengono utilizzate dall'agente. |
TransferAgent
| Rappresentazione JSON |
|---|
{ "agent": string } |
| Campi | |
|---|---|
agent |
Obbligatorio. Il nome dell'agente a cui trasferire la conversazione. L'agente deve trovarsi nella stessa app dell'agente attuale. Formato: |
GenerativeAnswer
| Rappresentazione JSON |
|---|
{ "prompt": string } |
| Campi | |
|---|---|
prompt |
Obbligatorio. Il prompt da utilizzare per la risposta generativa. |
Toolset
| Rappresentazione JSON |
|---|
{ "name": string, "displayName": string, "description": string, "createTime": string, "updateTime": string, "etag": string, "executionType": enum ( |
| Campi | |
|---|---|
name |
Identificatore. L'identificatore univoco del set di strumenti. Formato: |
displayName |
Facoltativo. Il nome visualizzato del toolset. Deve essere univoco all'interno della stessa app. |
description |
Facoltativo. La descrizione del set di strumenti. |
createTime |
Solo output. Timestamp di creazione del toolset. 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: |
updateTime |
Solo output. Timestamp dell'ultimo aggiornamento del toolset. 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: |
etag |
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 |
Facoltativo. Il tipo di esecuzione degli strumenti nel toolset. |
toolFakeConfig |
Facoltativo. Configurazione del comportamento degli strumenti in modalità simulata. |
Campo unione toolset_type. Il tipo di toolset. toolset_type può essere solo uno dei seguenti tipi: |
|
mcpToolset |
Facoltativo. Un insieme di strumenti che contiene un elenco di strumenti offerti dal server MCP. |
openApiToolset |
Facoltativo. Un insieme di strumenti che contiene un elenco di strumenti definiti da uno schema OpenAPI. |
connectorToolset |
Facoltativo. Un insieme di strumenti che genera strumenti da una connessione Integration Connectors. |
McpToolset
| Rappresentazione JSON |
|---|
{ "serverAddress": string, "apiAuthentication": { object ( |
| Campi | |
|---|---|
serverAddress |
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 HTTP in streaming. Per ulteriori dettagli, consulta la pagina https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http. |
apiAuthentication |
Facoltativo. Informazioni di autenticazione necessarie per accedere agli strumenti ed eseguire uno strumento sul server MCP. Per l'autenticazione con token di autenticazione, il token si applica solo all'esecuzione dello strumento, non agli strumenti di inserzione. Ciò richiede che gli strumenti possano essere elencati senza autenticazione. |
serviceDirectoryConfig |
Facoltativo. Configurazione di Service Directory per VPC-SC, utilizzata per risolvere i nomi dei servizi all'interno di un perimetro. |
tlsConfig |
Facoltativo. La configurazione TLS. Include i certificati del server personalizzati che il client deve considerare attendibili. |
OpenApiToolset
| Rappresentazione JSON |
|---|
{ "openApiSchema": string, "apiAuthentication": { object ( |
| Campi | |
|---|---|
openApiSchema |
Obbligatorio. Lo schema OpenAPI del set di strumenti. |
apiAuthentication |
Facoltativo. Informazioni di autenticazione richieste dall'API. |
tlsConfig |
Facoltativo. La configurazione TLS. Include i certificati del server personalizzati |
serviceDirectoryConfig |
Facoltativo. Configurazione di Service Directory. |
ignoreUnknownFields |
Facoltativo. Se il valore è true, l'agente ignorerà i campi sconosciuti nella risposta API per tutte le operazioni definite nello schema OpenAPI. |
url |
Facoltativo. L'URL del server dello schema Open API. Questo campo viene impostato solo nei toolset 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 ( |
| Campi | |
|---|---|
connection |
Obbligatorio. Il nome completo della risorsa della connessione Integration Connectors a cui viene fatto riferimento. Formato: |
authConfig |
Facoltativo. Configura la gestione dell'autenticazione in Integration Connectors. Per impostazione predefinita, un'autenticazione amministratore viene trasmessa nelle richieste dell'API Integration Connectors. Puoi ignorarlo con una configurazione di autenticazione dell'utente finale diversa. Nota: per specificare una configurazione EUC qui, l'override dell'autenticazione deve essere abilitato per la connessione. In caso contrario, la creazione del Toolset non riuscirà. Consulta: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override |
connectorActions[] |
Obbligatorio. L'elenco delle azioni/operazioni sulle entità del connettore per cui generare gli strumenti. |
Annotazioni dello strumento
Suggerimento distruttivo: ✅ | Suggerimento idempotente: ❌ | Suggerimento di sola lettura: ❌ | Suggerimento open world: ❌