Package google.cloud.ces.v1beta

Solo output. La latenza media delle chiamate di strumenti.

ToolMetrics

Metriche per un singolo strumento.

Campi

tool

string

Solo output. Il nome dello strumento.

pass_count

int32

Solo output. Il numero di volte in cui lo strumento è stato superato.

fail_count

int32

Solo output. Il numero di volte in cui lo strumento non è riuscito.

TurnLatencyMetrics

Metriche per la latenza del turno.

Campi

average_latency

ApiKeyConfig.RequestLocation

Solo output. La latenza media dei turni.

AmbientSoundConfig

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

Campi
`volume_gain_db`	`double` Facoltativo. Guadagno del volume (in dB) del volume nativo normale supportato dal rumore ambientale, nell'intervallo [-96,0, 16,0]. Se non viene impostato o viene impostato su un valore di 0, 0 dB, la riproduzione avverrà con l'ampiezza del segnale nativo normale. Un valore di -6,0 dB verrà riprodotto a circa la metà dell'ampiezza del segnale nativo normale. Un valore di +6,0 (dB) verrà riprodotto a un'ampiezza circa doppia rispetto a quella normale del segnale nativo. Ti consigliamo vivamente di non superare +10 (dB), in quanto in genere 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:
`prebuilt_ambient_noise (deprecated)`	`AmbientSoundConfig.PrebuiltAmbientNoise` Questo elemento è obsoleto. Facoltativo. Deprecato: `prebuilt_ambient_noise` è deprecato e sostituito con `prebuilt_ambient_sound`.
`gcs_uri`	`string` Facoltativo. Rumore ambientale come file WAV mono a 16 kHz archiviato in Cloud Storage. Nota: assicurati che il service agent CES `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com` disponga dell'autorizzazione `storage.objects.get` per l'oggetto Cloud Storage.
`prebuilt_ambient_sound`	`string` Facoltativo. Nome del suono ambientale predefinito. I valori validi sono: - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner"

PrebuiltAmbientNoise

Rumore ambientale predefinito.

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

ApiAuthentication

Informazioni di autenticazione richieste per le chiamate API.

Campi
Campo unione `auth_config`. La configurazione di autenticazione. `auth_config` può essere solo uno dei seguenti tipi:
`api_key_config`	`ApiKeyConfig` Facoltativo. Configurazione per l'autenticazione della chiave API.
`oauth_config`	`OAuthConfig` Facoltativo. Configurazione per OAuth.
`service_agent_id_token_auth_config`	`ServiceAgentIdTokenAuthConfig` Facoltativo. Configurazione per l'autenticazione con token ID generato dall'agente di servizio CES.
`service_account_auth_config`	`ServiceAccountAuthConfig` Facoltativo. Configurazione per l'autenticazione del account di servizio.
`bearer_token_config`	`BearerTokenConfig` Facoltativo. Configurazione per l'autenticazione con token di connessione.

ApiKeyConfig

Configurazioni per l'autenticazione con chiave API.

Campi

key_name

string

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

api_key_secret_version

string

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

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

request_location

Obbligatorio. Posizione della chiave nella richiesta.

RequestLocation

La posizione della chiave API nella richiesta.

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

App

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

Campi
`name`	`string` Identificatore. L'identificatore univoco dell'app. Formato: `projects/{project}/locations/{location}/apps/{app}`
`display_name`	`string` Obbligatorio. Nome visualizzato dell'app.
`description`	`string` Facoltativo. Descrizione dell'app leggibile.
`pinned`	`bool` Facoltativo. Indica se l'app è bloccata nell'elenco delle app.
`root_agent`	`string` Facoltativo. L'agente principale è l'entry point dell'app. Formato: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
`language_settings`	`LanguageSettings` Facoltativo. Impostazioni della lingua dell'app.
`time_zone_settings`	`TimeZoneSettings` Facoltativo. Impostazioni del fuso orario dell'app.
`audio_processing_config`	`AudioProcessingConfig` Facoltativo. Configurazione dell'elaborazione audio dell'app.
`logging_settings`	`LoggingSettings` Facoltativo. Impostazioni di logging dell'app.
`error_handling_settings`	`ErrorHandlingSettings` Facoltativo. Impostazioni di gestione degli errori dell'app.
`model_settings`	`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.
`tool_execution_mode`	`App.ToolExecutionMode` Facoltativo. La modalità di esecuzione dello strumento per l'app. Se non viene fornita, il valore predefinito è PARALLEL.
`evaluation_metrics_thresholds`	`EvaluationMetricsThresholds` Facoltativo. Le soglie di valutazione per l'app.
`variable_declarations[]`	`App.VariableDeclaration` Facoltativo. Le dichiarazioni delle variabili.
`predefined_variable_declarations[]`	`App.VariableDeclaration` Solo output. Le dichiarazioni delle variabili predefinite per l'app.
`global_instruction`	`string` Facoltativo. Istruzioni per tutti gli agenti nell'app. Puoi utilizzare questa istruzione per configurare un'identità o una personalità stabile per tutti gli agenti.
`guardrails[]`	`string` Facoltativo. Elenco di misure di salvaguardia per l'app. Formato: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
`data_store_settings`	`DataStoreSettings` Facoltativo. Le impostazioni del datastore per l'app.
`default_channel_profile`	`ChannelProfile` Facoltativo. Il profilo del canale predefinito utilizzato dall'app.
`metadata`	`map<string, string>` Facoltativo. Metadati sull'app. Questo campo può essere utilizzato per memorizzare ulteriori informazioni pertinenti ai dettagli o agli utilizzi previsti dell'app.
`create_time`	`Timestamp` Solo output. Timestamp di creazione dell'app.
`update_time`	`Timestamp` Solo output. Timestamp dell'ultimo aggiornamento dell'app.
`etag`	`string` 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.
`deployment_count`	`int32` Solo output. Numero di deployment nell'app.
`client_certificate_settings`	`ClientCertificateSettings` Facoltativo. Le impostazioni predefinite del certificato client per l'app.
`vpc_sc_settings`	`VpcScSettings` Facoltativo. Impostazioni VPC-SC per l'app.
`locked`	`bool` Facoltativo. Indica se l'app è bloccata per le modifiche. Se l'app è bloccata, le modifiche alle risorse dell'app verranno rifiutate.
`evaluation_personas[]`	`EvaluationPersona` Facoltativo. Le buyer persona per la valutazione dell'app. Questo campo viene utilizzato per definire le buyer persona che possono essere utilizzate per la valutazione. È possibile definire un massimo di 30 buyer persona.
`evaluation_settings`	`EvaluationSettings` Facoltativo. Le impostazioni di valutazione per l'app.
`validation_errors[]`	`string` Solo output. Errori di configurazione o avvisi nell'app.
`dashboard_settings`	`DashboardSettings` Facoltativo. Impostazioni della dashboard specifiche per l'app per collegare e configurare le dashboard di Contact Center Insights.

ToolExecutionMode

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

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

VariableDeclaration

Definisce la struttura e i metadati di una variabile.

Campi

name

string

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

description

string

Obbligatorio. La descrizione della variabile.

schema

Schema

Obbligatorio. Lo schema della variabile.

AppSnapshot

Uno snapshot dell'app.

Campi
`app`	`App` Facoltativo. Le impostazioni di base per l'app.
`agents[]`	`Agent` Facoltativo. Elenco degli agenti nell'app.
`tools[]`	`Tool` Facoltativo. Elenco degli strumenti nell'app.
`examples[]`	`Example` Facoltativo. Elenco di esempi nell'app.
`guardrails[]`	`Guardrail` Facoltativo. Elenco delle barriere protettive nell'app.
`toolsets[]`	`Toolset` Facoltativo. Elenco di toolset nell'app.

AppVersion

In Customer Engagement Suite (CES), una versione dell'app è uno snapshot dell'app in un momento specifico. È immutabile e non può essere modificato dopo la creazione.

Campi
`name`	`string` Identificatore. L'identificatore univoco della versione dell'app. Formato: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
`display_name`	`string` Facoltativo. Il nome visualizzato della versione dell'app.
`description`	`string` Facoltativo. La descrizione della versione dell'app.
`creator`	`string` Solo output. Email dell'utente che ha creato la versione dell'app.
`create_time`	`Timestamp` Solo output. Timestamp di creazione della versione dell'app.
`update_time`	`Timestamp` Solo output. Timestamp dell'ultimo aggiornamento della versione dell'app.
`snapshot`	`AppSnapshot` Solo output. Lo snapshot dell'app al momento della creazione della versione.
`etag`	`string` Solo output. Etag utilizzato per garantire che l'oggetto non sia stato modificato durante un'operazione di lettura, modifica e scrittura. Se l'etag è vuoto, l'aggiornamento sovrascriverà eventuali modifiche simultanee.

AudioEncoding

AudioEncoding specifica il formato di codifica per i dati audio.

Enum
`AUDIO_ENCODING_UNSPECIFIED`	Codifica audio non specificata.
`LINEAR16`	Codifica audio PCM lineare a 16 bit.
`MULAW`	Campioni a 8 bit che comprimono campioni audio a 14 bit utilizzando G.711 PCMU/mu-law.
`ALAW`	Campioni a 8 bit che comprimono campioni audio a 14 bit utilizzando G.711 PCMU/A-law.

AudioProcessingConfig

Configurazione della modalità di elaborazione e distribuzione dell'audio di input e output.

Campi
`synthesize_speech_configs`	`map<string, SynthesizeSpeechConfig>` Facoltativo. Configurazione della modalità di sintesi della risposta dell'agente, mappatura dal codice della lingua a `SynthesizeSpeechConfig`. Se la configurazione per il codice della lingua specificato non viene trovata, verrà utilizzata la configurazione per il codice della lingua principale. Ad esempio, se la mappa contiene "en-us" e "en" e il codice di lingua specificato è "en-gb", verrà utilizzata la configurazione "en". Nota: il codice lingua non fa distinzione tra maiuscole e minuscole.
`barge_in_config`	`BargeInConfig` Facoltativo. Configura il comportamento dell'agente per le attività di interruzione dell'utente.
`inactivity_timeout`	`Duration` Facoltativo. La durata dell'inattività dell'utente (nessun discorso o interazione) prima che l'agente chieda all'utente di riprendere l'interazione. Se non viene impostato, l'agente non chiederà all'utente di riprendere l'interazione.
`ambient_sound_config`	`AmbientSoundConfig` Facoltativo. Configurazione del suono ambientale da riprodurre con la risposta dell'agente sintetizzata, per migliorare la naturalezza della conversazione.
`custom_voice_samples[]`	`CustomVoiceSample` Facoltativo. Configura i campioni vocali personalizzati per la clonazione della voce.

AudioRecordingConfig

Configurazione della modalità di registrazione delle interazioni audio.

Campi

gcs_bucket

string

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 storage.objects.create al service agent CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

gcs_path_prefix

string

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 $project/$location/$app/$date/$session/.

BargeInConfig

Configurazione della modalità di gestione delle attività di interruzione della chiamata da parte dell'utente.

Campi

disable_barge_in
(deprecated)

bool

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

Disattiva l'interruzione da parte dell'utente mentre l'agente parla. Se è true, l'input utente durante la riproduzione della risposta dell'agente verrà ignorato.

barge_in_awareness

bool

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

BatchDeleteConversationsRequest

Messaggio di richiesta per AgentService.BatchDeleteConversations.

Campi

parent

string

Obbligatorio. Il nome della risorsa dell'app da cui eliminare le conversazioni. Formato: projects/{project}/locations/{location}/apps/{app}

conversations[]

string

Obbligatorio. I nomi delle risorse delle conversazioni da eliminare.

BatchDeleteConversationsResponse

Messaggio di risposta per AgentService.BatchDeleteConversations.

Campi

deleted_conversations[]

string

L'elenco delle conversazioni eliminate correttamente.

failed_conversations[]

string

L'elenco delle conversazioni che non sono state eliminate.

error_messages[]

string

Facoltativo. Un elenco di messaggi di errore associati alle conversazioni che non sono state eliminate.

BearerTokenConfig

Configurazioni per l'autenticazione con un token di connessione (bearer).

Campi

token

string

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

BidiSessionClientMessage

Il messaggio di primo livello inviato dal client per il metodo SessionService.BidiRunSession.

Campi

Campo unione message_type. Il tipo di messaggio. message_type può essere solo uno dei seguenti tipi:

config

SessionConfig

Facoltativo. Il messaggio di configurazione iniziale per la sessione.

realtime_input

SessionInput

Facoltativo. Input in tempo reale per la sessione.

BidiSessionServerMessage

Il messaggio di primo livello restituito dal metodo SessionService.BidiRunSession.

Campi
Campo unione `message_type`. Il tipo di messaggio. `message_type` può essere solo uno dei seguenti tipi:
`session_output`	`SessionOutput` Facoltativo. Elaborazione del risultato dell'agente CES.
`recognition_result`	`RecognitionResult` Facoltativo. Risultato del riconoscimento vocale in tempo reale per l'input audio.
`interruption_signal`	`InterruptionSignal` Facoltativo. Indica che la risposta audio dell'agente è stata interrotta.
`end_session`	`EndSession` Facoltativo. Indica che la sessione è terminata.
`go_away`	`GoAway` Facoltativo. Indica che il server si disconnetterà a breve e che il client deve chiudere a metà e riavviare la connessione.

BigQueryExportSettings

Impostazioni per descrivere i comportamenti di BigQuery Export per l'app.

Campi

enabled

bool

Facoltativo. Indica se l'esportazione BigQuery è abilitata.

project

string

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

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

dataset

string

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

Blob

Rappresenta un input o un output blob nella conversazione.

Campi

mime_type

string

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

data

bytes

Obbligatorio. Byte non elaborati del blob.

Callback

Un callback definisce la logica personalizzata da eseguire nelle varie fasi dell'interazione dell'agente.

Campi
`description`	`string` Facoltativo. Descrizione leggibile del callback.
`disabled`	`bool` Facoltativo. Se il richiamo è disattivato. I callback disattivati vengono ignorati dall'agente.
`proactive_execution_enabled`	`bool` Facoltativo. Se abilitata, la richiamata verrà eseguita anche sugli output intermedi del modello. Questa impostazione ha effetto solo dopo il callback del modello. ATTIVA 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:
`python_code`	`string` Obbligatorio. Il codice Python da eseguire per il callback.

Log delle modifiche

I log delle modifiche rappresentano una modifica apportata all'app o a una risorsa all'interno dell'app.

Campi
`name`	`string` Identificatore. L'identificatore univoco del log delle modifiche. Formato: `projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}`
`author`	`string` Solo output. Indirizzo email dell'autore della modifica.
`display_name`	`string` Solo output. Nome visualizzato della modifica. In genere, dovrebbe essere il nome visualizzato della risorsa modificata.
`description`	`string` Solo output. Descrizione della modifica, che in genere acquisisce i campi modificati nella risorsa.
`resource`	`string` Solo output. La risorsa modificata.
`resource_type`	`string` Solo output. Il tipo di risorsa modificata.
`action`	`string` Solo output. L'azione eseguita sulla risorsa.
`original_resource`	`Struct` Solo output. La risorsa originale prima della modifica.
`new_resource`	`Struct` Solo output. La nuova risorsa dopo la modifica.
`dependent_resources[]`	`Struct` Solo output. Le risorse dipendenti che sono state modificate.
`create_time`	`Timestamp` Solo output. L'ora in cui è stata apportata la modifica.
`sequence_number`	`int64` Solo output. Il numero di sequenza crescente monotonicamente del changelog.

ChannelProfile

Un ChannelProfile configura il comportamento dell'agente per un canale di comunicazione specifico, ad esempio l'interfaccia utente web o la telefonia.

Campi
`profile_id`	`string` Facoltativo. L'identificatore univoco del profilo del canale.
`channel_type`	`ChannelProfile.ChannelType` Facoltativo. Il tipo di profilo del canale.
`persona_property`	`ChannelProfile.PersonaProperty` Facoltativo. La proprietà della persona del profilo del canale.
`web_widget_config`	`ChannelProfile.WebWidgetConfig` Facoltativo. La configurazione del widget web.
`whatsapp_config`	`ChannelProfile.WhatsAppConfig` Facoltativo. Configurazione specifica per i deployment di WhatsApp.
`instagram_config`	`ChannelProfile.InstagramConfig` Facoltativo. Configurazione specifica per i deployment di Instagram.
`disable_dtmf`	`bool` Facoltativo. Indica se disattivare il DTMF (multifrequenza a doppia tonalità).
`disable_barge_in_control`	`bool` 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.
`noise_suppression_level`	`string` Facoltativo. Il livello di eliminazione del rumore del profilo del canale. I valori disponibili sono "low", "moderate", "high", "very_high".

ChannelType

Il tipo di profilo del canale.

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

InstagramConfig

Configurazione specifica per i deployment di Instagram.

Campi
`instagram_account_id`	`string` Obbligatorio. L'ID account Instagram.
`display_name`	`string` Solo output. Il nome della pagina aziendale Meta recuperata.
`thumbnail_url`	`string` Solo output. L'URL della miniatura del profilo dell'attività Meta recuperato.
`description`	`string` Solo output. La descrizione della pagina o del profilo aziendale Meta.

PersonaProperty

Rappresenta la proprietà persona di un canale.

Campi

persona

ChannelProfile.PersonaProperty.Persona

Facoltativo. La personalità del canale.

Utente tipo

La personalità del canale.

Enum
`UNKNOWN`	Persona SCONOSCIUTA.
`CONCISE`	L'agente mantiene le risposte concise e pertinenti
`CHATTY`	L'agente fornisce contesto, spiegazioni e dettagli aggiuntivi

WebWidgetConfig

Messaggio per la configurazione del widget web.

Campi
`modality`	`ChannelProfile.WebWidgetConfig.Modality` Facoltativo. La modalità del widget web.
`theme`	`ChannelProfile.WebWidgetConfig.Theme` Facoltativo. Il tema del widget web.
`web_widget_title`	`string` Facoltativo. Il titolo del widget web.
`security_settings`	`ChannelProfile.WebWidgetConfig.SecuritySettings` Facoltativo. Le impostazioni di sicurezza del widget web.

Modalità

Modalità del widget web.

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

SecuritySettings

Impostazioni di sicurezza per il widget web.

Campi
`enable_public_access`	`bool` Facoltativo. Indica se l'accesso pubblico al widget web è abilitato. Se `true`, il widget web sarà accessibile pubblicamente. Se `false`, il widget web deve essere integrato con il tuo sistema di autenticazione e autorizzazione per restituire credenziali valide per l'accesso all'agente CES.
`enable_origin_check`	`bool` Facoltativo. Indica se il controllo dell'origine per il widget web è abilitato. Se `true`, il widget web controllerà l'origine del sito web che lo carica e ne consentirà il caricamento solo nella stessa origine o in una delle origini consentite.
`allowed_origins[]`	`string` Facoltativo. Le origini autorizzate a ospitare il widget web. Un'origine è definita dalla RFC 6454. Se vuoto, tutte le origini sono consentite. Sono consentite massimo 100 origini. Esempio: "https://example.com"
`enable_recaptcha`	`bool` Facoltativo. Indica se la verifica reCAPTCHA per il widget web è abilitata.

Tema

Il tema del widget web.

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

WhatsAppConfig

Configurazione specifica per i deployment di WhatsApp.

Campi
`waba_id`	`string` Obbligatorio. L'ID account WhatsApp Business.
`phone_number_id`	`string` Obbligatorio. L'ID numero di telefono Meta.
`phone_number`	`string` Facoltativo. Il numero di telefono in formato E.164.
`display_name`	`string` Solo output. Il nome della pagina aziendale Meta recuperata.
`thumbnail_url`	`string` Solo output. L'URL della miniatura del profilo dell'attività Meta recuperato.
`description`	`string` Solo output. La descrizione della pagina o del profilo aziendale Meta.

Chunk

Un blocco di contenuti all'interno di un messaggio.

Campi
Campo unione `data`. Dividi i dati in blocchi. `data` può essere solo uno dei seguenti tipi:
`text`	`string` Facoltativo. Dati di testo.
`transcript`	`string` Facoltativo. Trascrizione associata all'audio.
`blob`	`Blob` Facoltativo. Dati blob.
`payload`	`Struct` Facoltativo. Dati di payload personalizzati.
`image`	`Image` Facoltativo. Dati immagine.
`tool_call`	`ToolCall` Facoltativo. Richiesta di esecuzione dello strumento.
`tool_response`	`ToolResponse` Facoltativo. Risposta dell'esecuzione dello strumento.
`agent_transfer`	`AgentTransfer` Facoltativo. Evento di trasferimento dell'agente.
`updated_variables`	`Struct` Una struct rappresenta le variabili aggiornate nella conversazione, identificate dai nomi delle variabili.
`default_variables`	`Struct` Una struct rappresenta le variabili predefinite all'inizio della conversazione, identificate dai nomi delle variabili.

Citazioni

Citazioni associate alla risposta dell'agente.

Campi

cited_chunks[]

Citations.CitedChunk

Elenco delle informazioni citate.

inline_citations[]

Citations.InlineCitation

Facoltativo. Elenco delle citazioni in linea nella risposta dell'agente.

CitedChunk

Informazione citata.

Campi
`uri`	`string` URI utilizzato per la citazione.
`title`	`string` Il titolo del documento citato.
`text`	`string` Testo utilizzato per la citazione.
`requires_attribution`	`bool` Indica se questa citazione richiede l'attribuzione da mostrare agli utenti finali.

InlineCitation

Una citazione diretta nel testo della risposta.

Campi

start_index

int32

L'indice iniziale (in byte) del segmento di testo nella risposta dell'agente.

end_index

int32

L'indice finale (in byte) del segmento di testo nella risposta dell'agente.

cited_chunk_indices[]

int32

Gli indici dei chunk citati che supportano questo segmento di testo. Gli indici si riferiscono agli elementi in cited_chunks.

ClientCertificateSettings

Impostazioni per i certificati client personalizzati.

Campi

tls_certificate

string

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

private_key

string

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

passphrase

string

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

ClientFunction

Rappresenta una funzione lato client che l'agente può richiamare. Quando lo strumento viene scelto dall'agente, il controllo viene trasferito al cliente. Il client è responsabile dell'esecuzione della funzione e della restituzione del risultato come ToolResponse per continuare l'interazione con l'agente.

Campi
`name`	`string` Obbligatorio. Il nome della funzione.
`description`	`string` Facoltativo. La descrizione della funzione.
`parameters`	`Schema` Facoltativo. Lo schema dei parametri della funzione.
`response`	`Schema` Facoltativo. Lo schema della risposta della funzione.

CloudLoggingSettings

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

Campi

enable_cloud_logging

bool

Facoltativo. Indica se abilitare Cloud Logging per le sessioni.

CodeBlock

Un blocco di codice da eseguire al posto di una chiamata di strumento reale.

Campi

python_code

string

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 strumento specifica: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: se la funzione restituisce None, verrà richiamato lo strumento reale.

ConnectorTool

Un ConnectorTool consente le connessioni a integrazioni diverse. Consulta: https://cloud.google.com/integration-connectors/docs/overview.

Campi
`connection`	`string` Obbligatorio. Il nome completo della risorsa della connessione Integration Connectors a cui viene fatto riferimento. Formato: `projects/{project}/locations/{location}/connections/{connection}`
`action`	`Action` Obbligatorio. Azione da utilizzare per lo strumento.
`auth_config`	`EndUserAuthConfig` Facoltativo. Configura la gestione dell'autenticazione in Integration Connectors. Per impostazione predefinita, un'autenticazione amministratore viene trasmessa nelle richieste dell'API Integration Connectors. Puoi sostituirlo 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 di ConnectorTool non riuscirà. Per i dettagli, consulta https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override.
`name`	`string` Facoltativo. Il nome dello strumento che può essere utilizzato dall'agente per decidere se chiamare questo ConnectorTool.
`description`	`string` Facoltativo. La descrizione dello strumento che può essere utilizzata dall'agente per decidere se chiamare questo ConnectorTool.

ConnectorToolset

Un insieme di strumenti che genera strumenti da una connessione Integration Connectors.

Campi

connection

string

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

auth_config

EndUserAuthConfig

Facoltativo. Configura la gestione dell'autenticazione in Integration Connectors. Per impostazione predefinita, un'autenticazione amministratore viene trasmessa nelle richieste dell'API Integration Connectors. Puoi sostituirlo 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 del toolset non riuscirà. Consulta: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override

connector_actions[]

Action

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

Conversazione

Una conversazione rappresenta un'interazione tra un utente finale e l'app CES.

Campi
`name`	`string` Identificatore. L'identificatore univoco della conversazione. Formato: `projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}`
`start_time`	`Timestamp` Solo output. Timestamp di creazione della conversazione.
`end_time`	`Timestamp` Solo output. Timestamp di completamento della conversazione.
`turns[]`	`Conversation.Turn` Obbligatorio. I turni della conversazione.
`turn_count`	`int32` Solo output. Il numero di turni nella conversazione.
`channel_type (deprecated)`	`Conversation.ChannelType` Questo elemento è obsoleto. OBSOLETO. Utilizza invece `input_types`.
`source`	`Conversation.Source` Solo output. Indica l'origine della conversazione.
`input_types[]`	`Conversation.InputType` Solo output. I tipi di input della conversazione.
`entry_agent`	`string` Solo output. L'agente che gestisce inizialmente la conversazione. Se non specificato, la conversazione viene gestita dall'agente principale. Formato: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
`deployment`	`string` Solo output. Il deployment dell'app utilizzata per l'elaborazione della conversazione. Formato: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
`app_version`	`string` Solo output. La versione dell'app utilizzata per l'elaborazione della conversazione. Formato: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
`language_code`	`string` Solo output. Il codice lingua della conversazione.
`messages[] (deprecated)`	`Message` Questo elemento è obsoleto. Deprecato. Utilizza invece le svolte.

ChannelType

Il tipo di canale della conversazione.

Enum
`CHANNEL_TYPE_UNSPECIFIED`	Tipo di canale non specificato.
`TEXT`	La conversazione contiene solo messaggi di testo tra l'utente finale e l'agente.
`AUDIO`	La conversazione contiene messaggi audio tra l'utente finale e l'agente.
`MULTIMODAL`	I messaggi multimodali (ad es. immagini) della conversazione tra l'utente finale e l'agente.

InputType

Tipo di messaggio di input.

Enum
`INPUT_TYPE_UNSPECIFIED`	Tipo di input non specificato.
`INPUT_TYPE_TEXT`	Inserimento testo.
`INPUT_TYPE_EVENT`	Input dell'evento.
`INPUT_TYPE_AUDIO`	Input audio.
`INPUT_TYPE_IMAGE`	Input di immagini.
`INPUT_TYPE_BLOB`	Input blob.
`INPUT_TYPE_TOOL_RESPONSE`	Input di risposta dello strumento della funzione client.
`INPUT_TYPE_VARIABLES`	Input delle variabili.

Origine

L'origine della conversazione.

Enum
`SOURCE_UNSPECIFIED`	Origine non specificata.
`LIVE`	La conversazione è dell'utente finale live.
`SIMULATOR`	La conversazione proviene dal simulatore.
`EVAL`	La conversazione proviene dalla valutazione.
`AGENT_TOOL`	La conversazione proviene da uno strumento per agenti. Lo strumento agente esegue l'agente in una sessione separata, che viene mantenuta per scopi di test e debug.

Accendi

Tutte le informazioni su un singolo turno della conversazione.

Campi

messages[]

Message

Facoltativo. Elenco dei messaggi nel turno di conversazione, inclusi l'input utente, le risposte dell'agente e gli eventi intermedi durante l'elaborazione.

root_span

Span

Facoltativo. Lo span radice dell'elaborazione dell'azione.

user_intended_text

string

Facoltativo. Il testo basato su dati empirici reali previsto del chiamante simulato (Polysynth). Viene compilato solo quando sono attivate le metriche del tasso di errore di parola.

ConversationLoggingSettings

Impostazioni per descrivere i comportamenti di registrazione delle conversazioni per l'app.

Campi

disable_conversation_logging

bool

Facoltativo. Se disattivare il logging delle conversazioni per le sessioni.

retention_window

CustomVoiceSample.Warning.WarningType

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

Configurazione di un campione di voce personalizzata utilizzato per la clonazione della voce.

Campi
`name`	`string` Facoltativo. Il nome definito dall'utente per il campione vocale personalizzato.
`voice_sample_gcs_uri`	`string` Facoltativo. L'URI Cloud Storage del campione audio per la clonazione della voce. Il campione audio deve essere un file WAV mono a 24 kHz.
`consent_audio_gcs_uri`	`string` Facoltativo. Audio di consenso per la clonazione vocale.
`voice_instruction`	`string` Facoltativo. Istruzioni in linguaggio naturale per lo stile, il tono, il ritmo o la pronuncia della voce.
`preview_audio_content`	`bytes` Solo output. Audio di anteprima sintetizzato per la voce personalizzata, formattato come WAV canonico (LINEAR16, 24 kHz, 16 bit, mono).
`preview_text`	`string` Facoltativo. Testo per la sintesi dell'audio di anteprima per la voce personalizzata.
`warnings[]`	`CustomVoiceSample.Warning` Solo output. Messaggi di avviso riscontrati durante l'elaborazione della clonazione della voce (ad es. livello audio basso).
`voice_instruction_mode`	`CustomVoiceSample.VoiceInstructionMode` Facoltativo. Modalità di istruzioni per il campione vocale. Se non specificato, il valore predefinito è NO_INSTRUCTION.

VoiceInstructionMode

Modalità di istruzioni per il campione vocale.

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

Avviso

Un messaggio di avviso riscontrato durante l'elaborazione del campione vocale.

Campi

message

string

Solo output. Una descrizione leggibile dell'avviso.

type

Solo output. Il tipo di avviso.

WarningType

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

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

DashboardSettings

Impostazioni per le dashboard associate all'app, visualizzate nella vista Monitoraggio.

Campi

default_dashboard

string

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

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

DataStore

Una risorsa DataStore in Vertex AI Search.

Campi
`name`	`string` Obbligatorio. Nome completo della risorsa del datastore. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
`type`	`DataStore.DataStoreType` Solo output. Il tipo di datastore. Questo campo è di sola lettura e viene compilato dal server.
`document_processing_mode`	`DataStore.DocumentProcessingMode` Solo output. La modalità di elaborazione dei documenti per la connessione del datastore. Impostato solo per i datastore PUBLIC_WEB e UNSTRUCTURED.
`display_name`	`string` Solo output. Il nome visualizzato del datastore.
`create_time`	`Timestamp` Solo output. Timestamp di creazione del datastore.
`connector_config`	`DataStore.ConnectorConfig` Solo output. La configurazione del connettore per la connessione al datastore.

ConnectorConfig

La configurazione del connettore per la connessione al datastore.

Campi

collection

string

Nome della risorsa della raccolta a cui appartiene il datastore.

collection_display_name

string

Nome visualizzato della raccolta a cui appartiene il datastore.

data_source

string

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

DataStoreType

Il tipo di datastore.

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

DocumentProcessingMode

La modalità di elaborazione dei documenti del datastore.

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

DataStoreSettings

Impostazioni relative al datastore per l'app.

Campi

engines[]

DataStoreSettings.Engine

Solo output. I motori per l'app.

Motore

Un motore a cui sono connessi i datastore. Consulta Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

Campi

name

string

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

type

DataStoreSettings.Engine.Type

Solo output. Il tipo di motore.

Tipo

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

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

DataStoreTool

Strumento per il recupero dal datastore o dal motore di Vertex AI Search per il grounding. Accetta un datastore o un motore, ma non entrambi. Consulta Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

Campi
`name`	`string` Obbligatorio. Il nome dello strumento datastore.
`description`	`string` Facoltativo. La descrizione dello strumento.
`boost_specs[]`	`DataStoreTool.BoostSpecs` Facoltativo. Migliora la specifica per dare priorità a determinati documenti.
`modality_configs[]`	`DataStoreTool.ModalityConfig` Facoltativo. Le configurazioni della modalità per il datastore.
`filter_parameter_behavior`	`DataStoreTool.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:
`data_store_source`	`DataStoreTool.DataStoreSource` Facoltativo. Eseguire ricerche all'interno di un singolo DataStore specifico.
`engine_source`	`DataStoreTool.EngineSource` Facoltativo. Cerca all'interno di un motore (potenzialmente in più DataStore).

BoostSpec

Migliora la specifica per dare priorità a determinati documenti.

Campi

condition_boost_specs[]

DataStoreTool.BoostSpec.ConditionBoostSpec

Obbligatorio. Un elenco di specifiche di boosting.

ConditionBoostSpec

Specifica di miglioramento per una condizione.

Campi

condition

string

Obbligatorio. Un'espressione che specifica una condizione di incremento. 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

float

Facoltativo. 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 l'impostazione è 0.0, non viene applicato alcun boost. La condizione di incremento viene ignorata.

boost_control_spec

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec

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

BoostControlSpec

Specifica per il ranking personalizzato basato sul valore dell'attributo specificato dal cliente. Fornisce più controlli per il ranking personalizzato rispetto alla semplice combinazione (condizione, boost) riportata sopra.

Campi
`field_name`	`string` Facoltativo. Il nome del campo il cui valore verrà utilizzato per determinare l'importo dell'incremento.
`attribute_type`	`DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType` Facoltativo. Il tipo di attributo da utilizzare per determinare l'importo dell'incremento. 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, invece, attribute_value = (time.now() - datetime_field_value).
`interpolation_type`	`DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType` Facoltativo. Il tipo di interpolazione da applicare per collegare i punti di controllo elencati di seguito.
`control_points[]`	`DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint` Facoltativo. I punti di controllo utilizzati per definire la curva. La funzione monotona (definita tramite interpolation_type sopra) passa attraverso i punti di controllo elencati qui.

AttributeType

L'attributo(o la funzione) a cui deve essere applicato il ranking personalizzato.

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

ControlPoint

I punti di controllo utilizzati per definire la curva. La curva definita tramite questi punti di controllo può essere solo crescente o decrescente in modo monotono(i valori costanti sono accettabili).

Campi

attribute_value

string

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

boost_amount

float

Facoltativo. Il valore compreso tra -1 e 1 in base al quale aumentare il punteggio se attribute_value restituisce il valore specificato sopra.

InterpolationType

Il tipo di interpolazione da applicare. Il valore predefinito sarà lineare (lineare a tratti).

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

BoostSpecs

Migliora le specifiche per dare priorità a determinati documenti. Per saperne di più, consulta la pagina https://cloud.google.com/generative-ai-app-builder/docs/boosting.

Campi

data_stores[]

string

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

spec[]

DataStoreTool.BoostSpec

Obbligatorio. Un elenco di specifiche di boosting.

DataStoreSource

Configurazione per la ricerca all'interno di un datastore specifico.

Campi

filter

string

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

data_store

DataStore

Facoltativo. Il datastore.

EngineSource

Configurazione per la ricerca all'interno di un motore, con potenziale targeting di Data Store specifici.

Campi

engine

string

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

data_store_sources[]

DataStoreTool.DataStoreSource

Facoltativo. Utilizza questo campo per scegliere come target DataStore specifici all'interno del motore. Se è vuoto, la ricerca si applica a tutti i Data Store associati al motore.

filter

string

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

FilterParameterBehavior

Comportamento del parametro di filtro.

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

GroundingConfig

Configurazione della messa a terra.

Campi

grounding_level

float

Facoltativo. La soglia di fondatezza della risposta in base alle fonti recuperate. Il valore ha un intervallo configurabile di [1, 5]. Il livello viene utilizzato per impostare la soglia di fondatezza della risposta, il che significa che tutte le risposte con un punteggio di fondatezza inferiore alla soglia 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

bool

Facoltativo. Indica se la messa a terra è disabilitata.

ModalityConfig

Se specificata, verrà applicata la configurazione indicata per la modalità specificata.

Campi
`modality_type`	`DataStoreTool.ModalityConfig.ModalityType` Obbligatorio. Il tipo di modalità.
`rewriter_config`	`DataStoreTool.RewriterConfig` Facoltativo. La configurazione del rewriter.
`summarization_config`	`DataStoreTool.SummarizationConfig` Facoltativo. La configurazione del riepilogo.
`grounding_config`	`DataStoreTool.GroundingConfig` Facoltativo. La configurazione di messa a terra.
`snippets_config`	`DataStoreTool.SnippetsConfig` Facoltativo. La configurazione degli snippet.

ModalityType

Il tipo di modalità.

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

RewriterConfig

Configurazione del rewriter.

Campi

model_settings

ModelSettings

Obbligatorio. Configurazioni per il modello LLM.

prompt

string

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

disabled

bool

Facoltativo. Indica se il rewriter è disattivato.

SnippetsConfig

Configurazione degli snippet.

Campi

enable_snippets

bool

Facoltativo. Se gli snippet sono abilitati.

max_snippets

int32

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

SummarizationConfig

Configurazione del riassunto.

Campi

model_settings

ModelSettings

Facoltativo. Configurazioni per il modello LLM.

prompt

string

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

disabled

bool

Facoltativo. Indica se il riepilogo è disattivato.

DeleteAgentRequest

Messaggio di richiesta per AgentService.DeleteAgent.

Campi

name

string

Obbligatorio. Il nome della risorsa dell'agente da eliminare.

force

bool

Facoltativo. Indica se eliminare forzatamente l'agente, anche se viene ancora fatto riferimento ad altre app/agenti/esempi.

Se force = false, l'eliminazione non va a buon fine se altri agenti/esempi fanno riferimento.
Se force = true, elimina l'agente e rimuovilo da tutte le app/gli agenti/gli esempi che lo fanno riferimento.

etag

string

Facoltativo. L'etag attuale dell'agente. Se non viene fornito un ETag, l'eliminazione sovrascriverà eventuali modifiche simultanee. Se viene fornito un ETag che non corrisponde all'ETag corrente dell'agente, l'eliminazione verrà bloccata e verrà restituito un errore ABORTED.

DeleteAppRequest

Messaggio di richiesta per AgentService.DeleteApp.

Campi

name

string

Obbligatorio. Il nome della risorsa dell'app da eliminare.

etag

string

Facoltativo. L'etag corrente dell'app. Se non viene fornito un etag, l'eliminazione sovrascriverà eventuali modifiche simultanee. Se viene fornito un ETag che non corrisponde all'ETag corrente dell'app, l'eliminazione verrà bloccata e verrà restituito un errore ABORTED.

DeleteAppVersionRequest

Messaggio di richiesta per AgentService.DeleteAppVersion.

Campi

name

string

Obbligatorio. Il nome della risorsa della versione dell'app da eliminare.

etag

string

Facoltativo. L'etag attuale della versione dell'app. Se non viene fornito un ETag, l'eliminazione sovrascriverà eventuali modifiche simultanee. Se viene fornito un ETag che non corrisponde all'ETag corrente della versione dell'app, l'eliminazione verrà bloccata e verrà restituito un errore ABORTED.

DeleteConversationRequest

Messaggio di richiesta per AgentService.DeleteConversation.

Campi

name

string

Obbligatorio. Il nome della risorsa della conversazione da eliminare.

source
(deprecated)

Conversation.Source

Facoltativo. Indica l'origine della conversazione. Se non viene impostato, Source.Live verrà applicato per impostazione predefinita.

DeleteDeploymentRequest

Messaggio di richiesta per AgentService.DeleteDeployment.

Campi

name

string

Obbligatorio. Il nome del deployment da eliminare. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

etag

string

Facoltativo. L'etag del deployment. Se viene fornito un ETag che non corrisponde all'ETag attuale del deployment, l'eliminazione verrà bloccata e verrà restituito un errore ABORTED.

DeleteEvaluationDatasetRequest

Messaggio di richiesta per EvaluationService.DeleteEvaluationDataset.

Campi

name

string

Obbligatorio. Il nome della risorsa del set di dati di valutazione da eliminare.

etag

string

Facoltativo. L'etag attuale del set di dati di valutazione. Se non viene fornito un ETag, l'eliminazione sovrascriverà eventuali modifiche simultanee. Se viene fornito un ETag che non corrisponde all'ETag corrente del set di dati di valutazione, l'eliminazione verrà bloccata e verrà restituito un errore ABORTED.

DeleteEvaluationExpectationRequest

Messaggio di richiesta per EvaluationService.DeleteEvaluationExpectation.

Campi

name

string

Obbligatorio. Il nome della risorsa dell'aspettativa di valutazione da eliminare.

etag

string

Facoltativo. L'etag attuale dell'aspettativa di valutazione. Se non viene fornito un ETag, l'eliminazione sovrascriverà eventuali modifiche simultanee. Se viene fornito un ETag che non corrisponde all'ETag attuale dell'aspettativa di valutazione, l'eliminazione verrà bloccata e verrà restituito un errore ABORTED.

DeleteEvaluationRequest

Messaggio di richiesta per EvaluationService.DeleteEvaluation.

Campi

name

string

Obbligatorio. Il nome della risorsa della valutazione da eliminare.

force

bool

Facoltativo. Indica se eliminare forzatamente la valutazione, anche se viene ancora fatto riferimento a essa nei set di dati di valutazione.

Se force = false, l'eliminazione non andrà a buon fine se alcuni set di dati fanno ancora riferimento alla valutazione.
Se force = true, tutti i riferimenti esistenti dai set di dati verranno rimossi e la valutazione verrà eliminata.

etag

Messaggio di richiesta per AgentService.DeleteGuardrail.

Campi

name

string

Obbligatorio. Il nome della risorsa della barriera protettiva da eliminare.

force

bool

Facoltativo. Indica se eliminare forzatamente la barriera protettiva, anche se viene ancora utilizzata da app/agenti.

Se force = false, l'eliminazione non va a buon fine se app/agenti fanno ancora riferimento alla barriera protettiva.
Se force = true, tutti i riferimenti esistenti di app/agenti verranno rimossi e la barriera protettiva verrà eliminata.

etag

string

Facoltativo. L'etag attuale della barriera di protezione. Se non viene fornito un ETag, l'eliminazione sovrascriverà eventuali modifiche simultanee. Se viene fornito un ETag che non corrisponde all'ETag attuale della protezione, l'eliminazione verrà bloccata e verrà restituito un errore ABORTED.

DeleteScheduledEvaluationRunRequest

Messaggio di richiesta per EvaluationService.DeleteScheduledEvaluationRun.

Campi

name

string

Obbligatorio. Il nome della risorsa dell'esecuzione della valutazione pianificata da eliminare.

etag

string

Facoltativo. L'etag di ScheduledEvaluationRun. Se fornito, deve corrispondere all'etag del server.

DeleteToolRequest

Messaggio di richiesta per AgentService.DeleteTool.

Campi

name

string

Obbligatorio. Il nome della risorsa dello strumento da eliminare.

force

bool

Facoltativo. Indica se eliminare forzatamente lo strumento, anche se viene ancora fatto riferimento ad agenti/esempi.

Se force = false, l'eliminazione non andrà a buon fine se degli agenti fanno ancora riferimento allo strumento.
Se force = true, tutti i riferimenti esistenti degli agenti verranno rimossi e lo strumento verrà eliminato.

etag

string

Facoltativo. L'etag attuale dello strumento. Se non viene fornito un ETag, l'eliminazione sovrascriverà eventuali modifiche simultanee. Se viene fornito un ETag che non corrisponde all'ETag corrente dello strumento, l'eliminazione verrà bloccata e verrà restituito un errore ABORTED.

DeleteToolsetRequest

Messaggio di richiesta per AgentService.DeleteToolset.

Campi

name

string

Obbligatorio. Il nome della risorsa del toolset da eliminare.

force

bool

Facoltativo. Indica se eliminare forzatamente il toolset, anche se viene ancora fatto riferimento da app/agenti.

Se force = false, l'eliminazione non va a buon fine se alcuni agenti fanno ancora riferimento al toolset.
Se force = true, tutti i riferimenti esistenti degli agenti verranno rimossi e il set di strumenti verrà eliminato.

etag

string

Facoltativo. L'etag attuale del toolset. Se non viene fornito un ETag, l'eliminazione sovrascriverà eventuali modifiche simultanee. Se viene fornito un ETag che non corrisponde all'ETag corrente del toolset, l'eliminazione verrà bloccata e verrà restituito un errore ABORTED.

DeployChannelResponse

Messaggio di risposta per AgentService.DeployChannel.

Campi

deployment

Deployment

Il deployment creato.

Deployment

Un deployment rappresenta una versione immutabile e interrogabile dell'app. Viene utilizzato per eseguire il deployment di una versione dell'app con un profilo del canale specifico.

Campi
`name`	`string` Identificatore. Il nome della risorsa del deployment. Formato: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
`display_name`	`string` Obbligatorio. Il nome visualizzato del deployment.
`app_version`	`string` Facoltativo. Il nome risorsa della versione dell'app di cui eseguire il deployment. Formato: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` utilizza `projects/{project}/locations/{location}/apps/{app}/versions/-` per utilizzare l'app bozza.
`channel_profile`	`ChannelProfile` Obbligatorio. Il profilo del canale utilizzato nel deployment.
`create_time`	`Timestamp` Solo output. Timestamp di creazione di questo deployment.
`update_time`	`Timestamp` Solo output. Timestamp dell'ultimo aggiornamento di questo deployment.
`etag`	`string` 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.
`experiment_config`	`ExperimentConfig` Facoltativo. Configurazione dell'esperimento per il deployment.
`whatsapp_credentials`	`WhatsAppCredentials` Facoltativo. Solo input. Credenziali WhatsApp temporanee richieste durante la configurazione di un profilo del canale WhatsApp.
`instagram_credentials`	`InstagramCredentials` Facoltativo. Solo input. Credenziali Instagram temporanee richieste durante la configurazione di un profilo del canale Instagram.
`model_settings`	`ModelSettings` Facoltativo. Impostazioni del modello per il deployment. Esegue l'override delle impostazioni del modello configurate a livello di app/agente. Nota: l'override delle impostazioni del modello a livello di deployment è protetto da una lista consentita. Contatta il team CXAS per attivare questo campo.
`modality`	`Deployment.Modality` Facoltativo. La modalità di deployment. Nota: l'override della modalità a livello di deployment è protetto da una lista consentita. Contatta il team CXAS per attivare questo campo.
`agent_registry_deployment`	`AgentRegistryDeployment` Facoltativo. Configurazione per il deployment di questo deployment in Agent Registry. Se presente, questo deployment verrà pubblicato in Agent Registry.

Modalità

La modalità di deployment.

Enum
`MODALITY_UNSPECIFIED`	Modalità sconosciuta.
`MODALITY_TEXT`	Modalità testo.
`MODALITY_VOICE`	Modalità vocale.
`MODALITY_VIDEO`	Modalità video.

EndSession

Indica che la sessione è terminata, a causa del completamento riuscito (ad es. l'utente dice "Arrivederci!" ) o un riassegnazione a un agente.

L'agente non elaborerà ulteriori input dopo la chiusura della sessione e il client deve chiudere a metà e disconnettersi dopo aver ricevuto tutte le risposte rimanenti dall'agente.

Campi

metadata

EndUserAuthConfig.Oauth2AuthCodeConfig

Facoltativo. Fornisce informazioni aggiuntive sull'indicatore di fine sessione, ad esempio il motivo della fine della sessione.

EndUserAuthConfig

Configurazione dell'autenticazione dell'utente finale utilizzata per le chiamate di connessione. I valori dei campi devono essere i nomi delle variabili di contesto nel formato $context.variables.<name_of_variable>.

Campi

Campo unione auth_config. La configurazione di autenticazione. auth_config può essere solo uno dei seguenti tipi:

oauth2_auth_code_config

Autenticazione del codice di autorizzazione OAuth 2.0.

oauth2_jwt_bearer_config

EndUserAuthConfig.Oauth2JwtBearerConfig

Autenticazione della concessione di autorizzazione OAuth 2.0 del profilo JWT.

Oauth2AuthCodeConfig

Configurazione dell'autenticazione con codice di autorizzazione OAuth 2.0.

Campi

oauth_token

string

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

Oauth2JwtBearerConfig

Configurazione dell'autenticazione di concessione dell'autorizzazione OAuth 2.0 del profilo JWT.

Campi

issuer

string

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

subject

string

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

client_key

string

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

EndpointControlPolicy

Definisce la policy di controllo degli endpoint a livello di progetto/località.

Campi

enforcement_scope

EndpointControlPolicy.EnforcementScope

Facoltativo. L'ambito in cui viene applicato l'elenco allowed_origins di questa policy.

allowed_origins[]

string

Facoltativo. Le origini HTTP(s) consentite che gli strumenti nell'app possono chiamare direttamente. L'applicazione dipende dal valore di enforcement_scope e dallo stato di VPC-SC del progetto. Se non viene fornito un numero di porta, verranno consentite tutte le porte. In caso contrario, il numero di porta deve corrispondere esattamente. Ad esempio, "https://example.com" corrisponderà a "https://example.com:443" e a qualsiasi altra porta. "https://example.com:443" corrisponderà solo a "https://example.com:443".

EnforcementScope

Definisce l'ambito in cui viene applicato l'elenco allowed_origins di questa policy.

Enum
`ENFORCEMENT_SCOPE_UNSPECIFIED`	Non specificato. Questo criterio verrà trattato come VPCSC_ONLY.
`VPCSC_ONLY`	Queste norme si applicano solo quando VPC-SC è attivo.
`ALWAYS`	Questa policy si applica SEMPRE, indipendentemente dallo stato di VPC-SC.

ErrorHandlingSettings

Impostazioni per descrivere come devono essere gestiti gli errori nell'app.

Campi

error_handling_strategy

ErrorHandlingSettings.ErrorHandlingStrategy

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

fallback_response_config

ErrorHandlingSettings.FallbackResponseConfig

Facoltativo. Configurazione per la gestione delle risposte di fallback.

end_session_config

ErrorHandlingSettings.EndSessionConfig

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

EndSessionConfig

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

Campi

escalate_session

bool

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

ErrorHandlingStrategy

Definisce la strategia per la gestione degli errori.

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

FallbackResponseConfig

Configurazione per la gestione delle risposte di fallback.

Campi

custom_fallback_messages

map<string, string>

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

max_fallback_attempts

int32

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

Valutazione

Una valutazione rappresenta tutte le informazioni necessarie per simulare e valutare un agente.

Campi
`name`	`string` Identificatore. L'identificatore univoco di questa valutazione. Formato: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`
`display_name`	`string` Obbligatorio. Nome visualizzato definito dall'utente della valutazione. Unico all'interno di un'app.
`description`	`string` Facoltativo. Descrizione definita dall'utente della valutazione.
`tags[]`	`string` Facoltativo. Tag definiti dall'utente per classificare la valutazione.
`evaluation_datasets[]`	`string` Solo output. Elenco dei set di dati di valutazione a cui appartiene la valutazione. Formato: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`
`create_time`	`Timestamp` Solo output. Timestamp di creazione della valutazione.
`created_by`	`string` Solo output. L'utente che ha creato la valutazione.
`update_time`	`Timestamp` Solo output. Timestamp dell'ultimo aggiornamento della valutazione.
`last_updated_by`	`string` Solo output. L'utente che ha aggiornato per ultimo la valutazione.
`evaluation_runs[]`	`string` Solo output. Le EvaluationRuns a cui è associata questa valutazione.
`etag`	`string` 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.
`aggregated_metrics`	`AggregatedMetrics` Solo output. Le metriche aggregate per questa valutazione in tutte le esecuzioni.
`last_completed_result`	`EvaluationResult` Solo output. L'ultimo risultato della valutazione.
`invalid`	`bool` Solo output. Indica se la valutazione non è valida. Ciò può accadere se una valutazione fa riferimento a uno strumento, un insieme di strumenti o un agente che è stato eliminato.
`last_ten_results[]`	`EvaluationResult` Solo output. Gli ultimi 10 risultati di valutazione per questa valutazione. Questo campo viene compilato solo se include_last_ten_results è impostato su true in ListEvaluationsRequest o GetEvaluationRequest.
`evaluation_metrics_threshold_override`	`EvaluationMetricsThresholds` Facoltativo. Esegue l'override delle soglie delle metriche per questa valutazione specifica.
`evaluation_metrics_config_override`	`EvaluationMetricsConfig` Facoltativo. Esegue l'override della configurazione delle metriche per questa valutazione specifica.
Campo unione `inputs`. Gli input per la valutazione `inputs` possono essere solo uno dei seguenti:
`golden`	`Evaluation.Golden` Facoltativo. I passaggi d'oro da valutare.
`scenario`	`Evaluation.Scenario` Facoltativo. La configurazione di uno scenario.

Golden

I passaggi necessari per riprodurre una conversazione di riferimento.

Campi

turns[]

Evaluation.GoldenTurn

Obbligatorio. Le svolte d'oro necessarie per riprodurre una conversazione d'oro. Il numero massimo di turni consentiti è 100.

evaluation_expectations[]

string

Facoltativo. Le aspettative di valutazione rispetto alle quali valutare la conversazione riprodotta. Formato: projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}

GoldenExpectation

Rappresenta un singolo requisito selezionabile.

Campi
`note`	`string` Facoltativo. Una nota per questo requisito, utile per la generazione di report quando controlli specifici non vanno a buon fine. Ad esempio, "Check_Payment_Tool_Called".
`skip_evaluation`	`bool` Facoltativo. Se impostato su true, questa aspettativa specifica non verrà valutata.
`expectation_level_metrics_thresholds_override`	`EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds` Facoltativo. Esegue l'override delle metriche a livello di passaggio.
`agent_response_semantic_similarity_metrics_config_override`	`EvaluationMetricsConfig.SemanticSimilarityMetricsConfig` Facoltativo. Override per le metriche di similarità semantica agent_response.
`agent_response_hallucination_metrics_config_override`	`EvaluationMetricsConfig.HallucinationMetricsConfig` Facoltativo. Override per le metriche di allucinazione di agent_response.
`comparison_type`	`EvaluationMetricsConfig.ComparisonType` Facoltativo. Il tipo di confronto da utilizzare per il controllo delle aspettative.
Campo unione `condition`. Il controllo effettivo da eseguire. `condition` può essere solo uno dei seguenti tipi:
`tool_call`	`ToolCall` Facoltativo. Verifica che uno strumento specifico sia stato chiamato con i parametri.
`tool_response`	`ToolResponse` Facoltativo. Verifica che uno strumento specifico abbia avuto la risposta prevista.
`agent_response`	`Message` Facoltativo. Controlla che l'agente abbia risposto con la risposta corretta. Il ruolo "agente" è implicito.
`agent_transfer`	`AgentTransfer` Facoltativo. Controlla che l'agente abbia trasferito la conversazione a un altro agente.
`updated_variables`	`Struct` Facoltativo. Verifica che l'agente abbia aggiornato le variabili di sessione ai valori previsti. Utilizzato anche per acquisire gli aggiornamenti delle variabili dell'agente per le valutazioni di riferimento.
`mock_tool_response`	`ToolResponse` Facoltativo. La risposta dello strumento alla simulazione, con i parametri di interesse specificati. Eventuali parametri non specificati verranno inventati dal modello LLM.
`no_tool_calls`	`bool` Facoltativo. Controlla che non siano stati chiamati strumenti durante questo turno.

GoldenTurn

Un turno di riferimento definisce un singolo turno in una conversazione di riferimento.

Campi
`steps[]`	`Evaluation.Step` Obbligatorio. I passaggi necessari per riprodurre una conversazione di riferimento.
`root_span`	`Span` Facoltativo. Lo span radice della svolta d'oro per l'elaborazione e la manutenzione delle informazioni audio. L'URI dell'audio deve contenere l'audio salvato con una frequenza di campionamento di 16 kHz.
`turn_level_metrics_thresholds_override`	`EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds` Facoltativo. Override per le soglie delle metriche a livello di turno.
`hallucination_metric_behavior_override`	`EvaluationMetricsThresholds.HallucinationMetricBehavior` Facoltativo. Override per il comportamento della metrica di allucinazione a livello di turno.

Scenario

La configurazione di uno scenario

Campi
`task`	`string` Obbligatorio. L'attività da prendere di mira nello scenario.
`user_facts[]`	`Evaluation.Scenario.UserFact` Facoltativo. I dati dell'utente da utilizzare nello scenario.
`max_turns`	`int32` Facoltativo. Il numero massimo di turni da simulare. Il valore massimo consentito è 100. Il valore predefinito è 100.
`rubrics[]`	`string` Obbligatorio. I criteri di valutazione in base ai quali valutare lo scenario.
`scenario_expectations[]`	`Evaluation.ScenarioExpectation` Obbligatorio. ScenarioExpectations per valutare la conversazione prodotta dalla simulazione dell'utente.
`variable_overrides`	`Struct` Facoltativo. Variabili / parametri sessione come contesto per la sessione, identificati dai nomi delle variabili. I membri di questa struttura sostituiranno eventuali valori predefiniti impostati dal sistema. Tieni presente che questi sono diversi dai fatti dell'utente, ovvero i fatti noti all'utente. Le variabili sono parametri noti all'agente, ad esempio MDN (numero di telefono) trasmesso dal sistema di telefonia.
`task_completion_behavior (deprecated)`	`Evaluation.Scenario.TaskCompletionBehavior` Questo elemento è obsoleto. Facoltativo. Deprecato. Utilizza invece user_goal_behavior.
`user_goal_behavior`	`Evaluation.Scenario.UserGoalBehavior` Facoltativo. Il comportamento previsto dell'obiettivo utente.
`evaluation_expectations[]`	`string` Facoltativo. Le aspettative di valutazione per valutare la conversazione prodotta dalla simulazione. Formato: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}`
`scenario_execution_mode`	`EvaluationSettings.ScenarioExecutionMode` Facoltativo. La modalità di esecuzione per le valutazioni degli scenari.

TaskCompletionBehavior

Il comportamento previsto dell'attività dell'utente. Viene utilizzato per determinare se lo scenario è riuscito.

Enum
`TASK_COMPLETION_BEHAVIOR_UNSPECIFIED`	Comportamento non specificato. Il valore predefinito è TASK_SATISFIED.
`TASK_SATISFIED`	L'attività dell'utente deve essere completata correttamente.
`TASK_REJECTED`	L'attività utente deve essere rifiutata.

UserFact

Informazioni sull'utente come coppia chiave-valore.

Campi

name

string

Obbligatorio. Il nome del fatto dell'utente.

value

string

Obbligatorio. Il valore del fatto relativo all'utente.

UserGoalBehavior

Il comportamento previsto dell'obiettivo utente. Viene utilizzato per determinare se lo scenario è riuscito.

Enum
`USER_GOAL_BEHAVIOR_UNSPECIFIED`	Comportamento non specificato. Il valore predefinito è USER_GOAL_SATISFIED.
`USER_GOAL_SATISFIED`	L'obiettivo dell'utente deve essere completato correttamente.
`USER_GOAL_REJECTED`	L'obiettivo utente deve essere rifiutato.
`USER_GOAL_IGNORED`	Ignora lo stato dell'obiettivo utente.

ScenarioExpectation

L'aspettativa di valutare la conversazione prodotta dalla simulazione.

Campi

Campo unione expectation. L'aspettativa di valutare la conversazione prodotta dalla simulazione. expectation può essere solo uno dei seguenti tipi:

tool_expectation

Evaluation.ScenarioExpectation.ToolExpectation

Facoltativo. La coppia di chiamata allo strumento e risposta da valutare.

agent_response

Message

Facoltativo. La risposta dell'agente da valutare.

ToolExpectation

La coppia di chiamata allo strumento e risposta da valutare.

Campi

expected_tool_call

ToolCall

Obbligatorio. La chiamata allo strumento prevista, con i parametri di interesse specificati. Eventuali parametri non specificati verranno inventati dal modello LLM.

mock_tool_response

ToolResponse

Obbligatorio. La risposta dello strumento alla simulazione, con i parametri di interesse specificati. Eventuali parametri non specificati verranno inventati dal modello LLM.

Passaggio

Un passaggio definisce una singola azione da eseguire durante la valutazione.

Campi
Campo unione `step`. Il passaggio da eseguire. `step` può essere solo uno dei seguenti tipi:
`user_input`	`SessionInput` Facoltativo. Input utente per la conversazione.
`agent_transfer`	`AgentTransfer` Facoltativo. Trasferire la conversazione a un altro agente.
`expectation`	`Evaluation.GoldenExpectation` Facoltativo. Esegue un'aspettativa nel turno corrente.

EvaluationConfig

EvaluationConfig configura le impostazioni per l'esecuzione della valutazione.

Campi
`input_audio_config`	`InputAudioConfig` Facoltativo. Configurazione per l'elaborazione dell'audio di input.
`output_audio_config`	`OutputAudioConfig` Facoltativo. Configurazione per la generazione dell'audio di output.
`evaluation_channel`	`EvaluationConfig.EvaluationChannel` Facoltativo. Il canale da valutare.
`tool_call_behaviour`	`EvaluationToolCallBehaviour` Facoltativo. Specifica se la valutazione deve utilizzare chiamate di strumenti reali o strumenti falsi.

EvaluationChannel

Il canale da valutare.

Enum
`EVALUATION_CHANNEL_UNSPECIFIED`	Canale di valutazione non specificato.
`TEXT`	Canale di valutazione solo testo.
`AUDIO`	Canale di valutazione audio.

EvaluationDataset

Un set di dati di valutazione rappresenta un insieme di valutazioni raggruppate in base a tag condivisi.

Campi
`name`	`string` Identificatore. L'identificatore univoco di questo set di dati di valutazione. Formato: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`
`display_name`	`string` Obbligatorio. Nome visualizzato definito dall'utente del set di dati di valutazione. Unico all'interno di un'app.
`evaluations[]`	`string` Facoltativo. Le valutazioni incluse in questo set di dati.
`create_time`	`Timestamp` Solo output. Timestamp di creazione del set di dati di valutazione.
`update_time`	`Timestamp` Solo output. Timestamp dell'ultimo aggiornamento del set di dati di valutazione.
`etag`	`string` 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.
`created_by`	`string` Solo output. L'utente che ha creato il set di dati di valutazione.
`last_updated_by`	`string` Solo output. L'utente che ha aggiornato per ultimo il set di dati di valutazione.
`aggregated_metrics`	`AggregatedMetrics` Solo output. Le metriche aggregate per questo set di dati di valutazione in tutte le esecuzioni.

EvaluationErrorInfo

Informazioni su un errore riscontrato durante l'esecuzione di una valutazione.

Campi
`error_type`	`EvaluationErrorInfo.ErrorType` Solo output. Il tipo di errore.
`error_message`	`string` Solo output. Il messaggio di errore.
`session_id`	`string` Solo output. L'ID sessione della conversazione che ha causato l'errore.
`user_facing_error_message`	`string` Solo output. Il messaggio di errore visualizzato dall'utente.

ErrorType

Il tipo di errore

Enum
`ERROR_TYPE_UNSPECIFIED`	Tipo di errore non specificato.
`RUNTIME_FAILURE`	Errore durante l'esecuzione del runtime.
`CONVERSATION_RETRIEVAL_FAILURE`	Impossibile recuperare la conversazione dal runtime CES.
`METRIC_CALCULATION_FAILURE`	Impossibilità di calcolare una metrica / un risultato.
`EVALUATION_UPDATE_FAILURE`	Impossibile aggiornare la valutazione.
`QUOTA_EXHAUSTED`	Quota esaurita.
`USER_SIMULATION_FAILURE`	Errore durante la simulazione utente.

EvaluationExpectation

Un'aspettativa di valutazione rappresenta un criterio specifico rispetto al quale effettuare la valutazione.

Campi
`name`	`string` Identificatore. L'identificatore univoco di questa aspettativa di valutazione. Formato: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}`
`display_name`	`string` Obbligatorio. Nome visualizzato definito dall'utente. Deve essere univoco all'interno dell'app.
`tags[]`	`string` Facoltativo. Tag definiti dall'utente per le aspettative. Può essere utilizzato per filtrare le aspettative.
`create_time`	`Timestamp` Solo output. Timestamp di creazione dell'aspettativa di valutazione.
`update_time`	`Timestamp` Solo output. Timestamp dell'ultimo aggiornamento dell'aspettativa di valutazione.
`etag`	`string` 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.
Campo unione `criteria`. La definizione dei criteri utilizzati per la valutazione. `criteria` può essere solo uno dei seguenti tipi:
`llm_criteria`	`EvaluationExpectation.LlmCriteria` Facoltativo. Criteri di valutazione basati su un prompt LLM.

LlmCriteria

Configurazione per i criteri di valutazione basati su LLM.

Campi

prompt

string

Obbligatorio. Il prompt/le istruzioni forniti al giudice LLM.

EvaluationMetricsConfig

Configura le metriche per una valutazione.

Campi

golden_metrics_config

EvaluationMetricsConfig.GoldenMetricsConfig

Facoltativo. Configurazione delle metriche auree per la valutazione.

scenario_metrics_config

EvaluationMetricsConfig.ScenarioMetricsConfig

Facoltativo. Configurazione delle metriche dello scenario per la valutazione.

ComparisonType

Tipi di confronto supportati per il controllo della risposta dell'agente.

Enum
`COMPARISON_TYPE_UNSPECIFIED`	Tipo di confronto non specificato. Il comportamento predefinito è SEMANTIC_SIMILARITY per le risposte dell'agente e le chiamate di strumenti.
`EQUALS`	Corrispondenza esatta della stringa.
`CONTAINS`	Corrispondenza della sottostringa (controlla se la stringa prevista è contenuta nella risposta effettiva).
`SEMANTIC_SIMILARITY`	Corrispondenza di similarità semantica (valuta la somiglianza di significato utilizzando un LLM).

ExpectationsMetMetricsConfig

Configurazione delle metriche del livello di aspettativa per la valutazione. Per disattivare la metrica, imposta il messaggio, ma non impostare il campo enable_expectations_met_metrics su true (o impostalo esplicitamente su false). Per annullare la configurazione e ripristinare il comportamento predefinito, ometti completamente il messaggio.

Campi

enable_expectations_met_metrics

bool

Facoltativo. Indica se calcolare le metriche del livello di aspettative per la valutazione.

GoldenMetricsConfig

Configurazione delle metriche auree per la valutazione.

Campi

semantic_similarity_metrics_config

EvaluationMetricsConfig.SemanticSimilarityMetricsConfig

Facoltativo. Configurazione globale per le metriche di similarità semantica.

tool_correctness_metrics_config

EvaluationMetricsConfig.ToolCorrectnessMetricsConfig

Facoltativo. Configurazione per le metriche di correttezza dello strumento a livello di turno.

step_tool_correctness_metrics_config

EvaluationMetricsConfig.ToolCorrectnessMetricsConfig

Facoltativo. Configurazione per le metriche di correttezza dello strumento a livello di passaggio.

HallucinationMetricsConfig

Configurazione delle metriche di allucinazione per la valutazione. Per disattivare la metrica, imposta il messaggio, ma non impostare il campo enable_hallucination_metrics su true (o impostalo esplicitamente su false). Per annullare la configurazione e ripristinare il comportamento predefinito, ometti completamente il messaggio.

Campi

enable_hallucination_metrics

bool

Facoltativo. Indica se calcolare le metriche di allucinazione per la valutazione.

ScenarioMetricsConfig

Configurazione delle metriche dello scenario per la valutazione.

Campi

user_goal_met_metrics_config

EvaluationMetricsConfig.UserGoalMetMetricsConfig

Facoltativo. Configurazione delle metriche relative al raggiungimento degli obiettivi utente.

expectations_met_metrics_config

EvaluationMetricsConfig.ExpectationsMetMetricsConfig

Facoltativo. Configurazione per le metriche a livello di aspettativa.

SemanticSimilarityMetricsConfig

Configurazione delle metriche di similarità per la valutazione. Per disattivare la metrica, imposta il messaggio, ma non impostare il campo enable_semantic_similarity_metrics su true (o impostalo esplicitamente su false). Per annullare la configurazione e ripristinare il comportamento predefinito, ometti completamente il messaggio.

Campi

enable_semantic_similarity_metrics

bool

Facoltativo. Se calcolare le metriche di similarità semantica per la valutazione.

ToolCorrectnessMetricsConfig

Configurazione delle metriche di correttezza per la valutazione. Per disattivare la metrica, imposta il messaggio, ma non impostare il campo enable_tool_correctness_metrics su true (o impostalo esplicitamente su false). Per annullare la configurazione e ripristinare il comportamento predefinito, ometti completamente il messaggio.

Campi

enable_tool_correctness_metrics

bool

Facoltativo. Se calcolare le metriche di correttezza dello strumento per la valutazione.

UserGoalMetMetricsConfig

Configurazione delle metriche Obiettivo utente raggiunto per la valutazione. Per disattivare la metrica, imposta il messaggio, ma non impostare il campo enable_user_goal_met_metrics su true (o impostalo esplicitamente su false). Per annullare la configurazione e ripristinare il comportamento predefinito, ometti completamente il messaggio.

Campi

enable_user_goal_met_metrics

bool

Facoltativo. Indica se calcolare le metriche relative al raggiungimento dell'obiettivo dell'utente per la valutazione.

EvaluationMetricsThresholds

Impostazioni delle soglie per le metriche in una valutazione.

Campi
`golden_evaluation_metrics_thresholds`	`EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds` Facoltativo. Le soglie delle metriche di valutazione secondo regole d'oro.
`hallucination_metric_behavior (deprecated)`	`EvaluationMetricsThresholds.HallucinationMetricBehavior` Questo elemento è obsoleto. Facoltativo. Deprecato: utilizza `golden_hallucination_metric_behavior`. Il comportamento della metrica di allucinazione viene attualmente utilizzato per le valutazioni dorate.
`golden_hallucination_metric_behavior`	`EvaluationMetricsThresholds.HallucinationMetricBehavior` Facoltativo. Il comportamento della metrica di allucinazione per le valutazioni golden.
`scenario_hallucination_metric_behavior`	`EvaluationMetricsThresholds.HallucinationMetricBehavior` Facoltativo. Il comportamento della metrica di allucinazione per le valutazioni degli scenari.

GoldenEvaluationMetricsThresholds

Impostazioni per le valutazioni di riferimento.

Campi

turn_level_metrics_thresholds

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds

Facoltativo. Le soglie delle metriche a livello di turno.

expectation_level_metrics_thresholds

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds

Facoltativo. Le soglie delle metriche del livello di aspettativa.

tool_matching_settings

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

ExpectationLevelMetricsThresholds

Soglie delle metriche del livello di aspettativa.

Campi

tool_invocation_parameter_correctness_threshold

float

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

TurnLevelMetricsThresholds

Soglie delle metriche a livello di turno.

Campi

semantic_similarity_channel

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel

Facoltativo. Il canale di similarità semantica da utilizzare per la valutazione.

semantic_similarity_success_threshold

int32

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

overall_tool_invocation_correctness_threshold

float

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.

SemanticSimilarityChannel

Canale di similarità semantica da utilizzare.

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

HallucinationMetricBehavior

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

Enum
`HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED`	Comportamento della metrica di allucinazione non specificato.
`DISABLED`	Disattiva la metrica delle allucinazioni.
`ENABLED`	Abilita la metrica delle allucinazioni.

ToolMatchingSettings

Impostazioni per le chiamate dello strumento di corrispondenza.

Campi

extra_tool_call_behavior

EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior

Facoltativo. Comportamento per le chiamate di strumenti aggiuntivi. Il valore predefinito è FAIL.

ExtraToolCallBehavior

Definisce il comportamento quando viene rilevata una chiamata di un tool aggiuntivo. 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.

Enum
`EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED`	Comportamento non specificato. Il valore predefinito è FAIL.
`FAIL`	La valutazione non viene superata se viene rilevata una chiamata aggiuntiva allo strumento.
`ALLOW`	Consenti la chiamata dello strumento aggiuntiva.

EvaluationPersona

Un utente tipo rappresenta un utente finale in una valutazione.

Campi
`name`	`string` Obbligatorio. L'identificatore univoco della persona. Formato: `projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evaluationPersona}`
`description`	`string` Facoltativo. La descrizione della persona.
`display_name`	`string` Obbligatorio. Il nome visualizzato della persona. Unico all'interno di un'app.
`personality`	`string` Obbligatorio. Un'istruzione per l'agente su come comportarsi nella valutazione.
`speech_config`	`EvaluationPersona.SpeechConfig` Facoltativo. Configurazione del suono della persona (impostazioni TTS).

SpeechConfig

Configurazione per la generazione di Text-to-Speech.

Campi

speaking_rate

double

Facoltativo. La velocità del parlato. 1,0 è il valore normale. Un valore più basso indica una velocità inferiore (ad es. 0,8), mentre un valore più alto indica una velocità superiore (ad es. 1,5). Utile per testare il modo in cui l'agente gestisce le persone che parlano velocemente.

environment

EvaluationPersona.SpeechConfig.BackgroundEnvironment

Facoltativo. L'ambiente audio simulato.

voice_id

string

Facoltativo. L'identificatore/l'accento della voce specifico da utilizzare. Esempio: "en-US-Wavenet-D" o "en-GB-Standard-A"

BackgroundEnvironment

Ambiente audio simulato.

Enum
`BACKGROUND_ENVIRONMENT_UNSPECIFIED`	Ambiente di sfondo non specificato.
`CALL_CENTER`	Ambiente del call center.
`TRAFFIC`	Ambiente con rumore del traffico.
`KIDS_NOISE`	Ambiente rumoroso per bambini.
`CAFE`	Ambiente del bar.

EvaluationResult

Un risultato della valutazione rappresenta l'output dell'esecuzione di una valutazione.

Campi
`name`	`string` Identificatore. L'identificatore univoco del risultato della valutazione. Formato: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}`
`display_name`	`string` Obbligatorio. Nome visualizzato del risultato della valutazione. Unico all'interno di una valutazione. Per impostazione predefinita, ha il seguente formato: " risultato - ".
`create_time`	`Timestamp` Solo output. Timestamp di creazione del risultato della valutazione.
`evaluation_status`	`EvaluationResult.Outcome` Solo output. Il risultato della valutazione. Compilato solo se execution_state è COMPLETE.
`evaluation_run`	`string` Solo output. L'esecuzione della valutazione che ha prodotto questo risultato. Formato: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`
`persona`	`EvaluationPersona` Solo output. La persona utilizzata per generare la conversazione per il risultato della valutazione.
`error_info`	`EvaluationErrorInfo` Solo output. Informazioni sull'errore per il risultato della valutazione.
`error (deprecated)`	`Status` Questo elemento è obsoleto. Solo output. Deprecato: utilizza `error_info`. Errori rilevati durante l'esecuzione.
`initiated_by`	`string` Solo output. L'utente che ha avviato l'esecuzione della valutazione che ha generato questo risultato.
`app_version`	`string` Solo output. La versione dell'app utilizzata per generare la conversazione che ha prodotto questo risultato. Formato: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
`app_version_display_name`	`string` Solo output. Il nome visualizzato del `app_version` rispetto al quale è stata eseguita la valutazione.
`changelog`	`string` Solo output. Il log delle modifiche della versione dell'app su cui è stata eseguita la valutazione. Questo campo viene compilato se l'utente esegue la valutazione sull'ultima versione/bozza.
`changelog_create_time`	`Timestamp` Solo output. L'ora di creazione del log delle modifiche della versione dell'app rispetto alla quale è stata eseguita la valutazione. Questo campo viene compilato se l'utente esegue la valutazione sull'ultima versione/bozza.
`execution_state`	`EvaluationResult.ExecutionState` Solo output. Lo stato di esecuzione del risultato della valutazione.
`evaluation_metrics_thresholds`	`EvaluationMetricsThresholds` Solo output. Le soglie di valutazione per il risultato.
`config`	`EvaluationConfig` Solo output. La configurazione utilizzata nell'esecuzione della valutazione che ha generato questo risultato.
`golden_run_method`	`GoldenRunMethod` Solo output. Il metodo utilizzato per eseguire la valutazione golden.
`root_span`	`Span` Solo output. Lo span radice dell'esecuzione della valutazione, che include informazioni su ogni passaggio della valutazione.
`outcome_metadata`	`EvaluationResult.OutcomeMetadata` Solo output. I metadati del risultato della valutazione. Compilato solo se execution_state è COMPLETE.
Campo unione `result`. Il risultato della valutazione. Viene compilato solo quando execution_state è COMPLETED. `result` può essere solo uno dei seguenti tipi:
`golden_result`	`EvaluationResult.GoldenResult` Solo output. Il risultato di una valutazione golden.
`scenario_result`	`EvaluationResult.ScenarioResult` Solo output. Il risultato di una valutazione dello scenario.

EvaluationExpectationResult

Il risultato di una singola aspettativa di valutazione.

Campi
`evaluation_expectation`	`string` Solo output. L'aspettativa di valutazione. Formato: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}`
`prompt`	`string` Solo output. Il prompt utilizzato per la valutazione.
`outcome`	`EvaluationResult.Outcome` Solo output. Il risultato dell'aspettativa di valutazione.
`explanation`	`string` Solo output. La spiegazione del risultato.

ExecutionState

Lo stato di esecuzione del risultato della valutazione.

Enum
`EXECUTION_STATE_UNSPECIFIED`	Lo stato di esecuzione del risultato della valutazione non è specificato.
`QUEUED`	L'esecuzione del risultato della valutazione è in coda.
`RUNNING`	L'esecuzione del risultato della valutazione è in corso.
`COMPLETED`	L'esecuzione del risultato della valutazione è stata completata.
`ERROR`	L'esecuzione del risultato della valutazione non è riuscita a causa di un errore interno.
`CANCELLED`	L'esecuzione del risultato della valutazione è stata annullata.

GoldenExpectationOutcome

Specifica l'aspettativa e il risultato di questa aspettativa.

Campi
`expectation`	`Evaluation.GoldenExpectation` Solo output. L'aspettativa che è stata valutata.
`outcome`	`EvaluationResult.Outcome` Solo output. Il risultato dell'aspettativa.
`semantic_similarity_result (deprecated)`	`EvaluationResult.SemanticSimilarityResult` Questo elemento è obsoleto. Solo output. Il risultato del controllo della somiglianza semantica.
`tool_invocation_result`	`EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult` Solo output. Il risultato del controllo di chiamata dello strumento.
Campo unione `result`. Il risultato dell'aspettativa. `result` può essere solo uno dei seguenti tipi:
`observed_tool_call`	`ToolCall` Solo output. Il risultato dell'aspettativa di chiamata dello strumento.
`observed_tool_response`	`ToolResponse` Solo output. Il risultato dell'aspettativa di risposta dello strumento.
`observed_agent_response`	`Message` Solo output. Il risultato dell'aspettativa di risposta dell'agente.
`observed_agent_transfer`	`AgentTransfer` Solo output. Il risultato dell'aspettativa di trasferimento dell'agente.
`observed_payload`	`Struct` Solo output. Un payload personalizzato osservato. Non sono previsti payload personalizzati. Viene utilizzato solo per il calcolo delle metriche. L'esito è sempre IGNORATO.

ToolInvocationResult

Il risultato del controllo di chiamata dello strumento.

Campi

outcome

EvaluationResult.Outcome

Solo output. Il risultato del controllo dell'invocazione dello strumento. Questo valore viene determinato confrontando parameter_correctness_score con la soglia. Se il punteggio è uguale o superiore alla soglia, il risultato sarà PASS. In caso contrario, il risultato sarà FAIL.

explanation

string

Solo output. Una spiegazione in formato libero del risultato dell'invocazione dello strumento.

parameter_correctness_score

float

Solo output. Il punteggio di correttezza dei parametri di chiamata dello strumento. Indica la percentuale di parametri della chiamata allo strumento prevista che erano presenti anche nella chiamata allo strumento effettiva.

GoldenResult

Il risultato di una valutazione di riferimento.

Campi

turn_replay_results[]

EvaluationResult.GoldenResult.TurnReplayResult

Solo output. Il risultato dell'esecuzione di ogni turno della conversazione d'oro.

evaluation_expectation_results[]

EvaluationResult.EvaluationExpectationResult

Solo output. I risultati delle aspettative di valutazione.

TurnReplayResult

Il risultato dell'esecuzione di un singolo turno della conversazione di riferimento.

Campi
`conversation`	`string` Solo output. La conversazione generata per questo turno.
`expectation_outcome[]`	`EvaluationResult.GoldenExpectationOutcome` Solo output. Il risultato di ogni aspettativa.
`hallucination_result`	`EvaluationResult.HallucinationResult` Solo output. Il risultato del controllo delle allucinazioni.
`tool_invocation_score (deprecated)`	`float` Questo elemento è obsoleto. Solo output. Deprecato. Utilizza OverallToolInvocationResult.
`turn_latency`	`Duration` Solo output. Durata del turno.
`tool_call_latencies[]`	`EvaluationResult.ToolCallLatency` Solo output. La latenza di ogni chiamata allo strumento nel turno.
`semantic_similarity_result`	`EvaluationResult.SemanticSimilarityResult` Solo output. Il risultato del controllo della somiglianza semantica.
`overall_tool_invocation_result`	`EvaluationResult.OverallToolInvocationResult` Solo output. Il risultato del controllo complessivo dell'invocazione dello strumento.
`error_info`	`EvaluationErrorInfo` Solo output. Informazioni sull'errore che si è verificato durante questo turno.
`span_latencies[]`	`EvaluationResult.SpanLatency` Solo output. La latenza degli span nel turno.
`tool_ordered_invocation_score`	`float` Solo output. Il punteggio complessivo di chiamata allo strumento ordinato per questo turno. Indica la percentuale complessiva di strumenti della svolta prevista che sono stati effettivamente richiamati nell'ordine previsto.

HallucinationResult

Il risultato del controllo delle allucinazioni per un singolo turno.

Campi

label

string

Solo output. L'etichetta associata a ogni punteggio. Punteggio 1: Punteggio giustificato 0: Punteggio non giustificato -1: Nessuna rivendicazione da valutare

explanation

string

Solo output. La spiegazione del punteggio di allucinazione.

score

int32

Solo output. Il punteggio di allucinazione. Può essere -1, 0, 1.

Risultato

Il risultato della valutazione o dell'aspettativa.

Enum
`OUTCOME_UNSPECIFIED`	Il risultato della valutazione non è specificato.
`PASS`	Valutazione/aspettativa superata. Nel caso di una valutazione, significa che tutte le aspettative sono state soddisfatte.
`FAIL`	Valutazione/aspettativa non riuscita. Nel caso di una valutazione, ciò significa che almeno un'aspettativa non è stata soddisfatta.
`SKIPPED`	Valutazione/Aspettativa è stata ignorata.

OutcomeMetadata

Metadati sull'esito della valutazione.

Enum
`OUTCOME_METADATA_UNSPECIFIED`	Metadati del risultato non specificati.
`GRACEFUL_HANDOFF`	La valutazione ha portato a un trasferimento controllato a un rappresentante umano.

OverallToolInvocationResult

Il risultato del controllo complessivo dell'invocazione dello strumento.

Campi

outcome

EvaluationResult.Outcome

Solo output. Il risultato del controllo dell'invocazione dello strumento. Questo valore viene determinato confrontando tool_invocation_score con overall_tool_invocation_correctness_threshold. Se il punteggio è uguale o superiore alla soglia, il risultato sarà PASS. In caso contrario, il risultato sarà FAIL.

tool_invocation_score

float

Il punteggio complessivo di chiamata dello strumento per questo turno. Indica la percentuale complessiva di strumenti dell'intenzione prevista che sono stati effettivamente richiamati.

ScenarioExpectationOutcome

Il risultato di un'aspettativa di scenario.

Campi
`expectation`	`Evaluation.ScenarioExpectation` Solo output. L'aspettativa che è stata valutata.
`outcome`	`EvaluationResult.Outcome` Solo output. Il risultato di ScenarioExpectation.
Campo unione `result`. Il risultato dell'aspettativa. `result` può essere solo uno dei seguenti tipi:
`observed_tool_call`	`EvaluationResult.ScenarioExpectationOutcome.ObservedToolCall` Solo output. La chiamata allo strumento osservata.
`observed_agent_response`	`Message` Solo output. La risposta dell'agente osservata.

ObservedToolCall

La chiamata allo strumento e la risposta osservate.

Campi

tool_call

ToolCall

Solo output. La chiamata allo strumento osservata.

tool_response

ToolResponse

Solo output. La risposta dello strumento osservata.

ScenarioResult

Il risultato di una valutazione dello scenario.

Campi
`conversation`	`string` Solo output. La conversazione generata nello scenario.
`task`	`string` Solo output. L'attività utilizzata durante l'esecuzione dello scenario per questo risultato.
`user_facts[]`	`Evaluation.Scenario.UserFact` Solo output. I fatti sull'utente utilizzati dallo scenario per questo risultato.
`expectation_outcomes[]`	`EvaluationResult.ScenarioExpectationOutcome` Solo output. Il risultato di ogni aspettativa.
`rubric_outcomes[]`	`EvaluationResult.ScenarioRubricOutcome` Solo output. Il risultato della rubrica.
`hallucination_result[]`	`EvaluationResult.HallucinationResult` Solo output. Il risultato del controllo delle allucinazioni. Ci sarà un risultato di allucinazione per ogni turno della conversazione.
`task_completion_result (deprecated)`	`EvaluationResult.TaskCompletionResult` Questo elemento è obsoleto. Solo output. Il risultato del controllo del completamento dell'attività.
`tool_call_latencies[]`	`EvaluationResult.ToolCallLatency` Solo output. La latenza di ogni esecuzione della chiamata allo strumento nella conversazione.
`user_goal_satisfaction_result`	`EvaluationResult.UserGoalSatisfactionResult` Solo output. Il risultato del controllo della soddisfazione dell'obiettivo dell'utente.
`span_latencies[]`	`EvaluationResult.SpanLatency` Solo output. La latenza degli intervalli nella conversazione.
`evaluation_expectation_results[]`	`EvaluationResult.EvaluationExpectationResult` Solo output. I risultati delle aspettative di valutazione.
`all_expectations_satisfied`	`bool` Solo output. Indica se tutte le aspettative sono state soddisfatte per questo turno.
`task_completed`	`bool` Solo output. Indica se l'attività è stata completata per questo turno. Si tratta di un insieme di tutte le aspettative soddisfatte, senza allucinazioni e con la soddisfazione dell'obiettivo dell'utente.

ScenarioRubricOutcome

Il risultato della valutazione in base ai criteri.

Campi

rubric

string

Solo output. La rubrica utilizzata per valutare la conversazione.

score_explanation

string

Solo output. La risposta del valutatore alla griglia.

score

float

Solo output. Il punteggio della conversazione rispetto alla griglia.

SemanticSimilarityResult

Il risultato del controllo della somiglianza semantica.

Campi
`label`	`string` Solo output. L'etichetta associata a ogni punteggio. Punteggio 4: completamente coerente Punteggio 3: per lo più coerente Punteggio 2: parzialmente coerente (omissioni minori) Punteggio 1: in gran parte incoerente (omissioni maggiori) Punteggio 0: completamente incoerente / contraddittorio
`explanation`	`string` Solo output. La spiegazione del punteggio di somiglianza semantica.
`outcome`	`EvaluationResult.Outcome` Solo output. Il risultato del controllo della somiglianza semantica. Questo valore viene determinato confrontando il punteggio con semantic_similarity_success_threshold. Se il punteggio è uguale o superiore alla soglia, il risultato sarà PASS. In caso contrario, il risultato sarà FAIL.
`score`	`int32` Solo output. Il punteggio di similarità semantica. Può essere 0, 1, 2, 3 o 4.

SpanLatency

La latenza di un'esecuzione di span.

Campi
`type`	`EvaluationResult.SpanLatency.Type` Solo output. Il tipo di span.
`display_name`	`string` Solo output. Il nome visualizzato dello span. Applicabile agli intervalli di strumenti e sistemi di protezione.
`start_time`	`Timestamp` Solo output. L'ora di inizio dell'intervallo.
`end_time`	`Timestamp` Solo output. L'ora di fine dell'intervallo.
`execution_latency`	`Duration` Solo output. La latenza dello span.
Campo unione `identifier`. L'identificatore dell'elemento specifico in base al suo tipo. `identifier` può essere solo uno dei seguenti tipi:
`resource`	`string` Solo output. Il nome della risorsa degli intervalli di guardrail o strumenti.
`toolset`	`ToolsetTool` Solo output. L'identificatore dello strumento del toolset.
`model`	`string` Solo output. Il nome dello span LLM.
`callback`	`string` Solo output. Il nome dell'intervallo di callback dell'utente.

Tipo

Il tipo di span. In futuro potrebbero essere aggiunti altri valori.

Enum
`TYPE_UNSPECIFIED`	Valore predefinito. Questo valore non viene utilizzato.
`TOOL`	Intervallo di chiamata allo strumento.
`USER_CALLBACK`	Intervallo di richiamata dell'utente.
`GUARDRAIL`	Intervallo di contromisure.
`LLM`	LLM.

TaskCompletionResult

Il risultato del controllo del completamento dell'attività per la conversazione.

Campi

label

string

Solo output. L'etichetta associata a ogni punteggio. Punteggio 1: attività completata Punteggio 0: attività non completata Punteggio -1: obiettivo utente non definito

explanation

string

Solo output. La spiegazione del punteggio di completamento dell'attività.

score

int32

Solo output. Il punteggio di completamento dell'attività. Può essere -1, 0, 1

ToolCallLatency

La latenza di esecuzione di una chiamata dello strumento.

Campi
`tool`	`string` Solo output. Il nome dello strumento eseguito. Formato: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`.
`display_name`	`string` Solo output. Il nome visualizzato dello strumento.
`start_time`	`Timestamp` Solo output. L'ora di inizio dell'esecuzione della chiamata allo strumento.
`end_time`	`Timestamp` Solo output. L'ora di fine dell'esecuzione della chiamata allo strumento.
`execution_latency`	`Duration` Solo output. La latenza dell'esecuzione della chiamata dello strumento.

UserGoalSatisfactionResult

Il risultato di un controllo della soddisfazione dell'obiettivo dell'utente per una conversazione.

Campi

label

string

Solo output. L'etichetta associata a ogni punteggio. Punteggio 2: Punteggio di trasferimento controllato 1: Punteggio di attività utente soddisfatta 0: Punteggio di attività utente non soddisfatta -1: Punteggio di attività utente non specificata

explanation

string

Solo output. La spiegazione del punteggio di soddisfazione dell'attività dell'utente.

score

int32

Solo output. Il punteggio di soddisfazione dell'attività dell'utente. Può essere -1, 0, 1, 2.

EvaluationRun

Un'esecuzione di valutazione rappresenta tutti i risultati di valutazione di un'esecuzione di valutazione.

Campi
`name`	`string` Identificatore. L'identificatore univoco dell'esecuzione della valutazione. Formato: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`
`display_name`	`string` Facoltativo. Nome visualizzato definito dall'utente dell'esecuzione della valutazione. Valore predefinito: " run - ".
`evaluation_results[]`	`string` Solo output. I risultati della valutazione che fanno parte di questa esecuzione. Formato: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}`
`create_time`	`Timestamp` Solo output. Timestamp di creazione dell'esecuzione della valutazione.
`initiated_by`	`string` Solo output. L'utente che ha avviato l'esecuzione della valutazione.
`app_version`	`string` Solo output. La versione dell'app da valutare. Formato: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
`app_version_display_name`	`string` Solo output. Il nome visualizzato del `app_version` rispetto al quale è stata eseguita la valutazione.
`changelog`	`string` Solo output. Il log delle modifiche della versione dell'app su cui è stata eseguita la valutazione. Questo campo viene compilato se l'utente esegue la valutazione sull'ultima versione/bozza.
`changelog_create_time`	`Timestamp` Solo output. L'ora di creazione del log delle modifiche della versione dell'app rispetto alla quale è stata eseguita la valutazione. Questo campo viene compilato se l'utente esegue la valutazione sull'ultima versione/bozza.
`evaluations[]`	`string` Solo output. Le valutazioni che fanno parte di questa esecuzione. L'elenco può contenere valutazioni di entrambi i tipi. Questo campo si esclude a vicenda con `evaluation_dataset`. Formato: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`
`evaluation_dataset`	`string` Solo output. Il set di dati di valutazione a cui è associata questa esecuzione. Questo campo si esclude a vicenda con `evaluations`. Formato: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`
`evaluation_type`	`EvaluationRun.EvaluationType` Solo output. Il tipo di valutazioni in questa esecuzione.
`state`	`EvaluationRun.EvaluationRunState` Solo output. Lo stato dell'esecuzione della valutazione.
`progress`	`EvaluationRun.Progress` Solo output. L'avanzamento dell'esecuzione della valutazione.
`config`	`EvaluationConfig` Solo output. La configurazione utilizzata nell'esecuzione.
`error (deprecated)`	`Status` Questo elemento è obsoleto. Solo output. Deprecato: utilizza error_info. Errori rilevati durante l'esecuzione.
`error_info`	`EvaluationErrorInfo` Solo output. Informazioni sugli errori per l'esecuzione della valutazione.
`evaluation_run_summaries`	`map<string, EvaluationRun.EvaluationRunSummary>` Solo output. Mappa del nome della valutazione a EvaluationRunSummary.
`latency_report`	`LatencyReport` Solo output. Report sulla latenza per l'esecuzione della valutazione.
`run_count`	`int32` Solo output. Il numero di volte in cui sono state eseguite le valutazioni all'interno dell'esecuzione.
`persona_run_configs[]`	`PersonaRunConfig` Solo output. La configurazione da utilizzare per l'esecuzione per persona.
`optimization_config`	`OptimizationConfig` Facoltativo. Configurazione per l'esecuzione del passaggio di ottimizzazione dopo l'esecuzione della valutazione. Se non viene impostato, il passaggio di ottimizzazione non verrà eseguito.
`scheduled_evaluation_run`	`string` Solo output. Il nome della risorsa di esecuzione della valutazione pianificata che ha creato questa esecuzione della valutazione. Questo campo viene impostato solo se l'esecuzione della valutazione è stata creata da un'esecuzione della valutazione pianificata. Formato: `projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}`
`golden_run_method`	`GoldenRunMethod` Solo output. Il metodo utilizzato per eseguire la valutazione.
`operation`	`string` Solo output. L'operazione che ha creato questa esecuzione della valutazione. Formato: `projects/{project}/locations/{location}/operations/{operation}`

EvaluationRunState

Lo stato dell'esecuzione della valutazione.

Enum
`EVALUATION_RUN_STATE_UNSPECIFIED`	Lo stato dell'esecuzione della valutazione non è specificato.
`QUEUED`	Indica che l'esecuzione della valutazione è in coda.
`RUNNING`	L'esecuzione della valutazione è in corso.
`COMPLETED`	L'esecuzione della valutazione è stata completata.
`ERROR`	L'esecuzione della valutazione contiene un errore.
`CANCELLED`	L'esecuzione della valutazione è stata annullata.

EvaluationRunSummary

Contiene il riepilogo dei conteggi dei risultati superati e non superati per una valutazione specifica in un'esecuzione della valutazione.

Campi

passed_count

int32

Solo output. Numero di risultati superati per la valutazione associata in questa esecuzione.

failed_count

int32

Solo output. Numero di risultati non riusciti per la valutazione associata in questa esecuzione.

error_count

int32

Solo output. Numero di risultati di errore per la valutazione associata in questa esecuzione.

EvaluationType

Il tipo di valutazioni in questa esecuzione. In futuro potrebbero essere aggiunti altri valori.

Enum
`EVALUATION_TYPE_UNSPECIFIED`	Il tipo di valutazione non è specificato.
`GOLDEN`	Valutazione di riferimento.
`SCENARIO`	Valutazione dello scenario.
`MIXED`	Indica che l'esecuzione include un mix di valutazioni dorate e di scenari.

Avanzamento

L'avanzamento dell'esecuzione della valutazione.

Campi
`total_count`	`int32` Solo output. Numero totale di risultati della valutazione in questa esecuzione.
`failed_count`	`int32` Solo output. Numero di risultati della valutazione completati con esito NON RIUSCITO. (EvaluationResult.execution_state è COMPLETED e EvaluationResult.evaluation_status è FAIL).
`error_count`	`int32` Solo output. Numero di risultati della valutazione la cui esecuzione non è riuscita. (EvaluationResult.execution_state è ERROR).
`completed_count`	`int32` Solo output. Numero di risultati della valutazione completati correttamente. (EvaluationResult.execution_state è COMPLETED).
`passed_count`	`int32` Solo output. Numero di risultati della valutazione completati con esito PASS. (EvaluationResult.execution_state è COMPLETED e EvaluationResult.evaluation_status è PASS).
`cancelled_count`	`int32` Solo output. Numero di risultati della valutazione annullati. (EvaluationResult.execution_state is CANCELLED).

EvaluationRunCachingSettings

Impostazioni per la memorizzazione nella cache delle esecuzioni di valutazione.

Campi

run_caching_mode

EvaluationRunCachingSettings.EvaluationRunCachingMode

Facoltativo. La modalità di memorizzazione nella cache da utilizzare per l'esecuzione della valutazione. Se non viene impostato, il valore predefinito è FORCE_RUN.

EvaluationRunCachingMode

Il comportamento di memorizzazione nella cache dei risultati della valutazione. Controlla se restituire l'ultimo risultato della valutazione completata (se esistente) o eseguire una nuova valutazione.

Enum
`EVALUATION_RUN_CACHING_MODE_UNSPECIFIED`	La modalità di memorizzazione nella cache dell'esecuzione non è specificata.
`FORCE_RUN`	Esegui sempre una simulazione live completa, indipendentemente dalla presenza di changelog.
`SKIP_IF_UNCHANGED`	Salta l'esecuzione e copia i risultati verificati precedenti se non sono state modificate dipendenze e il canale di valutazione/metodo di esecuzione sono gli stessi.

EvaluationSettings

Impostazioni per la valutazione.

Campi
`scenario_conversation_initiator`	`EvaluationSettings.ScenarioConversationInitiator` Facoltativo. Chi inizia la conversazione in una valutazione dello scenario.
`golden_run_method`	`GoldenRunMethod` Facoltativo. Il metodo predefinito utilizzato per eseguire le valutazioni golden. Questo valore verrà utilizzato se non viene specificato alcun golden_run_method in RunEvaluationRequest.
`golden_evaluation_tool_call_behaviour`	`EvaluationToolCallBehaviour` Facoltativo. Configura il comportamento predefinito di chiamata dello strumento per le valutazioni golden.
`scenario_evaluation_tool_call_behaviour`	`EvaluationToolCallBehaviour` Facoltativo. Configura il comportamento predefinito di chiamata dello strumento per le valutazioni degli scenari.
`metrics_config`	`EvaluationMetricsConfig` Facoltativo. Configura le metriche predefinite per le valutazioni.
`scenario_execution_mode`	`EvaluationSettings.ScenarioExecutionMode` Facoltativo. La modalità di esecuzione per le valutazioni degli scenari. Se non viene fornito, il valore predefinito è QUALITY_OPTIMIZED.
`evaluation_run_caching_settings`	`EvaluationRunCachingSettings` Facoltativo. Le impostazioni di memorizzazione nella cache da utilizzare per l'esecuzione della valutazione.

ScenarioConversationInitiator

Determina chi avvia la conversazione in una sessione di valutazione dello scenario.

Enum
`SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED`	Non specificato. Il valore predefinito è USER.
`USER`	L'utente avvia la conversazione.
`AGENT`	L'agente avvia la conversazione.

ScenarioExecutionMode

La modalità di esecuzione per le valutazioni degli scenari.

Enum
`SCENARIO_EXECUTION_MODE_UNSPECIFIED`	Modalità di esecuzione non specificata. Il valore predefinito è QUALITY_OPTIMIZED.
`QUALITY_OPTIMIZED`	Modalità ottimizzata per la qualità.
`SPEED_OPTIMIZED`	Modalità ottimizzata per la velocità.

EvaluationToolCallBehaviour

Configura il comportamento della chiamata di funzione per le esecuzioni di valutazione.

Enum
`EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED`	Comportamento non specificato della chiamata allo strumento. Verranno utilizzate per impostazione predefinita chiamate di strumenti reali.
`REAL`	Utilizza chiamate di strumenti reali.
`FAKE`	Utilizza chiamate di strumenti falsi.

Evento

Input dell'evento.

Campi

event

string

Obbligatorio. Il nome dell'evento.

variables

ExperimentConfig.VersionRelease

Facoltativo. Variabili aggiuntive associate all'evento.

Esempio

Un esempio rappresenta una conversazione campione tra l'utente e l'agente o gli agenti.

Campi
`name`	`string` Identificatore. L'identificatore univoco dell'esempio. Formato: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`
`display_name`	`string` Obbligatorio. Nome visualizzato dell'esempio.
`description`	`string` Facoltativo. Descrizione leggibile dell'esempio.
`entry_agent`	`string` Facoltativo. L'agente che gestisce inizialmente la conversazione. Se non specificato, l'esempio rappresenta una conversazione gestita dall'agente principale. Formato: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
`messages[]`	`Message` Facoltativo. L'insieme dei messaggi che compongono la conversazione.
`create_time`	`Timestamp` Solo output. Timestamp di creazione dell'esempio.
`update_time`	`Timestamp` Solo output. Timestamp dell'ultimo aggiornamento dell'esempio.
`invalid`	`bool` Solo output. L'esempio potrebbe non essere più valido se le risorse di riferimento vengono eliminate. Gli esempi non validi non verranno utilizzati come esempi few-shot.
`etag`	`string` Etag utilizzato per garantire che l'oggetto non sia stato modificato durante un'operazione di lettura, modifica e scrittura. Se l'etag è vuoto, l'aggiornamento sovrascriverà eventuali modifiche simultanee.

ExecuteToolRequest

Messaggio di richiesta per ToolService.ExecuteTool.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa dell'app a cui appartiene lo strumento/il set di strumenti. Formato: `projects/{project}/locations/{location}/apps/{app}`
`args`	`Struct` Facoltativo. I parametri e i valori di input per lo strumento in formato oggetto JSON.
`mock_config`	`MockConfig` Facoltativo. Configurazione simulata per l'esecuzione dello strumento. Se questo campo è impostato, gli strumenti che chiamano altri strumenti verranno simulati in base ai pattern e alle risposte forniti.
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`	`string` Facoltativo. Il nome dello strumento da eseguire. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
`toolset_tool`	`ToolsetTool` Facoltativo. Lo strumento del toolset da eseguire. Solo uno strumento deve corrispondere al predicato del set di strumenti. In caso contrario, verrà restituito un errore.
Campo unione `tool_execution_context`. Il contesto aggiuntivo da fornire per l'esecuzione dello strumento `tool_execution_context` può essere solo uno dei seguenti tipi:
`variables`	`Struct` Facoltativo. Le variabili disponibili per l'esecuzione dello strumento.
`context`	`Struct` Facoltativo. [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment per i dettagli) da passare allo strumento Python.

ExecuteToolResponse

Messaggio di risposta per ToolService.ExecuteTool.

Campi
`response`	`Struct` 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 non vengono specificate le chiavi "output" ed "error", l'intera "response" viene trattata come risultato dell'esecuzione dello strumento.
`variables`	`Struct` I valori delle variabili alla fine dell'esecuzione dello strumento.
`citations`	`Citations` Citazioni che forniscono le informazioni sulla fonte per l'esecuzione dello strumento.
`google_search_suggestions`	`GoogleSearchSuggestions` I suggerimenti restituiti dalla Ricerca Google in seguito all'invocazione dello strumento della Ricerca Google durante l'esecuzione dello strumento.
Campo unione `tool_identifier`. L'identificatore dello strumento eseguito. `tool_identifier` può essere solo uno dei seguenti tipi:
`tool`	`string` Il nome dello strumento eseguito. Formato: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
`toolset_tool`	`ToolsetTool` Lo strumento del toolset che è stato eseguito.

ExecutionType

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

Enum
`EXECUTION_TYPE_UNSPECIFIED`	Il tipo di esecuzione non è specificato. Se non specificato, il valore predefinito è `SYNCHRONOUS`.
`SYNCHRONOUS`	Lo strumento viene eseguito in modo sincrono. La sessione viene bloccata finché lo strumento non viene restituito.
`ASYNCHRONOUS`	Lo strumento viene eseguito in modo asincrono. La sessione continuerà durante l'esecuzione dello strumento.

ExperimentConfig

Esperimento per il deployment.

Campi

version_release

Facoltativo. Versione rilasciata per l'esperimento.

Stato

Stato dell'esperimento.

Enum
`STATE_UNSPECIFIED`	Stato non specificato.
`PENDING`	Deprecato: questo stato non è più utilizzato.
`RUNNING`	Stato di esecuzione. L'esperimento è in corso ed è valido.
`DONE`	Deprecato: questo stato non è più utilizzato.
`EXPIRED`	Deprecato: questo stato non è più utilizzato.

VersionRelease

Versione rilasciata per l'esperimento.

Campi

state

ExperimentConfig.State

Facoltativo. Stato del rilascio della versione.

traffic_allocations[]

ExperimentConfig.VersionRelease.TrafficAllocation

Facoltativo. Allocazioni del traffico per la release della versione.

TrafficAllocation

Assegnazione del traffico per il rilascio della versione.

Campi

id

string

Facoltativo. ID dell'assegnazione del traffico. Stringa in formato libero, fino a 128 caratteri.

traffic_percentage

int32

Facoltativo. Percentuale di traffico dell'assegnazione del traffico. Il valore deve essere compreso tra 0 e 100.

app_version

string

Facoltativo. Versione dell'app dell'assegnazione del traffico. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}

ExportAppRequest

Messaggio di richiesta per AgentService.ExportApp.

Campi
`name`	`string` Obbligatorio. Il nome della risorsa dell'app da esportare.
`export_format`	`ExportAppRequest.ExportFormat` Obbligatorio. Il formato in cui esportare l'app.
`gcs_uri`	`string` Facoltativo. L'URI Google Cloud Storage in cui esportare l'app. Il formato di questo URI deve essere `gs://<bucket-name>/<object-name>`. L'archivio app esportato verrà scritto direttamente nell'oggetto GCS specificato.
`app_version`	`string` Facoltativo. Il nome della risorsa della versione dell'app da esportare. Formato: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`.

ExportFormat

Formato di esportazione per l'app.

Enum
`EXPORT_FORMAT_UNSPECIFIED`	Il formato di esportazione non è specificato.
`JSON`	Il formato di esportazione è JSON.
`YAML`	Il formato di esportazione è YAML.

ExportAppResponse

Messaggio di risposta per AgentService.ExportApp.

Campi

Campo unione app. L'app esportata. app può essere solo uno dei seguenti tipi:

app_content

bytes

Cartella dell'app compressa come file ZIP.

app_uri

string

L'URI Google Cloud Storage in cui è stata esportata l'app.

ExportEvaluationResultsOperationMetadata

Questo tipo non contiene campi.

Metadati dell'operazione per EvaluationService.ExportEvaluationResults.

ExportEvaluationResultsRequest

Messaggio di richiesta per EvaluationService.ExportEvaluationResults.

Campi

parent

string

Obbligatorio. Il nome della risorsa della valutazione da cui esportare i risultati. Formato: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

names[]

string

Obbligatorio. I nomi delle risorse dei risultati della valutazione da esportare.

export_options

ExportOptions

Facoltativo. Le opzioni di esportazione per i risultati della valutazione.

ExportEvaluationResultsResponse

Messaggio di risposta per EvaluationService.ExportEvaluationResults.

Campi

Campo unione evaluation_results. I risultati della valutazione esportati. evaluation_results può essere solo uno dei seguenti tipi:

evaluation_results_content

bytes

I contenuti dei risultati della valutazione esportati. Questo campo verrà compilato se gcs_uri non è stato specificato nella richiesta.

evaluation_results_uri

string

La cartella URI Google Cloud Storage in cui sono stati scritti i risultati dell'esportazione. Questo campo viene compilato se gcs_uri è stato specificato nella richiesta.

ExportEvaluationRunsOperationMetadata

Questo tipo non contiene campi.

Metadati dell'operazione per EvaluationService.ExportEvaluationRuns.

ExportEvaluationRunsRequest

Messaggio di richiesta per EvaluationService.ExportEvaluationRuns.

Campi

parent

string

Obbligatorio. Il nome della risorsa dell'app da cui esportare le esecuzioni della valutazione. Formato: projects/{project}/locations/{location}/apps/{app}

names[]

string

Obbligatorio. I nomi delle risorse delle esecuzioni della valutazione da esportare.

export_options

ExportOptions

Facoltativo. Le opzioni di esportazione per le esecuzioni della valutazione.

ExportEvaluationRunsResponse

Messaggio di risposta per EvaluationService.ExportEvaluationRuns.

Campi

Campo unione evaluation_runs. Le esecuzioni della valutazione esportate. evaluation_runs può essere solo uno dei seguenti tipi:

evaluation_runs_content

bytes

I contenuti delle esecuzioni di valutazione esportate. Questo campo verrà compilato se gcs_uri non è stato specificato nella richiesta.

evaluation_runs_uri

string

La cartella URI Google Cloud Storage in cui sono state scritte le esecuzioni di valutazione esportate. Questo campo viene compilato se gcs_uri è stato specificato nella richiesta.

ExportEvaluationsRequest

Messaggio di richiesta per EvaluationService.ExportEvaluations.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa dell'app da cui esportare le valutazioni. Formato: `projects/{project}/locations/{location}/apps/{app}`
`names[]`	`string` Obbligatorio. I nomi delle risorse delle valutazioni da esportare.
`export_options`	`ExportOptions` Facoltativo. Le opzioni di esportazione per le valutazioni.
`include_evaluation_results`	`bool` Facoltativo. Include i risultati della valutazione nell'esportazione. Deve essere impostato almeno uno dei valori include_evaluation_results o include_evaluations.
`include_evaluations`	`bool` Facoltativo. Include le valutazioni nell'esportazione. Deve essere impostato almeno uno dei valori include_evaluation_results o include_evaluations.

ExportEvaluationsResponse

Messaggio di risposta per EvaluationService.ExportEvaluations.

Campi
`failed_evaluations`	`map<string, string>` Solo output. Una mappa dei nomi delle risorse di valutazione che non è stato possibile esportare e il motivo del mancato caricamento.
Campo unione `evaluations`. Le valutazioni esportate. `evaluations` può essere solo uno dei seguenti tipi:
`evaluations_content`	`bytes` I contenuti delle valutazioni esportate. Questo campo verrà compilato se gcs_uri non è stato specificato nella richiesta.
`evaluations_uri`	`string` La cartella URI Google Cloud Storage in cui sono state scritte le valutazioni esportate. Questo campo viene compilato se gcs_uri è stato specificato nella richiesta.

ExportOptions

Opzioni per l'esportazione delle risorse di valutazione del CES.

Campi

export_format

ExportOptions.ExportFormat

Facoltativo. Il formato in cui esportare i risultati della valutazione. Se non specificato, il valore predefinito è JSON.

gcs_uri

string

Facoltativo. L'URI Google Cloud Storage in cui scrivere i risultati dell'esportazione.

ExportFormat

Il formato in cui esportare gli elementi. Se non specificato, il valore predefinito è JSON.

Enum
`EXPORT_FORMAT_UNSPECIFIED`	Formato non specificato.
`JSON`	o JSON.
`YAML`	formato YAML.

ExpressionCondition

Condizione dell'espressione basata sullo stato della sessione.

Campi

expression

string

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

FileContext

File da utilizzare come contesto. I file possono essere forniti come byte non elaborati.

Campi

Campo unione file. File fornito come contesto. file può essere solo uno dei seguenti tipi:

file_bytes

FileContext.FileBytes

Facoltativo. File fornito come byte non elaborati.

FileBytes

File fornito come byte non elaborati.

Campi

file_name

string

Obbligatorio. Il nome del file fornito come byte non elaborati.

mime_type

string

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

data

bytes

Obbligatorio. Byte non elaborati del file.

FileSearchTool

Lo strumento di ricerca dei file consente all'agente di eseguire ricerche nei file caricati dallo sviluppatore dell'app/dell'agente. Dispone di preset per fornire una ricerca di qualità relativamente buona sui file caricati e un riepilogo dei risultati recuperati.

Campi
`corpus_type`	`FileSearchTool.CorpusType` Facoltativo. Il tipo di corpus. Il valore predefinito è FULLY_MANAGED.
`name`	`string` Obbligatorio. Il nome dello strumento.
`description`	`string` Facoltativo. La descrizione dello strumento.
`file_corpus`	`string` Facoltativo. Il corpus in cui sono archiviati i file. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

CorpusType

Il tipo di corpus Vertex RAG.

Enum
`CORPUS_TYPE_UNSPECIFIED`	Tipo di corpus non specificato.
`USER_OWNED`	Il corpus viene creato e di proprietà dell'utente.
`FULLY_MANAGED`	Il corpus viene creato dall'agente.

GenerateAppResourceOperationMetadata

Metadati dell'operazione per AgentService.GenerateAppResource.

Campi
`generation_type`	`GenerateAppResourceOperationMetadata.GenerationType` Solo output. Il tipo di operazione.
`message`	`string` Solo output. Stato dell'operazione leggibile, se presente.
`create_time`	`Timestamp` Solo output. L'ora in cui è stata creata l'operazione.
`end_time`	`Timestamp` Solo output. L'ora in cui è terminata l'esecuzione dell'operazione.
`target`	`string` Solo output. Il nome della risorsa dell'app a cui è associata l'operazione. Formato: `projects/{project}/locations/{location}/apps/{app}`.
`partial_errors[]`	`Status` Solo output. Messaggi di errore del processo di generazione delle risorse.

GenerationType

Il tipo di operazione di generazione.

Enum
`GENERATION_TYPE_UNSPECIFIED`	Tipo di operazione non specificato.
`AGENT_RESTRUCTURE`	Tipo di ristrutturazione delle istruzioni dell'agente.
`AGENT_REFINE`	Tipo di perfezionamento delle istruzioni dell'agente.
`AGENT_CREATE`	Creazione dell'agente dal tipo.
`TOOL_CREATE`	Tipo di creazione dello strumento.
`SCENARIO_CREATE`	Tipo di creazione dello scenario.
`SCENARIO_CREATE_FROM_TRANSCRIPTS`	Creazione di scenari dal tipo di trascrizioni.
`EVALUATION_PERSONA_CREATE`	Tipo di generazione del personaggio di valutazione.
`QUALITY_REPORT_CREATE`	Tipo di generazione del report sulla qualità.
`INSTRUCTION_FOLLOWING_FIX`	Tipo di correzione del rispetto delle istruzioni (utilizzato per le correzioni di hill climbing).

GenerateAppResourceRequest

Messaggio di richiesta per AgentService.GenerateAppResource.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa dell'app per cui generare la risorsa.
`refine_instructions[]`	`GenerateAppResourceRequest.RefineInstructions` Facoltativo. Elenco delle istruzioni di perfezionamento da utilizzare per perfezionare la risorsa.
`tool_generation_config`	`GenerateAppResourceRequest.ToolGenerationConfig` Facoltativo. La configurazione da utilizzare per generare lo strumento.
`app_generation_config`	`GenerateAppResourceRequest.AppGenerationConfig` Facoltativo. La configurazione da utilizzare per generare gli agenti e gli strumenti.
`evaluation_generation_config`	`GenerateAppResourceRequest.EvaluationGenerationConfig` Facoltativo. La configurazione da utilizzare per generare le valutazioni.
`evaluation_personas_generation_config`	`GenerateAppResourceRequest.EvaluationPersonasGenerationConfig` Facoltativo. La configurazione da utilizzare per generare le buyer persona di valutazione.
`quality_report_generation_config`	`GenerateAppResourceRequest.QualityReportGenerationConfig` Facoltativo. La configurazione da utilizzare per la generazione del report sulla qualità.
`hill_climbing_fix_config`	`GenerateAppResourceRequest.HillClimbingFixConfig` Facoltativo. La configurazione da utilizzare per le correzioni di hill climbing.
Campo unione `resource`. La risorsa da generare. `resource` può essere solo uno dei seguenti tipi:
`agent`	`Agent` La risorsa agente da utilizzare per l'assistente LLM può essere vuota per generare un nuovo agente.
`tool`	`Tool` La risorsa dello strumento da utilizzare per l'assistente LLM può essere vuota per generare un nuovo strumento.
`toolset`	`Toolset` La risorsa del set di strumenti da utilizzare per l'assistente LLM può essere vuota per generare un nuovo set di strumenti.
`app_version_context`	`GenerateAppResourceRequest.AppVersionContext` Il contesto della versione dell'app che specifica lo snapshot di base e l'agente di destinazione.

AppGenerationConfig

La configurazione da utilizzare per generare l'app.

Campi
`context`	`string` Facoltativo. Il contesto che descrive i requisiti degli agenti e degli strumenti da generare.
`file_contexts[]`	`FileContext` Facoltativo. I file da utilizzare come contesto.
`dataset_id`	`string` Facoltativo. Il set di dati sugli approfondimenti da utilizzare per recuperare i dati delle conversazioni per generare gli agenti e gli strumenti. Formato: `projects/{project}/locations/{location}/datasets/{dataset}`.
`generate_evaluations`	`bool` Facoltativo. Indica se generare le valutazioni per l'app. Se true, il contesto fornito verrà utilizzato per generare i dati delle valutazioni.
`gcs_location`	`string` Facoltativo. La posizione di Cloud Storage in cui archiviare i dati delle risposte alle domande generate da utilizzare con lo strumento Datastore. Questi dati vengono generati solo quando si utilizzano i dati delle conversazioni come sorgente di ingresso. La posizione deve trovarsi nello stesso progetto dell'app. Formato: `gs://...`.

AppVersionContext

Il contesto della versione dell'app che specifica lo snapshot di base e l'agente di destinazione.

Campi

app_version

string

Il nome della risorsa della versione dell'app da utilizzare con l'assistente LLM. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}

agent_resource_name

L'algoritmo da utilizzare per l'attribuzione della perdita.

Enum
`LOSS_ATTRIBUTION_ALGORITHM_UNSPECIFIED`	Non specificato.
`APP_CENTRIC`	Attribuzione della perdita incentrata sulle app. Considera l'app come una singola unità.
`AGENT_CENTRIC`	Attribuzione della perdita incentrata sull'agente. Perdita di attributi per singoli agenti.

RefineInstructions

Le istruzioni da utilizzare per perfezionare una parte della risorsa. La parte della risorsa può essere specificata con un indice iniziale, un indice finale e una maschera di campo. Ad esempio, se vuoi perfezionare una parte delle istruzioni dell'agente, puoi specificare l'indice del primo carattere delle istruzioni, l'indice dell'ultimo carattere delle istruzioni e la maschera del campo come "instructions".

Campi
`start_index`	`int64` Obbligatorio. Il primo carattere (incluso) del testo da perfezionare.
`end_index`	`int64` Obbligatorio. L'ultimo carattere (incluso) del testo da perfezionare.
`field_mask`	`FieldMask` Obbligatorio. Il campo della risorsa che viene perfezionato. È consentito un solo campo per RefineInstructions. Se perfezioni le istruzioni dell'agente, la maschera del campo deve essere "instructions".
`instructions`	`string` Obbligatorio. Le istruzioni per perfezionare la risorsa.

ToolGenerationConfig

La configurazione da utilizzare per generare uno strumento.

Campi

context

string

Facoltativo. Il contesto che descrive lo strumento da generare. Può essere vuoto se vengono forniti la richiesta e la risposta dello strumento.

file_contexts[]

FileContext

Facoltativo. I file da utilizzare come contesto.

open_api_toolset_generation_config

GenerateAppResourceRequest.ToolGenerationConfig.OpenApiToolsetGenerationConfig

Facoltativo. La configurazione da utilizzare per generare uno schema Open API.

OpenApiToolsetGenerationConfig

La configurazione da utilizzare per generare uno schema Open API.

Campi

uri

string

Obbligatorio. L'URI di base dello strumento.

operation_generation_configs[]

GenerateAppResourceRequest.ToolGenerationConfig.OpenApiToolsetGenerationConfig.OperationGenerationConfig

Obbligatorio. L'elenco delle operazioni da aggiungere allo schema Open API.

OperationGenerationConfig

La configurazione da utilizzare per generare un'operazione nello schema OpenAPI.

Campi
`method`	`string` Obbligatorio. L'URI dello strumento. Se presenti, devono essere inclusi i parametri di query e di percorso.
`path`	`string` Obbligatorio. Il percorso dello strumento da aggiungere all'URI di base. Se presenti, devono essere inclusi i parametri di query e di percorso.
`request_json`	`string` Obbligatorio. Una richiesta di esempio allo strumento in formato JSON. Ignora se lo strumento non supporta il corpo della richiesta.
`response_json`	`string` Obbligatorio. Una risposta di esempio dello strumento in formato JSON.

GenerateAppResourceResponse

Messaggio di risposta per AgentService.GenerateAppResource.

Campi
`generate_result_info`	`GenerateAppResourceResponse.GenerateResultInfo` Informazioni aggiuntive sul risultato generato.
Campo unione `generated_resource`. La risorsa generata. `generated_resource` può essere solo uno dei seguenti tipi:
`agent`	`Agent` Agente generato dall'assistente LLM.
`toolset`	`Toolset` Set di strumenti generato dall'assistente LLM. Supporta la generazione dello schema del set di strumenti Open API.
`app_snapshot`	`AppSnapshot` Snapshot dell'app generato dall'assistente LLM. Questo snapshot contiene l'app, gli agenti e gli strumenti generati dall'assistente LLM.
`tools`	`GenerateAppResourceResponse.Tools` L'elenco degli strumenti generati dall'assistente LLM.
`evaluations`	`GenerateAppResourceResponse.Evaluations` Valutazioni generate dall'assistente LLM.
`app_resources`	`GenerateAppResourceResponse.AppResources` Le risorse dell'app generate dall'assistente LLM.
`quality_report`	`QualityReport` Il report sulla qualità generato dall'assistente LLM.

AppResources

L'elenco delle risorse dell'app generate dall'assistente LLM.

Campi

app_snapshot

AppSnapshot

Lo snapshot dell'app generato dall'assistente LLM. Questo snapshot contiene l'app, gli agenti e gli strumenti generati dall'assistente LLM.

evaluations[]

Evaluation

L'elenco delle valutazioni generate dall'assistente LLM.

Valutazioni

L'elenco delle valutazioni generate dall'assistente LLM.

Campi

evaluations[]

Evaluation

L'elenco delle valutazioni generate.

GenerateResultInfo

In questo modo, vengono fornite ulteriori informazioni sul risultato generato.

Campi

explanation

string

Una spiegazione delle modifiche nella risorsa generata.

Strumenti

L'elenco degli strumenti generati dall'assistente LLM.

Campi

tools[]

Tool

L'elenco degli strumenti generati dall'assistente LLM.

GenerateChatTokenRequest

Messaggio di richiesta per WidgetService.GenerateChatToken.

Campi
`name`	`string` Obbligatorio. Il nome della sessione per cui generare il token di chat. Formato: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
`deployment`	`string` Obbligatorio. Il deployment dell'app da utilizzare per la sessione. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
`recaptcha_token`	`string` Facoltativo. Il token reCAPTCHA generato dal widget di chat lato client.
`live_handoff_enabled`	`bool` Facoltativo. Indica se il trasferimento live è abilitato per la sessione.

GenerateChatTokenResponse

Messaggio di risposta per WidgetService.GenerateChatToken.

Campi

chat_token

string

Il token con ambito sessione per il widget di chat per l'autenticazione con le API Session.

expire_time

GenerateEvaluationRequest.EvaluationType

L'ora in cui scade il token della chat.

GenerateEvaluationOperationMetadata

Questo tipo non contiene campi.

Metadati dell'operazione per EvaluationService.GenerateEvaluation.

GenerateEvaluationRequest

Messaggio di richiesta per EvaluationService.GenerateEvaluation.

Campi

conversation

string

Obbligatorio. La conversazione per cui creare la valutazione di riferimento. Formato: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}

source
(deprecated)

Conversation.Source

Facoltativo. Indica l'origine della conversazione. Se non è impostato, verranno eseguite ricerche in tutte le fonti.

evaluation_type

Facoltativo. Il tipo di valutazione da generare. Se non specificato, il valore predefinito è GOLDEN.

EvaluationType

Il tipo di valutazione da generare.

Enum
`EVALUATION_TYPE_UNSPECIFIED`	Tipo non specificato. Il valore predefinito è GOLDEN.
`GOLDEN`	Valutazione di riferimento.
`SCENARIO`	Valutazione dello scenario.

GetAgentRequest

Messaggio di richiesta per AgentService.GetAgent.

Campi

name

string

Obbligatorio. Il nome della risorsa dell'agente da recuperare.

GetAppRequest

Messaggio di richiesta per AgentService.GetApp.

Campi

name

string

Obbligatorio. Il nome della risorsa dell'app da recuperare.

GetAppVersionRequest

Messaggio di richiesta per AgentService.GetAppVersion.

Campi

name

string

Obbligatorio. Il nome della risorsa della versione dell'app da recuperare.

GetChangelogRequest

Messaggio di richiesta per AgentService.GetChangelog.

Campi

name

string

Obbligatorio. Il nome della risorsa del log delle modifiche da recuperare.

GetConversationRequest

Messaggio di richiesta per AgentService.GetConversation.

Campi

name

string

Obbligatorio. Il nome della risorsa della conversazione da recuperare.

source
(deprecated)

string

Obbligatorio. Il nome della risorsa del toolset da recuperare.

GoAway

Questo tipo non contiene campi.

Indica che il server si disconnetterà a breve e che il client deve chiudere a metà e riavviare la connessione.

GoldenRunMethod

Il metodo utilizzato per eseguire la valutazione.

Enum
`GOLDEN_RUN_METHOD_UNSPECIFIED`	Il metodo di esecuzione non è specificato.
`STABLE`	Esegui la valutazione come replay stabile, in cui ogni turno è una sessione unica con i turni previsti precedenti inseriti come contesto.
`NAIVE`	Esegui la valutazione come riproduzione semplice, in cui l'esecuzione è una singola sessione senza contesto inserito.

GoogleSearchSuggestions

Suggerimenti di ricerca da Google Search Tool.

Campi

htmls[]

string

Stile HTML e CSS conforme per i suggerimenti di ricerca. L'HTML e il CSS forniti si adattano automaticamente alle impostazioni del dispositivo, visualizzando la modalità Luce o Buio indicata da @media(prefers-color-scheme).

web_search_queries[]

WebSearchQuery

Elenco delle query utilizzate per eseguire la ricerca Google insieme agli URI dei risultati di ricerca che formano i suggerimenti di ricerca.

GoogleSearchTool

Rappresenta uno strumento per eseguire ricerche web su Google per il grounding. Consulta la pagina https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search.

Campi
`name`	`string` Obbligatorio. Il nome dello strumento.
`description`	`string` Facoltativo. Descrizione dello scopo dello strumento.
`context_urls[]`	`string` Facoltativo. I contenuti verranno recuperati direttamente da questi URL per il contesto e la base. Esempio: "https://example.com/path.html". Sono consentiti al massimo 20 URL.
`preferred_domains[]`	`string` Facoltativo. Specifica i domini a cui limitare i risultati di ricerca. Esempio: "example.com", "another.site". È possibile specificare un massimo di 20 domini.
`exclude_domains[]`	`string` Facoltativo. Elenco dei domini da escludere dai risultati di ricerca. Esempio: "example.com". È possibile escludere un massimo di 2000 domini.
`prompt_config`	`GoogleSearchTool.PromptConfig` Facoltativo. Istruzioni del prompt trasmesse al planner su come devono essere elaborati i risultati di ricerca per il testo e la voce.

PromptConfig

Impostazioni del prompt utilizzate dal modello durante l'elaborazione o il riepilogo dei risultati della Ricerca Google.

Campi

text_prompt

string

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

voice_prompt

string

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.

Guardrail

Guardrail contiene un elenco di controlli ed equilibri per mantenere gli agenti sicuri.

Campi
`name`	`string` Identificatore. L'identificatore univoco del guardrail. Formato: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
`display_name`	`string` Obbligatorio. Nome visualizzato della barriera protettiva.
`description`	`string` Facoltativo. Descrizione della barriera protettiva.
`enabled`	`bool` Facoltativo. Indica se la protezione è attiva.
`action`	`TriggerAction` Facoltativo. Azione da intraprendere quando viene attivata la protezione.
`create_time`	`Timestamp` Solo output. Timestamp di creazione della barriera protettiva.
`update_time`	`Timestamp` Solo output. Timestamp dell'ultimo aggiornamento della barriera protettiva.
`etag`	`string` Etag utilizzato per garantire che l'oggetto non sia stato modificato durante un'operazione di lettura, modifica e scrittura. Se l'etag è vuoto, l'aggiornamento sovrascriverà eventuali modifiche simultanee.
Campo unione `guardrail_type`. Tipo di guardrail. `guardrail_type` può essere solo uno dei seguenti tipi:
`content_filter`	`Guardrail.ContentFilter` Facoltativo. Barriera protettiva che vieta l'utilizzo di determinati contenuti nella conversazione.
`llm_prompt_security`	`Guardrail.LlmPromptSecurity` Facoltativo. Misura di protezione che blocca la conversazione se il prompt è considerato non sicuro in base alla classificazione LLM.
`llm_policy`	`Guardrail.LlmPolicy` Facoltativo. Barriera di protezione che blocca la conversazione se la risposta dell'LLM viene considerata una violazione delle norme in base alla classificazione dell'LLM.
`model_safety`	`Guardrail.ModelSafety` Facoltativo. Barriera protettiva che blocca la conversazione se la risposta dell'LLM è considerata non sicura in base alle impostazioni di sicurezza del modello.
`code_callback`	`Guardrail.CodeCallback` Facoltativo. Barriera protettiva che blocca potenzialmente la conversazione in base al risultato dell'esecuzione del callback.
`supervisor`	`Guardrail.Supervisor` Facoltativo. Guardrail che esegue l'intervento del supervisore.

CodeCallback

Barriera che blocca la conversazione in base ai callback del codice forniti.

Campi
`before_agent_callback`	`Callback` 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.
`after_agent_callback`	`Callback` 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.
`before_model_callback`	`Callback` 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.
`after_model_callback`	`Callback` 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.

ContentFilter

Barriera protettiva che vieta l'utilizzo di determinati contenuti nella conversazione.

Campi
`banned_contents[]`	`string` Facoltativo. Elenco di frasi vietate. Si applica sia agli input utente sia alle risposte dell'agente.
`banned_contents_in_user_input[]`	`string` Facoltativo. Elenco di frasi vietate. Si applica solo agli input degli utenti.
`banned_contents_in_agent_response[]`	`string` Facoltativo. Elenco di frasi vietate. Si applica solo alle risposte degli agenti.
`match_type`	`Guardrail.ContentFilter.MatchType` Obbligatorio. Tipo di corrispondenza per il filtro dei contenuti.
`disregard_diacritics`	`bool` Facoltativo. Se è true, i segni diacritici vengono ignorati durante la ricerca di corrispondenze.

MatchType

Tipo di corrispondenza per il filtro dei contenuti.

Enum
`MATCH_TYPE_UNSPECIFIED`	Il tipo di corrispondenza non è specificato.
`SIMPLE_STRING_MATCH`	La corrispondenza dei contenuti viene eseguita per le sottostringhe carattere per carattere.
`WORD_BOUNDARY_STRING_MATCH`	La corrispondenza dei contenuti si verifica solo se il pattern trovato nel testo è racchiuso tra delimitatori di parole. Le frasi vietate possono contenere anche delimitatori di parole.
`REGEXP_MATCH`	I contenuti vengono abbinati utilizzando la sintassi delle espressioni regolari.

LlmPolicy

Barriera di protezione che blocca la conversazione se la risposta dell'LLM viene considerata una violazione delle norme in base alla classificazione dell'LLM.

Campi
`max_conversation_messages`	`int32` Facoltativo. Quando controlli questa norma, considera gli ultimi "n" messaggi della conversazione. Se non viene impostato, verrà utilizzato il valore predefinito 10.
`model_settings`	`ModelSettings` Facoltativo. Impostazioni del modello.
`prompt`	`string` Obbligatorio. Prompt delle norme.
`policy_scope`	`Guardrail.LlmPolicy.PolicyScope` Obbligatorio. Definisce quando applicare il controllo delle norme durante la conversazione. Se impostato su `POLICY_SCOPE_UNSPECIFIED`, il criterio verrà applicato all'input utente'utente. Quando applichi la policy alla risposta dell'agente, verrà introdotto un ulteriore ritardo prima che l'agente possa rispondere.
`fail_open`	`bool` Facoltativo. Se si verifica un errore durante il controllo delle norme, il sistema non interviene e non attiva la protezione.
`allow_short_utterance`	`bool` 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.

PolicyScope

Definisce quando applicare il controllo delle norme durante la conversazione.

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

LlmPromptSecurity

Barriera protettiva che blocca la conversazione se l'input è considerato non sicuro in base alla classificazione LLM.

Campi
`fail_open`	`bool` Facoltativo. Determina il comportamento quando la barriera di protezione rileva un errore LLM. - Se true: la barriera protettiva viene ignorata. - Se il valore è false (impostazione predefinita), il guardrail viene attivato/bloccato. Nota: se viene fornita una policy personalizzata, questo campo viene ignorato a favore della configurazione "fail_open" della policy.
Campo unione `security_config`. Definisce la modalità di configurazione della sicurezza. L'utente deve scegliere una delle seguenti configurazioni. `security_config` può essere solo uno dei seguenti tipi:
`default_settings`	`Guardrail.LlmPromptSecurity.DefaultSecuritySettings` Facoltativo. Utilizza le impostazioni di sicurezza predefinite del sistema. Per selezionare questa modalità, includi un messaggio "default_settings" vuoto nella richiesta. Il campo "default_prompt_template" al suo interno verrà compilato dal server nella risposta.
`custom_policy`	`Guardrail.LlmPolicy` Facoltativo. Utilizza una LlmPolicy definita dall'utente per configurare la barriera di sicurezza.

DefaultSecuritySettings

Configurazione delle impostazioni di sicurezza del sistema predefinite.

Campi

default_prompt_template

string

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

ModelSafety

Override delle impostazioni di sicurezza del modello. Se questa opzione è impostata, esegue l'override delle impostazioni predefinite e attiva la barriera protettiva se la risposta è considerata non sicura.

Campi

safety_settings[]

Guardrail.ModelSafety.SafetySetting

Obbligatorio. Elenco delle impostazioni di sicurezza.

HarmBlockThreshold

Livelli di soglia basati sulla probabilità per il blocco.

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

HarmCategory

Categoria del danno.

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

SafetySetting

Impostazione di sicurezza.

Campi

category

Guardrail.ModelSafety.HarmCategory

Obbligatorio. La categoria del danno.

threshold

Guardrail.ModelSafety.HarmBlockThreshold

Obbligatorio. Soglia di blocco dei contenuti dannosi.

Supervisore

Guardrail che esegue l'intervento del supervisore.

Campi

type

Guardrail.Supervisor.Type

Facoltativo. Il tipo di supervisore.

detection_mode

Guardrail.Supervisor.DetectionMode

Facoltativo. La modalità di rilevamento del supervisore.

DetectionMode

Modalità di rilevamento del supervisore.

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

Tipo

Tipo di supervisore.

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

Immagine

Rappresenta un input o un output di immagine nella conversazione.

Campi

mime_type

string

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

data

bytes

Obbligatorio. Byte non elaborati dell'immagine.

alt_text

string

Facoltativo. Il testo alternativo per l'immagine.

ImportAppRequest

Messaggio di richiesta per AgentService.ImportApp.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa padre con la posizione dell'app da importare.
`display_name`	`string` Facoltativo. Il nome visualizzato dell'app da importare. * Se l'app viene creata durante l'importazione e viene specificato il nome visualizzato, l'app importata utilizzerà questo nome visualizzato. Se viene rilevato un conflitto con un'app esistente, al nome visualizzato viene aggiunto un timestamp per renderlo univoco. * Se l'app viene reimportata, questo campo non deve essere impostato. Se fornisci un nome visualizzato durante la reimportazione, si verifica un errore INVALID_ARGUMENT.
`app_id`	`string` Facoltativo. L'ID da utilizzare per l'app importata. * Se non specificato, verrà assegnato automaticamente un ID univoco per l'app. * In caso contrario, l'app importata utilizzerà questo ID come componente finale del nome risorsa. Se esiste già un'app con lo stesso ID nella posizione specificata del progetto, il contenuto dell'app esistente verrà sostituito.
`import_options`	`ImportAppRequest.ImportOptions` Facoltativo. Opzioni che regolano il processo di importazione per l'app.
`ignore_app_lock`	`bool` Facoltativo. Flag per ignorare il blocco dell'app durante l'importazione. Se impostato su true, il processo di importazione ignorerà il blocco dell'app.
Campo unione `app`. L'app da importare. `app` può essere solo uno dei seguenti tipi:
`gcs_uri`	`string` L'URI Google Cloud Storage da cui importare l'app. Il formato di questo URI deve essere `gs://<bucket-name>/<object-name>`.
`app_content`	`bytes` Byte non elaborati che rappresentano il file ZIP compresso con la struttura delle cartelle dell'app.
Campo unione `json_patch`. Le patch JSON da applicare all'app importata. `json_patch` può essere solo uno dei seguenti tipi:
`json_patch_content`	`string` Facoltativo. Contenuto della patch come stringa JSON.
`json_patch_gcs_uri`	`string` Facoltativo. Un URI Cloud Storage che rimanda a un file JSON contenente le patch.

ImportOptions

Opzioni di configurazione per il processo di importazione delle app. Queste opzioni controllano il comportamento dell'importazione, in particolare quando si verificano conflitti con i dati delle app esistenti.

Campi

conflict_resolution_strategy

ImportAppRequest.ImportOptions.ConflictResolutionStrategy

Facoltativo. La strategia da utilizzare per risolvere i conflitti durante l'importazione.

validate_only

bool

Facoltativo. Flag per l'esecuzione di una prova dry run della procedura di importazione. Se impostato su true, il processo di importazione eseguirà solo le convalide e non apporterà modifiche all'app esistente né ne creerà una nuova.

ConflictResolutionStrategy

Definisce la strategia per la gestione dei conflitti quando esiste già un'app con lo stesso ID o quando le risorse importate (come agenti, strumenti e così via) hanno gli stessi nomi visualizzati delle risorse esistenti all'interno dell'app.

Enum
`CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED`	La strategia di risoluzione dei conflitti non è specificata.
`REPLACE`	Sostituisci i dati esistenti con quelli importati. Se esiste già un'app con lo stesso `app_id`, i suoi contenuti verranno aggiornati in base all'app importata. - Le risorse (app, agenti, strumenti, esempi, linee guida, toolset) nell'app importata che hanno lo stesso nome visualizzato delle risorse esistenti sovrascriveranno quelle esistenti. - Verranno create risorse importate con nuovi nomi visualizzati. - Le risorse esistenti che non hanno un nome visualizzato corrispondente nell'app importata rimarranno invariate.
`OVERWRITE`	Sovrascrivere i dati esistenti con i dati importati. Se esiste già un'app con lo stesso `app_id`, i suoi contenuti verranno sovrascritti con l'app importata. - Le risorse esistenti (agenti, strumenti, esempi, protezioni, set di strumenti) nell'app verranno eliminate. - Le risorse importate verranno create come nuove risorse.

ImportAppResponse

Messaggio di risposta per AgentService.ImportApp.

Campi

name

string

Il nome della risorsa dell'app importata.

warnings[]

string

Messaggi di avviso generati durante il processo di importazione. Se si verificano errori per risorse specifiche, queste non verranno incluse nell'app importata e l'errore verrà menzionato qui.

ImportEvaluationsOperationMetadata

Rappresenta i metadati dell'operazione a lunga esecuzione per EvaluationService.ImportEvaluations.

Campi

create_time

Solo output. L'ora in cui è stata creata l'operazione.

end_time

ImportEvaluationsRequest.ImportOptions.ConflictResolutionStrategy

Solo output. L'ora in cui è terminata l'esecuzione dell'operazione.

status_message

string

Solo output. Stato dell'operazione leggibile, se presente.

ImportEvaluationsRequest

Messaggio di richiesta per EvaluationService.ImportEvaluations.

Campi
`parent`	`string` Obbligatorio. L'app in cui importare le valutazioni. Formato: `projects/{project}/locations/{location}/apps/{app}`
`import_options`	`ImportEvaluationsRequest.ImportOptions` Facoltativo. Opzioni che regolano la procedura di importazione delle valutazioni.
Campo unione `source`. L'origine delle valutazioni da importare. `source` può essere solo uno dei seguenti tipi:
`conversation_list`	`ImportEvaluationsRequest.ConversationList` Le conversazioni da cui importare le valutazioni.
`gcs_uri`	`string` L'URI Google Cloud Storage da cui importare le valutazioni. Il formato di questo URI deve essere `gs://<bucket-name>/<object-name>`.
`csv_content`	`bytes` Byte non elaborati che rappresentano il file CSV con la struttura delle valutazioni.

ConversationList

Un elenco di nomi di risorse di conversazione.

Campi

conversations[]

string

Facoltativo. Nomi delle risorse di conversazione.

ImportOptions

Opzioni di configurazione per il processo di importazione della valutazione. Queste opzioni controllano il comportamento dell'importazione, in particolare quando si verificano conflitti con i dati di valutazione esistenti.

Campi

conflict_resolution_strategy

Facoltativo. La strategia da utilizzare per risolvere i conflitti durante l'importazione.

ConflictResolutionStrategy

Definisce la strategia per la gestione dei conflitti quando nell'app esiste già una valutazione con lo stesso ID valutazione.

Enum
`CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED`	La strategia di risoluzione dei conflitti non è specificata.
`OVERWRITE`	Sovrascrivi la valutazione esistente con quella nuova.
`SKIP`	Mantieni la valutazione esistente e ignora quella nuova.
`DUPLICATE`	Mantieni la valutazione esistente e duplica quella nuova come nuova valutazione.

ImportEvaluationsResponse

Messaggio di risposta per EvaluationService.ImportEvaluations.

Campi
`evaluations[]`	`Evaluation` L'elenco delle valutazioni importate nell'app.
`evaluation_results[]`	`EvaluationResult` L'elenco dei risultati della valutazione importati nell'app.
`evaluation_runs[]`	`EvaluationRun` L'elenco delle esecuzioni di valutazione importate nell'app.
`error_messages[]`	`string` Facoltativo. Un elenco di messaggi di errore associati alle valutazioni per le quali l'importazione non è riuscita.
`import_failure_count`	`int32` Il numero di valutazioni per cui l'importazione non è riuscita completamente o è stata completata con uno o più errori.
`evaluation_result_import_failure_count`	`int32` Il numero di risultati della valutazione che non sono stati importati completamente o che sono stati importati con uno o più errori.
`evaluation_run_import_failure_count`	`int32` Il numero di esecuzioni della valutazione che non sono state importate completamente o che sono state importate con uno o più errori.

InputAudioConfig

InputAudioConfig configura la modalità di interpretazione dei dati audio in arrivo da parte dell'agente CES.

Campi

audio_encoding

AudioEncoding

Obbligatorio. La codifica dei dati audio di input.

sample_rate_hertz

int32

Obbligatorio. La frequenza di campionamento (in hertz) dei dati audio di input.

noise_suppression_level

string

Facoltativo. Se attivare l'eliminazione dei rumori nell'audio di input. I valori disponibili sono "low", "moderate", "high", "very_high".

InstagramCredentials

Credenziali Meta temporanee per l'integrazione nativa di Instagram.

Campi

auth_code

string

Obbligatorio. Il codice di autorizzazione Meta fornito dal flusso di registrazione incorporato.

conversation_profile_id

string

Facoltativo. L'ID profilo di conversazione da utilizzare per il deployment.

InterruptionSignal

Indica che la risposta audio dell'agente è stata interrotta. Il client deve interrompere immediatamente la riproduzione audio corrente (ad es. a causa dell'interruzione dell'utente o della generazione di una nuova risposta dell'agente).

Campi

barge_in

bool

Se l'interruzione è causata da un evento di interruzione dell'utente.

LanguageSettings

Impostazioni della lingua dell'app.

Campi
`default_language_code`	`string` Facoltativo. Il codice lingua predefinito dell'app.
`supported_language_codes[]`	`string` Facoltativo. Elenco dei codici lingua supportati dall'app, oltre a `default_language_code`.
`enable_multilingual_support`	`bool` Facoltativo. Consente il supporto multilingue. Se è true, gli agenti nell'app utilizzeranno istruzioni predefinite per migliorare la gestione dell'input multilingue.
`fallback_action (deprecated)`	`string` Questo elemento è obsoleto. Facoltativo. Deprecata: questa funzionalità non è più supportata. Utilizza invece `enable_multilingual_support` per migliorare la gestione dell'input multilingue. 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 completo della risorsa 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 `EndSession` con `metadata` corrispondente per terminare la conversazione.

LatencyReport

Report sulla latenza per l'esecuzione della valutazione.

Campi
`tool_latencies[]`	`LatencyReport.ToolLatency` Solo output. Elenco non ordinato. Metriche di latenza per ogni strumento.
`callback_latencies[]`	`LatencyReport.CallbackLatency` Solo output. Elenco non ordinato. Metriche di latenza per ogni callback.
`guardrail_latencies[]`	`LatencyReport.GuardrailLatency` Solo output. Elenco non ordinato. Metriche di latenza per ogni guardrail.
`llm_call_latencies[]`	`LatencyReport.LlmCallLatency` Solo output. Elenco non ordinato. Metriche di latenza per ogni chiamata LLM.
`session_count`	`int32` Solo output. Il numero totale di sessioni prese in considerazione nel report sulla latenza.

CallbackLatency

Metriche di latenza per un singolo callback.

Campi

stage

string

Solo output. La fase del callback.

latency_metrics

LatencyReport.LatencyMetrics

Solo output. Le metriche di latenza per il callback.

GuardrailLatency

Metriche di latenza per una singola barriera di protezione.

Campi

guardrail

string

Solo output. Il nome della barriera protettiva. Formato: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}.

guardrail_display_name

string

Solo output. Il nome visualizzato del guardrail.

latency_metrics

LatencyReport.LatencyMetrics

Solo output. Le metriche di latenza per il controllo.

LatencyMetrics

Metriche di latenza per un componente.

Campi
`p50_latency`	`Duration` Solo output. Latenza del 50° percentile.
`p90_latency`	`Duration` Solo output. Latenza 90° percentile.
`p99_latency`	`Duration` Solo output. Latenza del 99° percentile.
`call_count`	`int32` Solo output. Il numero di volte in cui è stata chiamata la risorsa.

LlmCallLatency

Metriche di latenza per una singola chiamata LLM.

Campi

model

string

Solo output. Il nome del modello.

latency_metrics

LatencyReport.LatencyMetrics

Solo output. Le metriche di latenza per la chiamata LLM.

ToolLatency

Metriche di latenza per un singolo strumento.

Campi
`tool_display_name`	`string` Solo output. Il nome visualizzato dello strumento.
`latency_metrics`	`LatencyReport.LatencyMetrics` Solo output. Le metriche di latenza per lo strumento.
Campo unione `tool_identifier`. L'identificatore dello strumento. `tool_identifier` può essere solo uno dei seguenti tipi:
`tool`	`string` Solo output. Formato: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`.
`toolset_tool`	`ToolsetTool` Solo output. L'identificatore dello strumento del toolset.

ListAgentsRequest

Messaggio di richiesta per AgentService.ListAgents.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa dell'app da cui elencare gli agenti.
`page_size`	`int32` Facoltativo. Dimensioni della pagina richiesta. Il server potrebbe restituire meno elementi di quelli richiesti. Se non specificato, il server sceglierà un valore predefinito appropriato.
`page_token`	`string` Facoltativo. Il valore `next_page_token` restituito da una precedente chiamata dell'elenco `AgentService.ListAgents`.
`filter`	`string` Facoltativo. Filtro da applicare quando vengono elencati gli agenti. Per maggiori dettagli, visita la pagina https://google.aip.dev/160.
`order_by`	`string` Facoltativo. Campo in base al quale ordinare. Sono supportati solo "name" e "create_time". Per maggiori dettagli, visita la pagina https://google.aip.dev/132#ordering.

ListAgentsResponse

Messaggio di risposta per AgentService.ListAgents.

Campi

agents[]

Agent

L'elenco degli agenti.

next_page_token

string

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

ListAppVersionsRequest

Messaggio di richiesta per AgentService.ListAppVersions.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa dell'app da cui elencare le versioni dell'app.
`page_size`	`int32` Facoltativo. Dimensioni della pagina richiesta. Il server potrebbe restituire meno elementi di quelli richiesti. Se non specificato, il server sceglierà un valore predefinito appropriato.
`page_token`	`string` Facoltativo. Il valore `next_page_token` restituito da una precedente chiamata dell'elenco `AgentService.ListAppVersions`.
`filter`	`string` Facoltativo. Filtro da applicare durante l'elenco delle versioni dell'app. Per maggiori dettagli, visita la pagina https://google.aip.dev/160.
`order_by`	`string` Facoltativo. Campo in base al quale ordinare. Sono supportati solo "name" e "create_time". Per maggiori dettagli, visita la pagina https://google.aip.dev/132#ordering.

ListAppVersionsResponse

Messaggio di risposta per AgentService.ListAppVersions.

Campi

app_versions[]

AppVersion

L'elenco delle versioni dell'app.

next_page_token

string

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

ListAppsRequest

Messaggio di richiesta per AgentService.ListApps.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa della posizione da cui elencare le app.
`page_size`	`int32` Facoltativo. Dimensioni della pagina richiesta. Il server potrebbe restituire meno elementi di quelli richiesti. Se non specificato, il server sceglierà un valore predefinito appropriato.
`page_token`	`string` Facoltativo. Il valore `next_page_token` restituito da una precedente chiamata dell'elenco `AgentService.ListApps`.
`filter`	`string` Facoltativo. Filtro da applicare durante l'elenco delle app. Per maggiori dettagli, visita la pagina https://google.aip.dev/160.
`order_by`	`string` Facoltativo. Campo in base al quale ordinare. Sono supportati solo "name" e "create_time". Per maggiori dettagli, visita la pagina https://google.aip.dev/132#ordering.

ListAppsResponse

Messaggio di risposta per AgentService.ListApps.

Campi

apps[]

App

L'elenco delle app.

next_page_token

string

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

unreachable[]

string

Elenco non ordinato. Località non raggiungibili.

ListChangelogsRequest

Messaggio di richiesta per AgentService.ListChangelogs.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa dell'app da cui elencare i log delle modifiche.
`page_size`	`int32` Facoltativo. Dimensioni della pagina richiesta. Il server potrebbe restituire meno elementi di quelli richiesti. Se non specificato, il server sceglierà un valore predefinito appropriato.
`page_token`	`string` Facoltativo. Il valore `next_page_token` restituito da una precedente chiamata dell'elenco `AgentService.ListChangelogs`.
`filter`	`string` Facoltativo. Filtro da applicare quando vengono elencati i log delle modifiche. Per maggiori dettagli, visita la pagina https://google.aip.dev/160. La stringa di filtro può essere utilizzata per filtrare in base a `action`, `resource_type`, `resource_name`, `author` e `create_time`. Il comparatore `:` può essere utilizzato per la corrispondenza parziale senza distinzione tra maiuscole e minuscole nei campi stringa, mentre `=` esegue una corrispondenza esatta sensibile alle maiuscole. Esempi: * `action:update` (corrispondenza parziale senza distinzione tra maiuscole e minuscole) * `action="Create"` (corrispondenza esatta con distinzione tra maiuscole e minuscole) * `resource_type:agent` * `resource_name:my-agent` * `author:me@example.com` * `create_time > "2025-01-01T00:00:00Z"` * `create_time <= "2025-01-01T00:00:00Z" AND resource_type:tool`
`order_by`	`string` Facoltativo. Campo in base al quale ordinare. Sono supportati solo "name" e "create_time". Per maggiori dettagli, visita la pagina https://google.aip.dev/132#ordering.

ListChangelogsResponse

Messaggio di risposta per AgentService.ListChangelogs.

Campi

changelogs[]

Changelog

L'elenco dei log delle modifiche.

next_page_token

string

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

ListConversationsRequest

Messaggio di richiesta per AgentService.ListConversations.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa dell'app da cui elencare le conversazioni.
`page_size`	`int32` Facoltativo. Dimensioni della pagina richiesta. Il server potrebbe restituire meno elementi di quelli richiesti. Se non specificato, il server sceglierà un valore predefinito appropriato.
`page_token`	`string` Facoltativo. Il valore `next_page_token` restituito da una precedente chiamata dell'elenco `AgentService.ListConversations`.
`filter`	`string` Facoltativo. Filtro da applicare quando vengono elencate le conversazioni. Per maggiori dettagli, visita la pagina https://google.aip.dev/160.
`source`	`Conversation.Source` Facoltativo. Indica l'origine della conversazione. Se non viene impostato, Source.Live verrà applicato per impostazione predefinita. Verrà ritirato a favore del campo `sources`.
`sources[]`	`Conversation.Source` Facoltativo. Indica le fonti delle conversazioni. Se non viene impostato, per impostazione predefinita verranno applicate tutte le origini disponibili.

ListConversationsResponse

Messaggio di risposta per AgentService.ListConversations.

Campi

conversations[]

Conversation

L'elenco delle conversazioni.

next_page_token

string

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

ListDeploymentsRequest

Messaggio di richiesta per AgentService.ListDeployments.

Campi
`parent`	`string` Obbligatorio. L'app genitore. Formato: `projects/{project}/locations/{location}/apps/{app}`
`page_size`	`int32` Facoltativo. Il numero massimo di deployment da restituire. Il servizio potrebbe restituire un numero inferiore a questo valore. Se non specificato, verranno restituiti al massimo 50 deployment. Il valore massimo è 1000; i valori superiori a 1000 verranno forzati a 1000.
`page_token`	`string` Facoltativo. Un token di pagina ricevuto da una precedente chiamata `ListDeployments`. Forniscilo per recuperare la pagina successiva. Durante la paginazione, tutti gli altri parametri forniti a `ListDeployments` devono corrispondere alla chiamata che ha fornito il token di pagina.
`order_by`	`string` Facoltativo. Campo in base al quale ordinare. Sono supportati solo "name" e "create_time". Per maggiori dettagli, visita la pagina https://google.aip.dev/132#ordering.

ListDeploymentsResponse

Messaggio di risposta per AgentService.ListDeployments.

Campi

deployments[]

Deployment

L'elenco dei deployment.

next_page_token

string

Un token, che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

ListEvaluationDatasetsRequest

Messaggio di richiesta per EvaluationService.ListEvaluationDatasets.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa dell'app da cui elencare i set di dati di valutazione.
`page_size`	`int32` Facoltativo. Dimensioni della pagina richiesta. Il server potrebbe restituire meno elementi di quelli richiesti. Se non specificato, il server sceglierà un valore predefinito appropriato.
`page_token`	`string` Facoltativo. Il valore `next_page_token` restituito da una precedente chiamata dell'elenco `EvaluationService.ListEvaluationDatasets`.
`filter`	`string` Facoltativo. Filtro da applicare durante l'elenco dei set di dati di valutazione. Per maggiori dettagli, visita la pagina https://google.aip.dev/160.
`order_by`	`string` Facoltativo. Campo in base al quale ordinare. Sono supportati solo "name", "create_time" e "update_time". I campi temporali sono ordinati in ordine decrescente, mentre il campo del nome è ordinato in ordine crescente. Se non è incluso, il valore predefinito sarà "update_time". Per maggiori dettagli, visita la pagina https://google.aip.dev/132#ordering.

ListEvaluationDatasetsResponse

Messaggio di risposta per EvaluationService.ListEvaluationDatasets.

Campi

evaluation_datasets[]

EvaluationDataset

L'elenco dei set di dati di valutazione.

next_page_token

string

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

ListEvaluationExpectationsRequest

Messaggio di richiesta per EvaluationService.ListEvaluationExpectations.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa dell'app da cui elencare le aspettative di valutazione.
`page_size`	`int32` Facoltativo. Dimensioni della pagina richiesta. Il server potrebbe restituire meno elementi di quelli richiesti. Se non specificato, il server sceglierà un valore predefinito appropriato.
`page_token`	`string` Facoltativo. Il valore `next_page_token` restituito da una precedente chiamata dell'elenco `EvaluationService.ListEvaluationExpectations`.
`filter`	`string` Facoltativo. Filtro da applicare quando vengono elencate le aspettative di valutazione. Per maggiori dettagli, visita la pagina https://google.aip.dev/160.
`order_by`	`string` Facoltativo. Campo in base al quale ordinare. Sono supportati solo "name", "create_time" e "update_time". I campi temporali sono ordinati in ordine decrescente, mentre il campo del nome è ordinato in ordine crescente. Se non è incluso, il valore predefinito sarà "update_time". Per maggiori dettagli, visita la pagina https://google.aip.dev/132#ordering.

ListEvaluationExpectationsResponse

Messaggio di risposta per EvaluationService.ListEvaluationExpectations.

Campi

evaluation_expectations[]

EvaluationExpectation

L'elenco delle aspettative di valutazione.

next_page_token

string

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

ListEvaluationResultsRequest

Messaggio di richiesta per EvaluationService.ListEvaluationResults.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa della valutazione da cui elencare i risultati della valutazione. Per filtrare in base all'esecuzione della valutazione, utilizza `-` come ID valutazione e specifica l'ID esecuzione della valutazione nel filtro. Ad esempio: `projects/{project}/locations/{location}/apps/{app}/evaluations/-`
`page_size`	`int32` Facoltativo. Dimensioni della pagina richiesta. Il server potrebbe restituire meno elementi di quelli richiesti. Se non specificato, il server sceglierà un valore predefinito appropriato.
`page_token`	`string` Facoltativo. Il valore `next_page_token` restituito da una precedente chiamata dell'elenco `EvaluationService.ListEvaluationResults`.
`filter`	`string` Facoltativo. Filtro da applicare quando vengono elencati i risultati della valutazione. Per maggiori dettagli, visita la pagina https://google.aip.dev/160.
`order_by`	`string` Facoltativo. Campo in base al quale ordinare. Sono supportati solo "name", "create_time" e "update_time". I campi temporali sono ordinati in ordine decrescente, mentre il campo del nome è ordinato in ordine crescente. Se non è incluso, il valore predefinito sarà "update_time". Per maggiori dettagli, visita la pagina https://google.aip.dev/132#ordering.

ListEvaluationResultsResponse

Messaggio di risposta per EvaluationService.ListEvaluationResults.

Campi

evaluation_results[]

EvaluationResult

L'elenco dei risultati della valutazione.

next_page_token

string

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

ListEvaluationRunsRequest

Messaggio di richiesta per EvaluationService.ListEvaluationRuns.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa dell'app da cui elencare le esecuzioni della valutazione.
`page_size`	`int32` Facoltativo. Dimensioni della pagina richiesta. Il server potrebbe restituire meno elementi di quelli richiesti. Se non specificato, il server sceglierà un valore predefinito appropriato.
`page_token`	`string` Facoltativo. Il valore `next_page_token` restituito da una precedente chiamata dell'elenco `EvaluationService.ListEvaluationRuns`.
`filter`	`string` Facoltativo. Filtro da applicare durante l'elenco delle esecuzioni della valutazione. Per maggiori dettagli, visita la pagina https://google.aip.dev/160.
`order_by`	`string` Facoltativo. Campo in base al quale ordinare. Sono supportati solo "name", "create_time" e "update_time". I campi temporali sono ordinati in ordine decrescente, mentre il campo del nome è ordinato in ordine crescente. Se non è incluso, il valore predefinito sarà "update_time". Per maggiori dettagli, visita la pagina https://google.aip.dev/132#ordering.

ListEvaluationRunsResponse

Messaggio di risposta per EvaluationService.ListEvaluationRuns.

Campi

evaluation_runs[]

EvaluationRun

L'elenco delle esecuzioni della valutazione.

next_page_token

string

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

ListEvaluationsRequest

Messaggio di richiesta per EvaluationService.ListEvaluations.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa dell'app da cui elencare le valutazioni.
`page_size`	`int32` Facoltativo. Dimensioni della pagina richiesta. Il server potrebbe restituire meno elementi di quelli richiesti. Se non specificato, il server sceglierà un valore predefinito appropriato.
`page_token`	`string` Facoltativo. Il valore `next_page_token` restituito da una precedente chiamata dell'elenco `EvaluationService.ListEvaluations`.
`filter (deprecated)`	`string` Questo elemento è obsoleto. Facoltativo. Deprecato: utilizza evaluation_filter ed evaluation_run_filter.
`evaluation_filter`	`string` Facoltativo. Filtro da applicare alla valutazione quando vengono elencate le valutazioni. Per maggiori dettagli, visita la pagina https://google.aip.dev/160. Campi supportati: evaluation_datasets
`evaluation_run_filter`	`string` Facoltativo. Stringa di filtro per i campi delle risorse EvaluationRun associate. Per maggiori dettagli, visita la pagina https://google.aip.dev/160. Campi supportati: create_time, initiated_by, app_version_display_name
`order_by`	`string` Facoltativo. Campo in base al quale ordinare. Sono supportati solo "name", "create_time" e "update_time". I campi temporali sono ordinati in ordine decrescente, mentre il campo del nome è ordinato in ordine crescente. Se non è incluso, il valore predefinito sarà "update_time". Per maggiori dettagli, visita la pagina https://google.aip.dev/132#ordering.
`last_ten_results`	`bool` Facoltativo. Indica se includere gli ultimi 10 risultati di valutazione per ogni valutazione nella risposta.

ListEvaluationsResponse

Messaggio di risposta per EvaluationService.ListEvaluations.

Campi

evaluations[]

Evaluation

L'elenco delle valutazioni.

next_page_token

string

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

ListExamplesRequest

Messaggio di richiesta per AgentService.ListExamples.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa dell'app da cui elencare gli esempi.
`page_size`	`int32` Facoltativo. Dimensioni della pagina richiesta. Il server potrebbe restituire meno elementi di quelli richiesti. Se non specificato, il server sceglierà un valore predefinito appropriato.
`page_token`	`string` Facoltativo. Il valore `next_page_token` restituito da una precedente chiamata dell'elenco `AgentService.ListExamples`.
`filter`	`string` Facoltativo. Filtro da applicare durante l'elenco degli esempi. Per maggiori dettagli, visita la pagina https://google.aip.dev/160.
`order_by`	`string` Facoltativo. Campo in base al quale ordinare. Sono supportati solo "name" e "create_time". Per maggiori dettagli, visita la pagina https://google.aip.dev/132#ordering.

ListExamplesResponse

Messaggio di risposta per AgentService.ListExamples.

Campi

examples[]

Example

L'elenco degli esempi.

next_page_token

string

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

ListGuardrailsRequest

Messaggio di richiesta per AgentService.ListGuardrails.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa dell'app da cui elencare le protezioni.
`page_size`	`int32` Facoltativo. Dimensioni della pagina richiesta. Il server potrebbe restituire meno elementi di quelli richiesti. Se non specificato, il server sceglierà un valore predefinito appropriato.
`page_token`	`string` Facoltativo. Il valore `next_page_token` restituito da una precedente chiamata dell'elenco `AgentService.ListGuardrails`.
`filter`	`string` Facoltativo. Filtro da applicare durante l'elenco delle barriere protettive. Per maggiori dettagli, visita la pagina https://google.aip.dev/160.
`order_by`	`string` Facoltativo. Campo in base al quale ordinare. Sono supportati solo "name" e "create_time". Per maggiori dettagli, visita la pagina https://google.aip.dev/132#ordering.

ListGuardrailsResponse

Messaggio di risposta per AgentService.ListGuardrails.

Campi

guardrails[]

Guardrail

L'elenco delle barriere protettive.

next_page_token

string

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

ListScheduledEvaluationRunsRequest

Messaggio di richiesta per EvaluationService.ListScheduledEvaluationRuns.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa dell'app da cui elencare le esecuzioni di valutazione pianificate.
`page_size`	`int32` Facoltativo. Dimensioni della pagina richiesta. Il server potrebbe restituire meno elementi di quelli richiesti. Se non specificato, il server sceglierà un valore predefinito appropriato.
`page_token`	`string` Facoltativo. Il valore `next_page_token` restituito da una precedente chiamata dell'elenco `EvaluationService.ListScheduledEvaluationRuns`.
`filter`	`string` Facoltativo. Filtro da applicare durante l'elenco delle esecuzioni di valutazione pianificate. Per maggiori dettagli, visita la pagina https://google.aip.dev/160. Al momento supporta il filtro per: * request.evaluations:evaluation_id * request.evaluation_dataset:evaluation_dataset_id
`order_by`	`string` Facoltativo. Campo in base al quale ordinare. I campi supportati sono: "name" (in ordine crescente), "create_time" (in ordine decrescente), "update_time" (in ordine decrescente), "next_scheduled_execution" (in ordine crescente) e "last_completed_run.create_time" (in ordine decrescente). Se non è incluso, il valore predefinito sarà "update_time". Per maggiori dettagli, visita la pagina https://google.aip.dev/132#ordering.

ListScheduledEvaluationRunsResponse

Messaggio di risposta per EvaluationService.ListScheduledEvaluationRuns.

Campi

scheduled_evaluation_runs[]

ScheduledEvaluationRun

L'elenco delle esecuzioni della valutazione pianificate.

next_page_token

string

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

ListToolsRequest

Messaggio di richiesta per AgentService.ListTools.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa dell'app da cui elencare gli strumenti.
`page_size`	`int32` Facoltativo. Dimensioni della pagina richiesta. Il server potrebbe restituire meno elementi di quelli richiesti. Se non specificato, il server sceglierà un valore predefinito appropriato.
`page_token`	`string` Facoltativo. Il valore `next_page_token` restituito da una precedente chiamata dell'elenco `AgentService.ListTools`.
`filter`	`string` Facoltativo. Filtro da applicare durante l'elenco degli strumenti. Utilizza "include_system_tools=true" per includere gli strumenti di sistema nella risposta. Per maggiori dettagli, visita la pagina https://google.aip.dev/160.
`order_by`	`string` Facoltativo. Campo in base al quale ordinare. Sono supportati solo "name" e "create_time". Per maggiori dettagli, visita la pagina https://google.aip.dev/132#ordering.

ListToolsResponse

Messaggio di risposta per AgentService.ListTools.

Campi

tools[]

Tool

L'elenco degli strumenti.

next_page_token

string

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

ListToolsetsRequest

Messaggio di richiesta per AgentService.ListToolsets.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa dell'app da cui elencare i toolset.
`page_size`	`int32` Facoltativo. Dimensioni della pagina richiesta. Il server potrebbe restituire meno elementi di quelli richiesti. Se non specificato, il server sceglierà un valore predefinito appropriato.
`page_token`	`string` Facoltativo. Il valore `next_page_token` restituito da una precedente chiamata dell'elenco `AgentService.ListToolsets`.
`filter`	`string` Facoltativo. Filtro da applicare durante l'elenco dei toolset. Per maggiori dettagli, visita la pagina https://google.aip.dev/160.
`order_by`	`string` Facoltativo. Campo in base al quale ordinare. Sono supportati solo "name" e "create_time". Per maggiori dettagli, visita la pagina https://google.aip.dev/132#ordering.

ListToolsetsResponse

Messaggio di risposta per AgentService.ListToolsets.

Campi

toolsets[]

Toolset

L'elenco dei toolset.

next_page_token

string

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

LoggingSettings

Impostazioni per descrivere i comportamenti di logging per l'app.

Campi
`redaction_config`	`RedactionConfig` Facoltativo. Configurazione della modalità di oscuramento dei dati sensibili.
`audio_recording_config`	`AudioRecordingConfig` Facoltativo. Configurazione della modalità di registrazione delle interazioni audio. L'audio è soggetto a oscuramento come configurato in `RedactionConfig`.
`unredacted_audio_recording_config`	`AudioRecordingConfig` Facoltativo. Configura una registrazione aggiuntiva dell'audio non modificato. Può essere utilizzata per mantenere una copia audio non modificata quando la modifica dell'audio è `enabled`, in genere a fini di controllo o monitoraggio.
`bigquery_export_settings`	`BigQueryExportSettings` Facoltativo. Configura i comportamenti di esportazione BigQuery per l'app. I dati delle conversazioni sono soggetti a oscuramento come configurato in `RedactionConfig`.
`unredacted_bigquery_export_settings`	`BigQueryExportSettings` Facoltativo. Configura i comportamenti di esportazione di BigQuery per l'app. Se abilitati, i dati delle conversazioni non modificati verranno esportati nelle tabelle BigQuery.
`cloud_logging_settings`	`CloudLoggingSettings` Facoltativo. Impostazioni per descrivere i comportamenti di Cloud Logging per l'app.
`conversation_logging_settings`	`ConversationLoggingSettings` Facoltativo. Impostazioni per descrivere i comportamenti di registrazione delle conversazioni per l'app.
`evaluation_audio_recording_config`	`AudioRecordingConfig` Facoltativo. Configurazione della modalità di registrazione delle interazioni audio per la valutazione. Per impostazione predefinita, la registrazione audio non è attivata per le sessioni di valutazione.
`metric_analysis_settings`	`MetricAnalysisSettings` Facoltativo. Impostazioni per descrivere i comportamenti di raccolta dei dati delle conversazioni per la pipeline di analisi LLM per l'app.

McpTool

Uno strumento MCP. Per saperne di più, visita la pagina https://modelcontextprotocol.io/specification/2025-06-18/server/tools.

Campi
`name`	`string` Obbligatorio. Il nome dello strumento MCP.
`name_override`	`string` Facoltativo. L'override del nome dello strumento MCP. Questo campo viene compilato se il nome è stato sostituito da una sostituzione di Toolset.
`description`	`string` Facoltativo. La descrizione dello strumento MCP.
`input_schema`	`Schema` Facoltativo. Lo schema degli argomenti di input dello strumento MCP.
`output_schema`	`Schema` Facoltativo. Lo schema degli argomenti di output dello strumento MCP.
`server_address`	`string` Obbligatorio. L'indirizzo del server MCP, ad esempio "https://example.com/mcp/". Se il server è creato con l'SDK MCP, l'URL deve avere il suffisso "/mcp/". Sono supportati solo i server basati sul trasporto HTTP trasmissibile. È uguale a server_address in McpToolset. Per ulteriori dettagli, visita https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.
`api_authentication`	`ApiAuthentication` Facoltativo. Informazioni di autenticazione necessarie per eseguire lo strumento sul server MCP. Per l'autenticazione con token di tipo bearer, il token si applica solo all'esecuzione dello strumento, non agli strumenti di listing. Ciò richiede che gli strumenti possano essere elencati senza autenticazione.
`tls_config`	`TlsConfig` Facoltativo. La configurazione TLS. Include i certificati del server personalizzati che il client deve considerare attendibili.
`service_directory_config`	`ServiceDirectoryConfig` Facoltativo. Configurazione di Service Directory per VPC-SC, utilizzata per risolvere i nomi dei servizi all'interno di un perimetro.
`custom_headers`	`map<string, string>` Facoltativo. Le intestazioni personalizzate da inviare nella richiesta al server MCP. I valori devono essere nel formato `$context.variables.<name_of_variable>` e possono essere impostati nelle variabili di sessione. Per maggiori dettagli, visita la pagina https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.
`state`	`McpTool.State` Solo output. Lo stato di disponibilità dinamica dello strumento sul server esterno.

Stato

Rappresenta lo stato di disponibilità dinamica dello strumento.

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

McpToolDefinition

Contenitore per gli elementi di definizione principali di uno strumento di cui viene creato uno snapshot. Gli schemi nello snapshot vengono utilizzati così come sono e non possono essere sostituiti.

Campi

description

string

Solo output. La descrizione dello strumento MCP. Questa impostazione può essere sostituita da description_override in McpToolOverride.

input_schema

Schema

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

output_schema

Schema

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

McpToolOverride

Override associati a un determinato strumento in un insieme di strumenti. Ciò consente di "bloccare" o "ignorare" le definizioni degli strumenti dal server dinamico esterno.

Campi
`tool`	`string` Obbligatorio. Il nome originale dello strumento così come viene emesso dal server MCP.
`name_override`	`string` Facoltativo. Se presente, questo strumento utilizza questo nome nell'agente anziché il nome originale. Viene utilizzato principalmente come alias se il server MCP offre strumenti con nomi poco chiari.
`description_override`	`string` Facoltativo. Se presente, questo strumento utilizza questa descrizione anziché la descrizione originale del server.
`snapshot`	`McpToolDefinition` Solo output. Se presente, questo strumento è "bloccato" e utilizza i valori dello snapshot come fallback se il server non è temporaneamente disponibile o se non è presente alcun override.

McpToolset

Un insieme di strumenti che contiene un elenco di strumenti offerti dal server MCP.

Campi
`server_address`	`string` Obbligatorio. L'indirizzo del server MCP, ad esempio "https://example.com/mcp/". Se il server è creato con l'SDK MCP, l'URL deve avere il suffisso "/mcp/". Sono supportati solo i server basati sul trasporto HTTP trasmissibile. Per ulteriori dettagli, visita https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.
`api_authentication`	`ApiAuthentication` Facoltativo. Informazioni di autenticazione necessarie per accedere agli strumenti ed eseguire uno strumento sul server MCP. Per l'autenticazione con token di tipo bearer, il token si applica solo all'esecuzione dello strumento, non agli strumenti di listing. Ciò richiede che gli strumenti possano essere elencati senza autenticazione.
`service_directory_config`	`ServiceDirectoryConfig` Facoltativo. Configurazione di Service Directory per VPC-SC, utilizzata per risolvere i nomi dei servizi all'interno di un perimetro.
`tls_config`	`TlsConfig` Facoltativo. La configurazione TLS. Include i certificati del server personalizzati che il client deve considerare attendibili.
`custom_headers`	`map<string, string>` Facoltativo. Le intestazioni personalizzate da inviare nella richiesta al server MCP. I valori devono essere nel formato `$context.variables.<name_of_variable>` e possono essere impostati nelle variabili di sessione. Per maggiori dettagli, visita la pagina https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.
`tool_overrides[]`	`McpToolOverride` Facoltativo. Override per i singoli strumenti all'interno di questo set di strumenti. Ciò consente di ignorare dettagli specifici come descrizioni, nomi o bloccare gli stati degli strumenti in modo che non siano completamente dinamici.

Messaggio

Un messaggio all'interno di una conversazione.

Campi

role

string

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

chunks[]

Chunk

Facoltativo. Contenuto del messaggio come una serie di blocchi.

event_time

MockConfig.UnmatchedToolCallBehavior

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

MetricAnalysisSettings

Impostazioni per descrivere i comportamenti di raccolta dei dati delle conversazioni per la pipeline delle metriche di analisi LLM.

Campi

llm_metrics_opted_out

bool

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.

MockConfig

Configurazione delle chiamate agli strumenti simulate per la sessione.

Campi

mocked_tool_calls[]

MockedToolCall

Facoltativo. Tutte le chiamate allo strumento da simulare per la durata della sessione.

unmatched_tool_call_behavior

Obbligatorio. Comportamento per le chiamate di strumenti che non corrispondono ad alcun pattern di argomenti in mocked_tool_calls.

UnmatchedToolCallBehavior

Cosa fare quando una chiamata di strumento non corrisponde ad alcuna chiamata di strumento simulata.

Enum
`UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED`	Valore predefinito. Questo valore non viene utilizzato.
`FAIL`	Genera un errore per tutte le chiamate di strumenti che non corrispondono a un pattern di input previsto simulato.
`PASS_THROUGH`	Per le chiamate di strumenti senza corrispondenza, passa la chiamata di strumenti allo strumento reale.

MockedToolCall

Una chiamata simulata allo strumento.

Esprime lo strumento di destinazione e un pattern da confrontare con gli argomenti / input dello strumento. Se il pattern corrisponde, viene restituita la risposta simulata.

Campi
`tool (deprecated)`	`string` Questo elemento è obsoleto. Facoltativo. Deprecato. Utilizza tool_identifier.
`expected_args_pattern`	`Struct` Obbligatorio. Un pattern da confrontare con gli argomenti / gli input di tutte le chiamate agli strumenti inviate. Se gli input della chiamata allo strumento corrispondono a questo pattern, verrà restituito l'output simulato.
`mock_response`	`Struct` Facoltativo. La risposta / l'output simulato da restituire se gli argomenti / gli input della chiamata allo strumento corrispondono al pattern.
Campo unione `tool_identifier`. L'identificatore dello strumento da simulare. `tool_identifier` può essere solo uno dei seguenti tipi:
`tool_id`	`string` Facoltativo. Il nome dello strumento da simulare. Formato: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
`toolset`	`ToolsetTool` Facoltativo. Il set di strumenti per la simulazione.

ModelSettings

Le impostazioni del modello contengono varie configurazioni per il modello LLM.

Campi

model

string

Facoltativo. Il modello LLM che l'agente deve utilizzare. Se non viene impostato, l'agente erediterà il modello dal relativo agente principale.

thinking_level

ModelSettings.ThinkingLevel

Facoltativo. Il livello di ragionamento del modello.

temperature

double

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.

ThinkingLevel

Configurazione del livello di ragionamento per il modello.

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

OAuthConfig

Configurazioni per l'autenticazione con OAuth.

Campi
`oauth_grant_type`	`OAuthConfig.OauthGrantType` Obbligatorio. Tipi di autorizzazione con OAuth.
`client_id`	`string` Obbligatorio. L'ID client del fornitore OAuth.
`client_secret_version`	`string` Obbligatorio. Il nome della risorsa della versione del secret di Secret Manager che archivia il client secret. Formato: `projects/{project}/secrets/{secret}/versions/{version}` Nota: devi concedere il ruolo `roles/secretmanager.secretAccessor` all'agente di servizio CES `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com`.
`token_endpoint`	`string` Obbligatorio. L'endpoint del token nel provider OAuth da scambiare con un token di accesso.
`scopes[]`	`string` Facoltativo. Gli ambiti OAuth da concedere.

OauthGrantType

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

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

OpenApiTool

Uno strumento API remoto definito da uno schema OpenAPI.

Campi
`open_api_schema`	`string` Obbligatorio. Lo schema OpenAPI in formato JSON o YAML.
`name`	`string` Facoltativo. Il nome dello strumento. Se non viene fornito, il nome dello strumento verrà derivato dallo schema OpenAPI, da `operation.operationId`.
`description`	`string` Facoltativo. La descrizione dello strumento. Se non viene fornita, la descrizione dello strumento verrà derivata dallo schema OpenAPI, da `operation.description` o `operation.summary`.
`api_authentication`	`ApiAuthentication` Facoltativo. Informazioni di autenticazione richieste dall'API.
`tls_config`	`TlsConfig` Facoltativo. La configurazione TLS. Include i certificati del server personalizzati di cui il client si fiderà.
`service_directory_config`	`ServiceDirectoryConfig` Facoltativo. Configurazione di Service Directory.
`ignore_unknown_fields`	`bool` Facoltativo. Se il valore è true, l'agente ignorerà i campi sconosciuti nella risposta dell'API.
`url`	`string` Facoltativo. L'URL del server dello schema dell'API Open. Questo campo viene impostato solo negli strumenti 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.

OpenApiToolset

Un insieme di strumenti che contiene un elenco di strumenti definiti da uno schema OpenAPI.

Campi
`open_api_schema`	`string` Obbligatorio. Lo schema OpenAPI del set di strumenti.
`api_authentication`	`ApiAuthentication` Facoltativo. Informazioni di autenticazione richieste dall'API.
`tls_config`	`TlsConfig` Facoltativo. La configurazione TLS. Include i certificati del server personalizzati
`service_directory_config`	`ServiceDirectoryConfig` Facoltativo. Configurazione di Service Directory.
`ignore_unknown_fields`	`bool` Facoltativo. Se il valore è true, l'agente ignorerà i campi sconosciuti nella risposta API per tutte le operazioni definite nello schema OpenAPI.
`url`	`string` Facoltativo. L'URL del server dello schema dell'API Open. Questo campo viene impostato solo nei 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.

OperationMetadata

Rappresenta i metadati dell'operazione a lunga esecuzione.

Campi
`create_time`	`Timestamp` Solo output. L'ora in cui è stata creata l'operazione.
`end_time`	`Timestamp` Solo output. L'ora in cui è terminata l'esecuzione dell'operazione.
`status_message`	`string` Solo output. Stato dell'operazione leggibile, se presente.
`requested_cancellation`	`bool` Solo output. Indica se l'utente ha richiesto l'annullamento dell'operazione. Le operazioni annullate correttamente hanno un valore `google.longrunning.Operation.error` con un `google.rpc.Status.code` pari a `1`, corrispondente a `Code.CANCELLED`.

OptimizationConfig

Configurazione per l'esecuzione del passaggio di ottimizzazione dopo l'esecuzione della valutazione.

Campi
`generate_loss_report`	`bool` Facoltativo. Se generare un report di perdita.
`assistant_session`	`string` Solo output. La sessione dell'assistente da utilizzare per l'ottimizzazione in base a questa esecuzione della valutazione. Formato: `projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}`
`report_summary`	`string` Solo output. Il riepilogo della denuncia di smarrimento.
`should_suggest_fix`	`bool` Solo output. Se suggerire una correzione per le perdite.
`status`	`OptimizationConfig.OptimizationStatus` Solo output. Lo stato dell'esecuzione dell'ottimizzazione.
`error_message`	`string` Solo output. Il messaggio di errore se l'esecuzione dell'ottimizzazione non è riuscita.
`loss_report`	`Struct` Solo output. Il report sulle perdite generato.

OptimizationStatus

Lo stato dell'esecuzione dell'ottimizzazione.

Enum
`OPTIMIZATION_STATUS_UNSPECIFIED`	Lo stato di ottimizzazione non è specificato.
`RUNNING`	L'ottimizzazione è in corso.
`COMPLETED`	L'ottimizzazione è stata completata.
`ERROR`	L'ottimizzazione non è riuscita a causa di un errore interno.

OutputAudioConfig

OutputAudioConfig configura il modo in cui l'agente CES deve sintetizzare le risposte audio in uscita.

Campi

audio_encoding

AudioEncoding

Obbligatorio. La codifica dei dati audio di output.

sample_rate_hertz

int32

Obbligatorio. La frequenza di campionamento (in hertz) dei dati audio di output.

PersonaRunConfig

Configurazione per l'esecuzione di una valutazione per un utente tipo specifico.

Campi

persona

string

Facoltativo. La persona da utilizzare per la valutazione. Formato: projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evaluationPersona}

task_count

int32

Facoltativo. Il numero di attività da eseguire per la persona.

PythonCodeCondition

Blocco di codice Python per valutare la condizione.

Campi

python_code

string

Obbligatorio. Il codice Python da eseguire.

PythonFunction

Uno strumento di funzione Python.

Campi
`name`	`string` Facoltativo. Il nome della funzione Python da eseguire. Deve corrispondere a un nome di funzione Python definito nel codice Python. Sensibile alle maiuscole. Se il nome non viene fornito, verrà utilizzata la prima funzione definita nel codice Python.
`python_code`	`string` Facoltativo. Il codice Python da eseguire per lo strumento.
`description`	`string` Solo output. La descrizione della funzione Python, analizzata dalla docstring del codice Python.
`service_directory_config`	`ServiceDirectoryConfig` Facoltativo. Configurazione di Service Directory per lo strumento.

QualityReport

Il report che descrive eventuali problemi di qualità identificati nell'app.

Campi

issues[]

QualityReport.AgentIssues

Facoltativo. I problemi raggruppati per agente.

evaluation_runs[]

string

Facoltativo. Un elenco di esecuzioni di valutazione utilizzate per generare il report sulla qualità. Formato: projects/{project}/locations/{location}/evaluationRuns/{evaluationRun}.

general_issues[]

QualityReport.Issue

Facoltativo. Problemi generali non specifici di alcun agente.

AgentIssues

Problemi identificati per un singolo agente.

Campi

agent

string

Facoltativo. Il nome dell'agente a cui sono correlati i problemi. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

issues[]

QualityReport.Issue

Facoltativo. Elenco dei problemi riscontrati per questo agente.

Problema

Il problema identificato.

Campi

description

string

Facoltativo. Descrizione del problema riscontrato.

occurrence_count

int32

Facoltativo. Il numero di volte in cui si è verificato il problema.

proposed_solution

string

Facoltativo. Soluzione proposta per risolvere il problema modificando le istruzioni o gli strumenti.

RecognitionResult

Risultato del riconoscimento vocale per l'input audio.

Campi

transcript

string

Facoltativo. Segmenti di voce dell'utente concatenati acquisiti durante il turno corrente.

RedactionConfig

Configurazione per indicare come devono essere gestiti i dati sensibili.

Campi

enable_redaction

bool

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.

inspect_template

string

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

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

deidentify_template

string

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

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

RemoteA2aConfig

Configurazione condivisa per la connessione a un agente A2A remoto.

Campi
`api_authentication`	`ApiAuthentication` Facoltativo. Configurazione dell'autenticazione per chiamare l'agente remoto. Facoltativo se il riferimento al registro gestisce già l'autenticazione.
`input_variable_mapping`	`map<string, string>` Facoltativo. Mapping dei nomi delle variabili di input dell'agente remoto ai nomi delle variabili GECX.
`output_variable_mapping`	`map<string, string>` Facoltativo. Mappatura dei nomi delle variabili di output dell'agente remoto ai nomi delle variabili GECX.
`streaming_enabled`	`bool` Facoltativo. Indica se lo streaming è abilitato per l'agente remoto.
`context_id`	`string` Facoltativo. Se non è vuoto, le interazioni con l'agente A2A remoto utilizzeranno questo ID contesto. Questo campo context_id può fare riferimento a una variabile di sessione come `$context.variables.order_agent_session_id`.
Campo unione `agent_spec`. Specifica dell'agente remoto. `agent_spec` può essere solo uno dei seguenti tipi:
`agent_card`	`AgentCard` Facoltativo. La scheda dell'agente completa definita in linea.
`agent_registry`	`string` Facoltativo. Riferimento all'agente in Agent Registry. Formato: `projects/{project}/locations/{location}/agents/{agent}`

RemoteAgentTool

Rappresenta uno strumento che consente all'agente di chiamare un altro agente remoto.

Campi
`name`	`string` Obbligatorio. Il nome dello strumento.
`description`	`string` Obbligatorio. La descrizione dello strumento.
`agent_card`	`AgentCard` Obbligatorio. La scheda dell'agente remoto richiamato da questo strumento.
`api_authentication`	`ApiAuthentication` Facoltativo. Configurazione dell'autenticazione per chiamare l'agente remoto.
`stateful_agent`	`bool` Facoltativo. Se attivata, l'interazione tra l'app CXAS e l'agente remoto condividerà lo stesso contesto. Se l'agente remoto restituisce un context_id, questo verrà mantenuto per l'intera sessione di questo strumento dell'agente remoto.
`input_variable_mapping`	`map<string, string>` Facoltativo. Mapping dei nomi delle variabili di input dell'agente remoto ai nomi delle variabili GECX.
`output_variable_mapping`	`map<string, string>` Facoltativo. Mappatura dei nomi delle variabili di output dell'agente remoto ai nomi delle variabili GECX.

RestoreAppVersionRequest

Messaggio di richiesta per AgentService.RestoreAppVersion

Campi

name

string

Obbligatorio. Il nome della risorsa della versione dell'app da ripristinare.

RestoreAppVersionResponse

Questo tipo non contiene campi.

Messaggio di risposta per AgentService.RestoreAppVersion

RetrieveToolSchemaRequest

Messaggio di richiesta per ToolService.RetrieveToolSchema.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa dell'app a cui appartiene lo strumento/il set di strumenti. Formato: `projects/{project}/locations/{location}/apps/{app}`
Campo unione `tool_identifier`. L'identificatore dello strumento per recuperare lo schema. 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`	`string` Facoltativo. Il nome dello strumento per cui recuperare lo schema. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
`toolset_tool`	`ToolsetTool` Facoltativo. Lo strumento del toolset per recuperare lo schema. Solo uno strumento deve corrispondere al predicato del set di strumenti. In caso contrario, verrà restituito un errore.

RetrieveToolSchemaResponse

Messaggio di risposta per ToolService.RetrieveToolSchema.

Campi
`input_schema`	`Schema` Lo schema dei parametri di input dello strumento.
`output_schema`	`Schema` Lo schema dei parametri di output dello strumento.
Campo unione `tool_identifier`. L'identificatore dello strumento a cui si riferisce lo schema. `tool_identifier` può essere solo uno dei seguenti tipi:
`tool`	`string` Il nome dello strumento a cui è destinato lo schema. Formato: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
`toolset_tool`	`ToolsetTool` Lo strumento del toolset per cui è previsto lo schema.

RetrieveToolsRequest

Messaggio di richiesta per ToolService.RetrieveTools.

Campi

toolset

string

Obbligatorio. Il nome del set di strumenti per cui recuperare gli strumenti. Formato: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}

tool_ids[]

string

Facoltativo. Gli identificatori degli strumenti da recuperare dal toolset. Se vuoto, verranno restituiti tutti gli strumenti nel set di strumenti.

bypass_persistence_config

bool

Facoltativo. Se il valore è true, gli strumenti restituiti conterranno descrizioni e schemi non elaborati direttamente dal server, ignorando qualsiasi configurazione di persistenza archiviata (override/snapshot).

RetrieveToolsResponse

Messaggio di risposta per ToolService.RetrieveTools.

Campi

tools[]

Tool

L'elenco degli strumenti inclusi nel toolset specificato.

RunEvaluationOperationMetadata

Metadati dell'operazione per EvaluationService.RunEvaluation.

Campi
`evaluations[]`	`string` Solo output. L'elenco delle valutazioni eseguite. Formato: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`
`evaluation_run`	`string` Solo output. L'esecuzione della valutazione creata. Formato: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluation_run}`
`create_time`	`Timestamp` Solo output. L'ora in cui è stata creata l'operazione.
`end_time`	`Timestamp` Solo output. L'ora in cui l'operazione è stata completata.
`verb`	`string` Solo output. Il verbo dell'operazione.
`cancel_requested`	`bool` Solo output. Indica se l'utente ha richiesto l'annullamento dell'operazione. Le operazioni annullate correttamente hanno un valore `google.longrunning.Operation.error` con un `google.rpc.Status.code` pari a `1`, corrispondente a `Code.CANCELLED`.

RunEvaluationRequest

Messaggio di richiesta per EvaluationService.RunEvaluation.

Campi
`app`	`string` Obbligatorio. L'app da valutare. Formato: `projects/{project}/locations/{location}/apps/{app}`
`evaluations[]`	`string` Facoltativo. Elenco delle valutazioni da eseguire. Formato: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`
`evaluation_dataset`	`string` Facoltativo. Un set di dati di valutazione da eseguire. Formato: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`
`display_name`	`string` Facoltativo. Il nome visualizzato dell'esecuzione della valutazione.
`app_version`	`string` Facoltativo. La versione dell'app da valutare. È possibile impostare al massimo uno dei parametri `app_version` o `deployment`. Formato: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
`config`	`EvaluationConfig` Facoltativo. La configurazione da utilizzare per l'esecuzione.
`persona_run_configs[]`	`PersonaRunConfig` Facoltativo. La configurazione da utilizzare per l'esecuzione per persona.
`optimization_config`	`OptimizationConfig` Facoltativo. Configurazione per l'esecuzione del passaggio di ottimizzazione dopo l'esecuzione della valutazione. Se non viene impostato, il passaggio di ottimizzazione non verrà eseguito.
`scheduled_evaluation_run`	`string` Facoltativo. Il nome della risorsa di `ScheduledEvaluationRun` che attiva l'esecuzione di questa valutazione. Se questo campo è impostato, il campo `scheduled_evaluation_run` della risorsa `EvaluationRun` creata verrà compilato con questo valore. Formato: `projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}`
`golden_run_method`	`GoldenRunMethod` Facoltativo. Il metodo per eseguire la valutazione se si tratta di una valutazione di riferimento. Se non viene impostato, il valore predefinito è STABLE.
`generate_latency_report`	`bool` Facoltativo. Indica se generare un report sulla latenza per l'esecuzione della valutazione.
`evaluation_run_caching_settings`	`EvaluationRunCachingSettings` Facoltativo. Le impostazioni di memorizzazione nella cache da utilizzare per l'esecuzione della valutazione.
`run_count`	`int32` Facoltativo. Il numero di volte in cui eseguire la valutazione. Se non viene impostato, il valore predefinito è 1 per ogni golden e 5 per ogni scenario.

RunEvaluationResponse

Messaggio di risposta per EvaluationService.RunEvaluation.

Campi

evaluation_run

string

Il nome dell'esecuzione della valutazione creata. Formato: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluation_run}

RunEvaluationResultMetricsOperationMetadata

Questo tipo non contiene campi.

Metadati dell'operazione per EvaluationService.RunEvaluationResultMetrics.

RunEvaluationResultMetricsRequest

Messaggio di richiesta per EvaluationService.RunEvaluationResultMetrics.

Campi

evaluation_result_id

string

Obbligatorio. Il risultato della valutazione per cui eseguire le metriche. Formato: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{evaluation_result_id}

RunEvaluationResultMetricsResponse

Messaggio di risposta per EvaluationService.RunEvaluationResultMetrics.

Campi

status

EvaluationResult.Outcome

Solo output. Lo stato del calcolo delle metriche dei risultati della valutazione.

RunSessionRequest

Messaggio di richiesta per SessionService.RunSession.

Campi

config

SessionConfig

Obbligatorio. La configurazione della sessione.

inputs[]

SessionInput

Obbligatorio. Input per la sessione.

RunSessionResponse

Messaggio di risposta per SessionService.RunSession.

Campi

outputs[]

SessionOutput

Output della sessione.

ScheduledEvaluationRun

Rappresenta una configurazione di esecuzione della valutazione pianificata.

Campi
`name`	`string` Identificatore. L'identificatore univoco della configurazione dell'esecuzione della valutazione pianificata. Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationRuns/{scheduledEvaluationRunId}
`display_name`	`string` Obbligatorio. Nome visualizzato definito dall'utente della configurazione dell'esecuzione della valutazione pianificata.
`request`	`RunEvaluationRequest` Obbligatorio. RunEvaluationRequest da pianificare
`description`	`string` Facoltativo. Descrizione definita dall'utente dell'esecuzione della valutazione pianificata.
`scheduling_config`	`ScheduledEvaluationRun.SchedulingConfig` Obbligatorio. Configurazione della tempistica e della frequenza di esecuzione delle valutazioni.
`active`	`bool` Facoltativo. Se questa configurazione è attiva
`last_completed_run`	`string` Solo output. L'ultima esecuzione di EvaluationRun riuscita di questa esecuzione pianificata. Formato: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`
`total_executions`	`int32` Solo output. Il numero totale di volte in cui è stata eseguita questa esecuzione
`next_scheduled_execution_time`	`Timestamp` Solo output. La prossima volta che è pianificata l'esecuzione
`create_time`	`Timestamp` Solo output. Timestamp di creazione dell'esecuzione della valutazione pianificata.
`created_by`	`string` Solo output. L'utente che ha creato l'esecuzione della valutazione pianificata.
`update_time`	`Timestamp` Solo output. Timestamp dell'ultimo aggiornamento della valutazione.
`last_updated_by`	`string` Solo output. L'utente che ha aggiornato per ultimo la valutazione.
`etag`	`string` 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.

SchedulingConfig

Dettagli di configurazione della pianificazione della valutazione

Campi

frequency

ScheduledEvaluationRun.SchedulingConfig.Frequency

Obbligatorio. La frequenza con cui eseguire la valutazione

start_time

Obbligatorio. Timestamp di inizio della valutazione.

days_of_week[]

int32

Facoltativo. I giorni della settimana in cui eseguire la valutazione. Applicabile solo alle frequenze settimanali e quindicinali. 1 è lunedì, 2 è martedì e così via fino a 7, che è domenica.

Frequenza

Le frequenze con cui possono essere eseguiti i test

Enum
`FREQUENCY_UNSPECIFIED`	La frequenza non è specificata.
`NONE`	Indica un'esecuzione pianificata una tantum che non deve ripetersi
`DAILY`	Esegui la valutazione ogni giorno.
`WEEKLY`	Esegui la valutazione ogni settimana.
`BIWEEKLY`	Esegui la valutazione ogni due settimane.

Schema

Rappresenta un sottoinsieme selezionato di un oggetto schema OpenAPI 3.0.

Campi
`type`	`Schema.Type` Obbligatorio. Il tipo di dati.
`properties`	`map<string, Schema>` Facoltativo. Proprietà di Type.OBJECT.
`required[]`	`string` Facoltativo. Proprietà obbligatorie di Type.OBJECT.
`description`	`string` Facoltativo. La descrizione dei dati.
`items`	`Schema` Facoltativo. Schema degli elementi di Type.ARRAY.
`nullable`	`bool` Facoltativo. Indica se il valore può essere null.
`unique_items`	`bool` Facoltativo. Indica che gli elementi nell'array devono essere univoci. Si applica solo a TYPE.ARRAY.
`prefix_items[]`	`Schema` Facoltativo. Schemi degli elementi iniziali di Type.ARRAY.
`additional_properties`	`Schema` Facoltativo. Può essere un valore booleano o un oggetto e controlla la presenza di proprietà aggiuntive.
`any_of[]`	`Schema` Facoltativo. Il valore deve essere convalidato rispetto a uno o più sottoschema nell'elenco.
`enum[]`	`string` 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`	`Value` Facoltativo. Valore predefinito dei dati.
`ref`	`string` Facoltativo. Consente riferimenti indiretti tra i nodi dello schema. Il valore deve essere un riferimento valido a un elemento secondario della radice `defs`. Ad esempio, lo schema seguente definisce un riferimento a un nodo dello schema denominato "Pet": `type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string` Il valore della proprietà "pet" è un riferimento al nodo dello schema denominato "Pet". Per maggiori dettagli, visita la pagina https://json-schema.org/understanding-json-schema/structuring.
`defs`	`map<string, Schema>` Facoltativo. Una mappa delle definizioni da utilizzare per `ref`. Consentito solo nella radice dello schema.
`title`	`string` Facoltativo. Il titolo dello schema.
`min_items`	`int64` Facoltativo. Numero minimo di elementi per Type.ARRAY.
`max_items`	`int64` Facoltativo. Numero massimo di elementi per Type.ARRAY.
`minimum`	`double` Facoltativo. Valore minimo per Type.INTEGER e Type.NUMBER.
`maximum`	`double` Facoltativo. Valore massimo per Type.INTEGER e Type.NUMBER.

Tipo

Tipi di dati OpenAPI.

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

SecuritySettings

Impostazioni di sicurezza a livello di progetto/posizione per CES.

Campi
`name`	`string` Identificatore. L'identificatore univoco delle impostazioni di sicurezza. Formato: `projects/{project}/locations/{location}/securitySettings`
`endpoint_control_policy`	`EndpointControlPolicy` Facoltativo. Impostazioni relative al controllo degli endpoint.
`create_time`	`Timestamp` Solo output. Crea l'ora delle impostazioni di sicurezza.
`update_time`	`Timestamp` Solo output. L'ora dell'ultimo aggiornamento delle impostazioni di sicurezza.
`etag`	`string` Solo output. Etag delle impostazioni di sicurezza.

ServiceAccountAuthConfig

Configurazioni per l'autenticazione tramite un account di servizio personalizzato.

Campi

service_account

string

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

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

scopes[]

string

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

ServiceAgentIdTokenAuthConfig

Questo tipo non contiene campi.

Configurazioni per l'autenticazione con il token ID generato dal service agent.

ServiceDirectoryConfig

Configurazione per gli strumenti che utilizzano Service Directory.

Campi

service

string

Obbligatorio. Il nome del servizio Service Directory. Formato: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. La posizione della directory dei servizi deve corrispondere a quella dell'app.

SessionConfig

La configurazione della sessione.

Campi
`session`	`string` Obbligatorio. L'identificatore univoco della sessione. Formato: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`
`input_audio_config`	`InputAudioConfig` Facoltativo. Configurazione per l'elaborazione dell'audio di input.
`output_audio_config`	`OutputAudioConfig` Facoltativo. Configurazione per la generazione dell'audio di output.
`historical_contexts[]`	`Message` Facoltativo. Il contesto storico della sessione, inclusi gli input dell'utente, le risposte dell'agente e altri messaggi. In genere, l'agente CES gestisce automaticamente la sessione, quindi il cliente non deve compilare esplicitamente questo campo. Tuttavia, il client può facoltativamente ignorare i contesti storici per forzare l'avvio della sessione da un determinato stato.
`entry_agent`	`string` Facoltativo. L'agente di ingresso per gestire la sessione. Se non specificata, la sessione verrà gestita da `root agent` dell'app. Formato: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
`deployment`	`string` Facoltativo. Il deployment dell'app da utilizzare per la sessione. Formato: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
`time_zone`	`string` Facoltativo. Il fuso orario dell'utente. Se fornito, l'agente utilizzerà il fuso orario per le variabili relative a data e ora. In caso contrario, l'agente utilizzerà il fuso orario specificato in App.time_zone_settings. Il formato è il fuso orario del database dei fusi orari IANA, ad es. "America/Los_Angeles".
`use_tool_fakes`	`bool` Facoltativo. Se utilizzare o meno strumenti falsi per la sessione. Se questo campo è impostato, l'agente tenterà di utilizzare strumenti falsi anziché chiamare quelli reali.
`remote_dialogflow_query_parameters`	`SessionConfig.RemoteDialogflowQueryParameters` Facoltativo. QueryParameters da inviare all'agente Dialogflow remoto quando il controllo della sessione viene trasferito all'agente remoto.
`enable_text_streaming`	`bool` Facoltativo. Indica se abilitare l'output di testo in streaming dal modello. Per impostazione predefinita, gli output di testo del modello vengono raccolti prima di essere inviati al client. NOTA: questa funzionalità è supportata solo per le sessioni di testo (non vocali) tramite `StreamRunSession` o `BidiRunSession`.
`exclude_diagnostic_info`	`bool` Facoltativo. Se escludere le informazioni diagnostiche dall'output della sessione.

RemoteDialogflowQueryParameters

QueryParameters da inviare all'agente Dialogflow remoto quando il controllo della sessione viene trasferito all'agente remoto.

Campi

webhook_headers

map<string, string>

Facoltativo. Le intestazioni HTTP da inviare come webhook_headers in QueryParameters.

payload

Facoltativo. Il payload da inviare in QueryParameters.

end_user_metadata

Facoltativo. I metadati dell'utente finale da inviare in QueryParameters.

SessionInput

Input per la sessione.

Campi
`will_continue`	`bool` Facoltativo. Un flag che indica se il messaggio corrente è un frammento di un input più grande nella sessione di streaming bidirezionale. Se impostato su `true`, l'agente posticipa l'elaborazione fino a quando non riceve un messaggio successivo in cui `will_continue` è `false` o fino a quando il sistema non rileva un endpoint nell'input audio. NOTA: questo campo non si applica agli input audio e DTMF, in quanto vengono sempre elaborati automaticamente in base al segnale di fine.
Campo unione `input_type`. Il tipo di input. `input_type` può essere solo uno dei seguenti tipi:
`text`	`string` Facoltativo. Dati di testo dell'utente finale.
`dtmf`	`string` Facoltativo. Cifre DTMF dell'utente finale.
`audio`	`bytes` Facoltativo. Dati audio dell'utente finale.
`tool_responses`	`ToolResponses` Facoltativo. Risultati dell'esecuzione per le chiamate di strumenti dal client.
`image`	`Image` Facoltativo. Dati delle immagini dell'utente finale.
`blob`	`Blob` Facoltativo. Dati blob dell'utente finale.
`variables`	`Struct` Facoltativo. Variabili contestuali per la sessione, identificate per nome. L'agente CES utilizzerà solo le variabili dichiarate nell'app. Le variabili non riconosciute verranno comunque inviate all'[agente Dialogflow][Agent.RemoteDialogflowAgent] come parametri di sessione aggiuntivi.
`event`	`Event` Facoltativo. Input dell'evento.

SessionOutput

Output della sessione.

Campi
`turn_index`	`int32` Indica l'ordine sequenziale del turno di conversazione a cui appartiene questo output, a partire da 1.
`turn_completed`	`bool` Se è vero, l'agente CES ha rilevato la fine del turno di conversazione corrente e non fornirà ulteriori output per questo turno.
`diagnostic_info`	`SessionOutput.DiagnosticInfo` Facoltativo. Le informazioni diagnostiche contengono i dettagli di esecuzione durante l'elaborazione dell'input. Viene compilato solo nell'ultimo SessionOutput (con `turn_completed=true`) per ogni turno.
Campo unione `output_type`. Il tipo di output. `output_type` può essere solo uno dei seguenti tipi:
`text`	`string` Testo di output dell'agente CES.
`audio`	`bytes` Output audio dell'agente CES.
`tool_calls`	`ToolCalls` Richiedi al cliente di eseguire gli strumenti.
`citations`	`Citations` Citazioni che forniscono le informazioni sulla fonte del testo generato dall'agente.
`google_search_suggestions`	`GoogleSearchSuggestions` I suggerimenti restituiti dalla Ricerca Google in seguito all'invocazione di `GoogleSearchTool`.
`end_session`	`EndSession` Indica che la sessione è terminata.
`payload`	`Struct` Payload personalizzato con output strutturato dell'agente CES.
`image`	`Image` Immagine di output dell'agente CES.
`progress`	`string` Aggiornamento intermedio dello stato di avanzamento da parte dell'agente CES.

DiagnosticInfo

Contiene i dettagli dell'esecuzione durante l'elaborazione.

Campi

messages[]

Message

Elenco dei messaggi visualizzati durante l'elaborazione.

root_span

Span

Una traccia dell'intera elaborazione della richiesta, rappresentata come uno span radice. Questo intervallo può contenere intervalli secondari nidificati per operazioni specifiche.

Intervallo

Uno span è un'unità di lavoro o una singola operazione durante l'elaborazione della richiesta.

Campi
`name`	`string` Solo output. Il nome dello span.
`start_time`	`Timestamp` Solo output. L'ora di inizio dello span.
`end_time`	`Timestamp` Solo output. L'ora di fine dell'intervallo.
`duration`	`Duration` Solo output. La durata dell'intervallo.
`attributes`	`Struct` Solo output. Attributi coppia chiave-valore associati allo span.
`child_spans[]`	`Span` Solo output. Gli intervalli secondari nidificati in questo intervallo.

SynthesizeSpeechConfig

Configurazione della modalità di sintesi della risposta dell'agente.

Campi
`voice`	`string` Facoltativo. Il nome della voce. Se non viene impostato, 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.
`speaking_rate`	`double` Facoltativo. La velocità di lettura nell'intervallo [0,25, 2,0]. 1.0 è la velocità nativa normale supportata dalla voce specifica. 2.0 è due volte più veloce, mentre 0.5 è la metà della velocità. I valori al di fuori dell'intervallo [0,25, 2,0] restituiranno un errore.
`model`	`string` Facoltativo. Il modello utilizzato per sintetizzare l'audio. Valori attualmente supportati: "gemini-3.1-flash-tts-preview". Se è vuoto, viene utilizzato Chirp3-HD.
`instruction`	`string` Facoltativo. L'istruzione utilizzata per sintetizzare la voce quando si utilizza un modello generativo.

SystemTool

Strumento di sistema predefinito.

Campi

name

string

Obbligatorio. Il nome dello strumento di sistema.

description

string

Solo output. La descrizione dello strumento di sistema.

TestPersonaVoiceRequest

Messaggio di richiesta per EvaluationService.TestPersonaVoice.

Campi

app

string

Obbligatorio. Il nome della risorsa dell'app per cui testare la voce della persona. Formato: projects/{project}/locations/{location}/apps/{app}

persona_id

string

Obbligatorio. L'ID della persona per cui testare la voce. Accetta anche "default".

text

string

Obbligatorio. Il testo per cui testare la voce.

TestPersonaVoiceResponse

Messaggio di risposta per EvaluationService.TestPersonaVoice.

Campi

audio

bytes

I byte di dati audio della voce sintetizzata.

TimeZoneSettings

Impostazioni del fuso orario dell'app.

Campi

time_zone

string

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

TlsConfig

La configurazione TLS.

Campi

ca_certs[]

TlsConfig.CaCert

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

CaCert

Il certificato CA.

Campi

display_name

string

Obbligatorio. Il nome dei certificati CA personalizzati consentiti. Può essere utilizzato per disambiguare i certificati CA personalizzati.

cert

bytes

Obbligatorio. I certificati CA personalizzati consentiti (in formato DER) per la verifica HTTPS. Esegue l'override dell'archivio di attendibilità SSL predefinito. Se questo campo è vuoto o non specificato, CES utilizzerà l'archivio di attendibilità predefinito di Google per verificare i certificati. 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'")

Strumento

Uno strumento rappresenta un'azione che l'agente CES può intraprendere per raggiungere determinati obiettivi.

Campi
`name`	`string` Identificatore. Il nome della risorsa dello strumento. Formato: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` per gli strumenti autonomi. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` per gli strumenti recuperati da un set di strumenti. Questi strumenti sono dinamici e solo di output; non è possibile farvi riferimento direttamente dove è previsto uno strumento.
`display_name`	`string` Solo output. Il nome visualizzato dello strumento, derivato in base al tipo di strumento. Ad esempio, il nome visualizzato di una [ClientFunction][Tool.ClientFunction] deriva dalla relativa proprietà `name`.
`execution_type`	`ExecutionType` Facoltativo. Il tipo di esecuzione dello strumento.
`timeout`	`Duration` Facoltativo. Il timeout per l'esecuzione dello strumento. Se non viene impostato, il timeout predefinito è di 30 secondi per gli strumenti `SYNCHRONOUS` e di 60 secondi per gli strumenti `ASYNCHRONOUS`.
`create_time`	`Timestamp` Solo output. Timestamp di creazione dello strumento.
`update_time`	`Timestamp` Solo output. Timestamp dell'ultimo aggiornamento dello strumento.
`etag`	`string` Etag utilizzato per garantire che l'oggetto non sia stato modificato durante un'operazione di lettura, modifica e scrittura. Se l'etag è vuoto, l'aggiornamento sovrascriverà eventuali modifiche simultanee.
`generated_summary`	`string` Solo output. Se lo strumento è generato dall'assistente LLM, questo campo contiene un riepilogo descrittivo della generazione.
`tool_fake_config`	`ToolFakeConfig` Facoltativo. Configurazione del comportamento dello strumento in modalità simulata.
`read_only`	`bool` Solo output. Indica se lo strumento è di sola lettura. Se è true, lo strumento non può essere modificato dall'utente.
Campo unione `tool_type`. Il tipo di strumento. `tool_type` può essere solo uno dei seguenti tipi:
`client_function`	`ClientFunction` Facoltativo. La funzione client.
`open_api_tool`	`OpenApiTool` Facoltativo. Lo strumento API aperto.
`google_search_tool`	`GoogleSearchTool` Facoltativo. Lo strumento di ricerca di Google.
`connector_tool`	`ConnectorTool` Facoltativo. Lo strumento Integration Connector.
`data_store_tool`	`DataStoreTool` Facoltativo. Lo strumento datastore.
`python_function`	`PythonFunction` Facoltativo. Lo strumento per le funzioni Python.
`mcp_tool`	`McpTool` Facoltativo. Lo strumento MCP. Uno strumento MCP non può essere creato o aggiornato direttamente ed è gestito dal set di strumenti MCP.
`file_search_tool`	`FileSearchTool` Facoltativo. Lo strumento di ricerca dei file.
`system_tool`	`SystemTool` Facoltativo. Lo strumento di sistema.
`agent_tool`	`AgentTool` Facoltativo. Lo strumento dell'agente.
`widget_tool`	`WidgetTool` Facoltativo. Lo strumento widget.
`remote_agent_tool`	`RemoteAgentTool` Facoltativo. Lo strumento dell'agente remoto.

ToolCall

Richiesta al cliente o all'agente di eseguire lo strumento specificato.

Campi
`id`	`string` Facoltativo. L'identificatore univoco della chiamata allo strumento. Se compilato, il client deve restituire il risultato dell'esecuzione con l'ID corrispondenza in `ToolResponse`.
`display_name`	`string` Solo output. Nome visualizzato dello strumento.
`args`	`Struct` Facoltativo. I parametri e i valori di input per lo strumento in formato oggetto JSON.
`parent_tool_call_id`	`string` Solo output. L'ID della chiamata allo strumento che ha causato questa, quando è stata emessa da un sub-agente che lavora per conto di una chiamata principale. Vuoto per le chiamate di primo livello. Consente a un cliente di raggruppare il lavoro di un subagente nella chiamata che lo ha avviato, anziché visualizzare ogni passaggio come elemento di pari livello.
`agent_name`	`string` Solo output. Nome leggibile dell'agente che ha effettuato questa chiamata, ad es. "Contract Architect". Vuoto quando è stato emesso dall'agente principale.
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`	`string` Facoltativo. Il nome dello strumento da eseguire. Formato: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
`toolset_tool`	`ToolsetTool` Facoltativo. Lo strumento del toolset da eseguire.

ToolCalls

Richiesta al client di eseguire gli strumenti e restituire i risultati dell'esecuzione prima di continuare la sessione.

Campi

tool_calls[]

ToolCall

Facoltativo. L'elenco delle chiamate di strumenti da eseguire.

ToolFakeConfig

Configurazione del comportamento dello strumento in modalità simulata.

Campi

enable_fake_mode

bool

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:

code_block

CodeBlock

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

ToolResponse

Il risultato dell'esecuzione di uno strumento specifico da parte del client o dell'agente.

Campi
`id`	`string` Facoltativo. L'ID corrispondenza di `tool call` a cui si riferisce la risposta.
`display_name`	`string` Solo output. Nome visualizzato dello strumento.
`response`	`Struct` 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 non vengono specificate le chiavi "output" ed "error", l'intera "response" viene trattata come risultato dell'esecuzione dello strumento.
`parent_tool_call_id`	`string` Solo output. L'ID della chiamata allo strumento che ha causato questa, quando è stata emessa da un sub-agente che lavora per conto di una chiamata principale. Vuoto per le chiamate di primo livello. Consente a un cliente di raggruppare il lavoro di un subagente nella chiamata che lo ha avviato, anziché visualizzare ogni passaggio come elemento di pari livello.
`agent_name`	`string` Solo output. Nome leggibile dell'agente che ha effettuato questa chiamata, ad es. "Contract Architect". Vuoto quando è stato emesso dall'agente principale.
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`	`string` Facoltativo. Il nome dello strumento da eseguire. Formato: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
`toolset_tool`	`ToolsetTool` Facoltativo. Lo strumento del toolset che è stato eseguito.

ToolResponses

Risultati dell'esecuzione per le chiamate agli strumenti richieste dal client.

Campi

tool_responses[]

ToolResponse

Facoltativo. L'elenco dei risultati dell'esecuzione dello strumento.

Toolset

Un insieme di strumenti rappresenta un gruppo di strumenti gestiti dinamicamente che possono essere utilizzati dall'agente.

Campi
`name`	`string` Identificatore. L'identificatore univoco del toolset. Formato: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
`display_name`	`string` Facoltativo. Il nome visualizzato del toolset. Deve essere univoco all'interno della stessa app.
`description`	`string` Facoltativo. La descrizione del toolset.
`timeout`	`Duration` Facoltativo. Il timeout per l'esecuzione del toolset. Se non viene impostato, il timeout predefinito è di 30 secondi per i toolset `SYNCHRONOUS` e di 60 secondi per i toolset `ASYNCHRONOUS`.
`create_time`	`Timestamp` Solo output. Timestamp di creazione del toolset.
`update_time`	`Timestamp` Solo output. Timestamp dell'ultimo aggiornamento del toolset.
`etag`	`string` ETag utilizzato per garantire che l'oggetto non sia stato modificato durante un'operazione di lettura, modifica e scrittura. Se l'etag è vuoto, l'aggiornamento sovrascriverà eventuali modifiche simultanee.
`execution_type`	`ExecutionType` Facoltativo. Il tipo di esecuzione degli strumenti nel toolset.
`tool_fake_config`	`ToolFakeConfig` Facoltativo. Configurazione del comportamento degli strumenti in modalità fittizia.
Campo unione `toolset_type`. Il tipo di toolset. `toolset_type` può essere solo uno dei seguenti tipi:
`mcp_toolset`	`McpToolset` Facoltativo. Un insieme di strumenti che contiene un elenco di strumenti offerti dal server MCP.
`open_api_toolset`	`OpenApiToolset` Facoltativo. Un insieme di strumenti che contiene un elenco di strumenti definiti da uno schema OpenAPI.
`connector_toolset`	`ConnectorToolset` Facoltativo. Un insieme di strumenti che genera strumenti da una connessione Integration Connectors.

ToolsetTool

Uno strumento creato da un insieme di strumenti.

Campi

toolset

string

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

tool_id

string

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

TransferRule

Regola per il trasferimento a un agente specifico.

Campi
`child_agent`	`string` Obbligatorio. Il nome della risorsa dell'agente secondario a cui si applica la regola. Formato: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
`direction`	`TransferRule.Direction` Obbligatorio. La direzione del trasferimento.
Campo unione `rule_type`. Il tipo di regola. `rule_type` può essere solo uno dei seguenti tipi:
`deterministic_transfer`	`TransferRule.DeterministicTransfer` Facoltativo. Una regola che viene trasferita immediatamente all'agente di destinazione quando la condizione è soddisfatta.
`disable_planner_transfer`	`TransferRule.DisablePlannerTransfer` Facoltativo. Regola che impedisce al pianificatore di trasferire la chiamata all'agente di destinazione.

DeterministicTransfer

Regola di trasferimento deterministica. Quando la condizione restituisce il valore true, il trasferimento viene eseguito.

Campi

Campo unione condition_type. La condizione da valutare. condition_type può essere solo uno dei seguenti tipi:

expression_condition

ExpressionCondition

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

python_code_condition

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.

Direzione

La direzione del trasferimento.

Enum
`DIRECTION_UNSPECIFIED`	Direzione non specificata.
`PARENT_TO_CHILD`	Trasferimento dall'agente principale all'agente secondario.
`CHILD_TO_PARENT`	Trasferimento dall'agente secondario all'agente principale.

DisablePlannerTransfer

Una regola che impedisce al pianificatore di trasferire la chiamata all'agente di destinazione.

Campi

expression_condition

ExpressionCondition

Obbligatorio. Se la condizione restituisce il valore true, il pianificatore non potrà essere trasferito all'agente di destinazione.

TriggerAction

Azione intrapresa quando viene soddisfatta una determinata precondizione.

Campi
Campo unione `action`. L'azione da intraprendere. `action` può essere solo uno dei seguenti tipi:
`respond_immediately`	`TriggerAction.RespondImmediately` Facoltativo. Rispondere immediatamente con una risposta preconfigurata.
`transfer_agent`	`TriggerAction.TransferAgent` Facoltativo. Trasferire la conversazione a un altro agente.
`generative_answer`	`TriggerAction.GenerativeAnswer` Facoltativo. Rispondere con una risposta generativa.

GenerativeAnswer

L'agente risponderà immediatamente con una risposta generativa.

Campi

prompt

string

Obbligatorio. Il prompt da utilizzare per la risposta generativa.

RespondImmediately

L'agente risponderà immediatamente con una risposta preconfigurata.

Campi

responses[]

TriggerAction.Response

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

Risposta

Rappresenta una risposta dell'agente.

Campi

text

string

Obbligatorio. Testo a cui l'agente deve rispondere.

disabled

Messaggio di richiesta per EvaluationService.UploadEvaluationAudio.

Campi

name

string

Obbligatorio. Il nome della risorsa della valutazione per cui caricare l'audio della valutazione. Formato: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

audio_content

bytes

Obbligatorio. I byte audio non elaborati. Il formato dell'audio deve essere LINEAR16 a canale singolo con una frequenza di campionamento di 16 kHz (InputAudioConfig predefinito).

previous_audio_gcs_uri

string

Facoltativo. L'URI Google Cloud Storage del file audio caricato in precedenza da eliminare. Formato: gs://<bucket-name>/<object-name>

UploadEvaluationAudioResponse

Messaggio di risposta per EvaluationService.UploadEvaluationAudio.

Campi

audio_gcs_uri

string

L'URI Google Cloud Storage in cui è archiviato il file audio caricato. Formato: gs://<bucket-name>/<object-name>

transcript

string

La trascrizione dell'audio, generata da Cloud Speech-to-Text.

duration