Package google.cloud.ces.v1

Indice

AgentService

Il servizio che gestisce le risorse correlate agli agenti in Gemini Enterprise for Customer Engagement (CES).

BatchDeleteConversations

rpc BatchDeleteConversations(BatchDeleteConversationsRequest) returns (Operation)

Elimina in batch le conversazioni specificate.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.conversations.delete

Per saperne di più, consulta la documentazione di IAM.
CreateAgent

rpc CreateAgent(CreateAgentRequest) returns (Agent)

Crea un nuovo agente nell'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.agents.create

Per saperne di più, consulta la documentazione di IAM.
CreateApp

rpc CreateApp(CreateAppRequest) returns (Operation)

Crea una nuova app nel progetto e nella località specificati.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.apps.create

Per saperne di più, consulta la documentazione di IAM.
CreateAppVersion

rpc CreateAppVersion(CreateAppVersionRequest) returns (AppVersion)

Crea una nuova versione dell'app nell'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.appVersions.create

Per saperne di più, consulta la documentazione di IAM.
CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Crea un nuovo deployment nell'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.deployments.create

Per saperne di più, consulta la documentazione di IAM.
CreateExample

rpc CreateExample(CreateExampleRequest) returns (Example)

Crea un nuovo esempio nell'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.examples.create

Per saperne di più, consulta la documentazione di IAM.
CreateGuardrail

rpc CreateGuardrail(CreateGuardrailRequest) returns (Guardrail)

Crea una nuova barriera protettiva nell'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.guardrails.create

Per saperne di più, consulta la documentazione di IAM.
CreateTool

rpc CreateTool(CreateToolRequest) returns (Tool)

Crea un nuovo strumento nell'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.tools.create

Per saperne di più, consulta la documentazione di IAM.
CreateToolset

rpc CreateToolset(CreateToolsetRequest) returns (Toolset)

Crea un nuovo toolset nell'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.toolsets.create

Per saperne di più, consulta la documentazione di IAM.
DeleteAgent

rpc DeleteAgent(DeleteAgentRequest) returns (Empty)

Elimina l'agente specificato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.agents.delete

Per saperne di più, consulta la documentazione di IAM.
DeleteApp

rpc DeleteApp(DeleteAppRequest) returns (Operation)

Elimina l'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.apps.delete

Per saperne di più, consulta la documentazione di IAM.
DeleteAppVersion

rpc DeleteAppVersion(DeleteAppVersionRequest) returns (Empty)

Elimina la versione dell'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.appVersions.delete

Per saperne di più, consulta la documentazione di IAM.
DeleteConversation

rpc DeleteConversation(DeleteConversationRequest) returns (Empty)

Elimina la conversazione specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.conversations.delete

Per saperne di più, consulta la documentazione di IAM.
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Elimina il deployment specificato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.deployments.delete

Per saperne di più, consulta la documentazione di IAM.
DeleteExample

rpc DeleteExample(DeleteExampleRequest) returns (Empty)

Elimina l'esempio specificato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.examples.delete

Per saperne di più, consulta la documentazione di IAM.
DeleteGuardrail

rpc DeleteGuardrail(DeleteGuardrailRequest) returns (Empty)

Elimina la barriera protettiva specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.guardrails.delete

Per saperne di più, consulta la documentazione di IAM.
DeleteTool

rpc DeleteTool(DeleteToolRequest) returns (Empty)

Elimina lo strumento specificato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.tools.delete

Per saperne di più, consulta la documentazione di IAM.
DeleteToolset

rpc DeleteToolset(DeleteToolsetRequest) returns (Empty)

Elimina il set di strumenti specificato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.toolsets.delete

Per saperne di più, consulta la documentazione di IAM.
ExportApp

rpc ExportApp(ExportAppRequest) returns (Operation)

Esporta l'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.apps.export

Per saperne di più, consulta la documentazione di IAM.
GetAgent

rpc GetAgent(GetAgentRequest) returns (Agent)

Recupera i dettagli dell'agente specificato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.agents.get

Per saperne di più, consulta la documentazione di IAM.
GetApp

rpc GetApp(GetAppRequest) returns (App)

Recupera i dettagli dell'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.apps.get

Per saperne di più, consulta la documentazione di IAM.
GetAppVersion

rpc GetAppVersion(GetAppVersionRequest) returns (AppVersion)

Recupera i dettagli della versione dell'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.appVersions.get

Per saperne di più, consulta la documentazione di IAM.
GetChangelog

rpc GetChangelog(GetChangelogRequest) returns (Changelog)

Recupera il changelog specificato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.changelogs.get

Per saperne di più, consulta la documentazione di IAM.
GetConversation

rpc GetConversation(GetConversationRequest) returns (Conversation)

Recupera i dettagli della conversazione specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.conversations.get

Per saperne di più, consulta la documentazione di IAM.
GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Recupera i dettagli del deployment specificato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.deployments.get

Per saperne di più, consulta la documentazione di IAM.
GetExample

rpc GetExample(GetExampleRequest) returns (Example)

Recupera i dettagli dell'esempio specificato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.examples.get

Per saperne di più, consulta la documentazione di IAM.
GetGuardrail

rpc GetGuardrail(GetGuardrailRequest) returns (Guardrail)

Recupera i dettagli della barriera protettiva specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.guardrails.get

Per saperne di più, consulta la documentazione di IAM.
GetTool

rpc GetTool(GetToolRequest) returns (Tool)

Recupera i dettagli dello strumento specificato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.tools.get

Per saperne di più, consulta la documentazione di IAM.
GetToolset

rpc GetToolset(GetToolsetRequest) returns (Toolset)

Recupera i dettagli del set di strumenti specificato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.toolsets.get

Per saperne di più, consulta la documentazione di IAM.
ImportApp

rpc ImportApp(ImportAppRequest) returns (Operation)

Importa l'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.apps.import

Per saperne di più, consulta la documentazione di IAM.
ListAgents

rpc ListAgents(ListAgentsRequest) returns (ListAgentsResponse)

Elenca gli agenti nell'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.agents.list

Per saperne di più, consulta la documentazione di IAM.
ListAppVersions

rpc ListAppVersions(ListAppVersionsRequest) returns (ListAppVersionsResponse)

Elenca tutte le versioni dell'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.appVersions.list

Per saperne di più, consulta la documentazione di IAM.
ListApps

rpc ListApps(ListAppsRequest) returns (ListAppsResponse)

Elenca le app nel progetto e nella località specifici.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.apps.list

Per saperne di più, consulta la documentazione di IAM.
ListChangelogs

rpc ListChangelogs(ListChangelogsRequest) returns (ListChangelogsResponse)

Elenca i log delle modifiche dell'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.changelogs.list

Per saperne di più, consulta la documentazione di IAM.
ListConversations

rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse)

Elenca le conversazioni nell'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.conversations.list

Per saperne di più, consulta la documentazione di IAM.
ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Elenca i deployment nell'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.deployments.list

Per saperne di più, consulta la documentazione di IAM.
ListExamples

rpc ListExamples(ListExamplesRequest) returns (ListExamplesResponse)

Elenca gli esempi nell'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.examples.list

Per saperne di più, consulta la documentazione di IAM.
ListGuardrails

rpc ListGuardrails(ListGuardrailsRequest) returns (ListGuardrailsResponse)

Elenca i guardrail nell'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.guardrails.list

Per saperne di più, consulta la documentazione di IAM.
ListTools

rpc ListTools(ListToolsRequest) returns (ListToolsResponse)

Elenca gli strumenti nell'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.tools.list

Per saperne di più, consulta la documentazione di IAM.
ListToolsets

rpc ListToolsets(ListToolsetsRequest) returns (ListToolsetsResponse)

Elenca i toolset nell'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.toolsets.list

Per saperne di più, consulta la documentazione di IAM.
RestoreAppVersion

rpc RestoreAppVersion(RestoreAppVersionRequest) returns (Operation)

Ripristina la versione dell'app specificata. Verrà creata una nuova versione dell'app dalla bozza attuale e la bozza attuale verrà sovrascritta con la versione dell'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.appVersions.restore

Per saperne di più, consulta la documentazione di IAM.
UpdateAgent

rpc UpdateAgent(UpdateAgentRequest) returns (Agent)

Aggiorna l'agente specificato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.agents.update

Per saperne di più, consulta la documentazione di IAM.
UpdateApp

rpc UpdateApp(UpdateAppRequest) returns (App)

Aggiorna l'app specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.apps.update

Per saperne di più, consulta la documentazione di IAM.
UpdateDeployment

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment)

Aggiorna il deployment specificato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.deployments.update

Per saperne di più, consulta la documentazione di IAM.
UpdateExample

rpc UpdateExample(UpdateExampleRequest) returns (Example)

Aggiorna l'esempio specificato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.examples.update

Per saperne di più, consulta la documentazione di IAM.
UpdateGuardrail

rpc UpdateGuardrail(UpdateGuardrailRequest) returns (Guardrail)

Aggiorna la barriera di protezione specificata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.guardrails.update

Per saperne di più, consulta la documentazione di IAM.
UpdateTool

rpc UpdateTool(UpdateToolRequest) returns (Tool)

Aggiorna lo strumento specificato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.tools.update

Per saperne di più, consulta la documentazione di IAM.
UpdateToolset

rpc UpdateToolset(UpdateToolsetRequest) returns (Toolset)

Aggiorna il set di strumenti specificato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.toolsets.update

Per saperne di più, consulta la documentazione di IAM.

SessionService

Il servizio di sessione fornisce API per interagire con gli agenti CES.

BidiRunSession

rpc BidiRunSession(BidiSessionClientMessage) returns (BidiSessionServerMessage)

Stabilisce una connessione di streaming bidirezionale con l'agente CES. L'agente elabora input multimodali continui (ad es. testo, audio) e genera stream di output multimodali in tempo reale.

--- Client Request Stream --- Il client trasmette le richieste nel seguente ordine:

  1. Inizializzazione: il primo messaggio deve contenere SessionConfig. Per le sessioni audio, devono essere inclusi anche InputAudioConfig e OutputAudioConfig per definire i parametri di elaborazione e sintesi audio.

  2. Interazione: flusso di messaggi successivo SessionInput contenente dati di input utente in tempo reale.

  3. Terminazione: il client deve chiudere parzialmente lo stream quando non ci sono più input utente'utente. Inoltre, deve chiudersi a metà quando riceve EndSession o GoAway dall'agente.

--- Server Response Stream --- Per ogni turno di interazione, l'agente trasmette i messaggi in streaming nella seguente sequenza:

  1. Riconoscimento vocale (primi N messaggi): contiene RecognitionResult che rappresenta i segmenti vocali dell'utente concatenati acquisiti finora. Questo campo viene compilato solo per le sessioni audio.

  2. Risposta (prossimi M messaggi): contiene SessionOutput che fornisce la risposta dell'agente in varie modalità (ad es. testo, audio).

  3. Completamento del turno (ultimo messaggio del turno): contiene SessionOutput con turn_completed impostato su true. Indica la fine del turno corrente e include DiagnosticInfo con i dettagli di esecuzione.

--- Best practice per l'audio --- 1. Streaming: riproduci in streaming audio data ININTERROTTAMENTE, anche durante il silenzio. Dimensioni del segmento consigliate: 40-120 ms (bilancia la latenza rispetto all'efficienza).

  1. Riproduzione e interruzione: riproduci audio responses al ricevimento. Interrompi immediatamente la riproduzione se viene ricevuto un InterruptionSignal (ad es. interruzione da parte dell'utente o nuova risposta dell'agente).
Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa session:

  • ces.sessions.bidiRunSession

Per saperne di più, consulta la documentazione di IAM.
RunSession

rpc RunSession(RunSessionRequest) returns (RunSessionResponse)

Avvia un'interazione di un solo turno con l'agente CES all'interno di una sessione.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa session:

  • ces.sessions.runSession

Per saperne di più, consulta la documentazione di IAM.

ToolService

Il servizio di strumenti fornisce API per interagire con gli strumenti CES.

ExecuteTool

rpc ExecuteTool(ExecuteToolRequest) returns (ExecuteToolResponse)

Esegue lo strumento specificato con gli argomenti indicati.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.tools.execute

Per saperne di più, consulta la documentazione di IAM.
RetrieveToolSchema

rpc RetrieveToolSchema(RetrieveToolSchemaRequest) returns (RetrieveToolSchemaResponse)

Recupera lo schema dello strumento specificato. Lo schema viene calcolato in tempo reale per l'istanza specificata dello strumento.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.tools.get

Per saperne di più, consulta la documentazione di IAM.
RetrieveTools

rpc RetrieveTools(RetrieveToolsRequest) returns (RetrieveToolsResponse)

Recupera l'elenco degli strumenti inclusi nel set di strumenti specificato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa toolset:

  • ces.toolsets.get

Per saperne di più, consulta la documentazione di IAM.

WidgetService

Fornisce API per i widget per interagire con le API CES.

GenerateChatToken

rpc GenerateChatToken(GenerateChatTokenRequest) returns (GenerateChatTokenResponse)

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

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Azione

Configurazione di un'azione da utilizzare per lo strumento. Nota: può trattarsi di un'azione o di un'operazione. Per maggiori dettagli, consulta https://cloud.google.com/integration-connectors/docs/entities-operation-action.

Campi
input_fields[]

string

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

string

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

string

ID di un'azione di connessione da utilizzare per lo strumento.
entity_operation

Action.EntityOperation

Configurazione dell'operazione dell'entità da utilizzare per lo strumento.

EntityOperation

Specifica dell'operazione CRUD dell'entità.

Campi
entity_id

string

Obbligatorio. ID dell'entità.
operation

Action.EntityOperation.OperationType

Obbligatorio. Operazione da eseguire sull'entità.

OperationType

L'operazione da eseguire sull'entità.

Enum
OPERATION_TYPE_UNSPECIFIED Tipo di operazione non specificato. Non valido, la creazione/l'aggiornamento di ConnectorTool non riuscirà.
LIST Elenco operazioni.
GET Recupera operazione.
CREATE Crea operazione.
UPDATE Operazione di aggiornamento.
DELETE Operazione di eliminazione.

Agente

Un agente funge da elemento costitutivo fondamentale che fornisce istruzioni al modello linguistico di grandi dimensioni (LLM) per l'esecuzione di attività specifiche.

Campi
name

string

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

string

Obbligatorio. Il nome visualizzato dell'agente.
description

string

Facoltativo. Descrizione dell'agente leggibile.
model_settings

ModelSettings

Facoltativo. Configurazioni per il modello LLM.
instruction

string

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

string

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

string

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

Callback

Facoltativo. Le funzioni di callback da eseguire prima di chiamare l'agente. Le callback fornite vengono eseguite in sequenza nell'ordine esatto in cui sono elencate. Se un callback restituisce una risposta sostituita, l'esecuzione si interrompe e tutti i callback rimanenti vengono ignorati.
after_agent_callbacks[]

Callback

Facoltativo. I callback da eseguire dopo la chiamata all'agente. Le callback fornite vengono eseguite in sequenza nell'ordine esatto in cui sono elencate. Se un callback restituisce una risposta sostituita, l'esecuzione si interrompe e tutti i callback rimanenti vengono ignorati.
before_model_callbacks[]

Callback

Facoltativo. I callback da eseguire prima di chiamare il modello. Se vengono effettuate più chiamate al modello, il callback verrà eseguito più volte. Le callback fornite vengono eseguite in sequenza nell'ordine esatto in cui sono elencate. Se un callback restituisce una risposta sostituita, l'esecuzione si interrompe e tutti i callback rimanenti vengono ignorati.
after_model_callbacks[]

Callback

Facoltativo. I callback da eseguire dopo la chiamata al modello. Se vengono effettuate più chiamate al modello, il callback verrà eseguito più volte. Le callback fornite vengono eseguite in sequenza nell'ordine esatto in cui sono elencate. Se un callback restituisce una risposta sostituita, l'esecuzione si interrompe e tutti i callback rimanenti vengono ignorati.
before_tool_callbacks[]

Callback

Facoltativo. Le funzioni di callback da eseguire prima di richiamare lo strumento. Se ci sono più chiamate di strumenti, il callback verrà eseguito più volte. Le callback fornite vengono eseguite in sequenza nell'ordine esatto in cui sono elencate. Se un callback restituisce una risposta sostituita, l'esecuzione si interrompe e tutti i callback rimanenti vengono ignorati.
after_tool_callbacks[]

Callback

Facoltativo. I callback da eseguire dopo l'invocazione dello strumento. Se ci sono più chiamate di strumenti, il callback verrà eseguito più volte. Le callback fornite vengono eseguite in sequenza nell'ordine esatto in cui sono elencate. Se un callback restituisce una risposta sostituita, l'esecuzione si interrompe e tutti i callback rimanenti vengono ignorati.
create_time

Timestamp

Solo output. Timestamp di creazione dell'agente.
update_time

Timestamp

Solo output. Timestamp dell'ultimo aggiornamento dell'agente.
guardrails[]

string

Facoltativo. Elenco delle barriere protettive per l'agente. Formato: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
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.
toolsets[]

Agent.AgentToolset

Facoltativo. Elenco dei toolset per l'agente.
generated_summary

string

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

TransferRule

Facoltativo. Regole di trasferimento degli agenti. Se corrispondono più regole, verrà utilizzata la prima nell'elenco.
Campo unione agent_type. Il tipo di agente. agent_type può essere solo uno dei seguenti tipi:
llm_agent

Agent.LlmAgent

Facoltativo. Il tipo di agente predefinito.
remote_dialogflow_agent

Agent.RemoteDialogflowAgent

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

Nota: se l'agente Dialogflow si trova in un progetto diverso dall'app, devi concedere roles/dialogflow.client al service agent CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

AgentToolset

Un set di strumenti con una selezione di strumenti.

Campi
toolset

string

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

string

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

LlmAgent

Questo tipo non contiene campi.

Tipo di agente predefinito. L'agente utilizza le istruzioni e i callback specificati nell'agente per eseguire l'attività utilizzando un modello linguistico di grandi dimensioni.

RemoteDialogflowAgent

L'agente che trasferirà l'esecuzione a un agente Dialogflow CX remoto. L'agente Dialogflow elaborerà le query utente successive fino al termine della sessione o del flusso e il controllo verrà trasferito di nuovo all'agente CES principale.

Campi
agent

string

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

string

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

string

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

map<string, string>

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

map<string, string>

Facoltativo. Il mapping dei nomi dei parametri di sessione di Dialogflow ai nomi delle variabili dell'app da inviare di nuovo all'agente CES al termine dell'esecuzione dell'agente Dialogflow.
respect_response_interruption_settings

bool

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

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

AgentTransfer

Rappresenta un evento che indica il trasferimento di una conversazione a un altro agente.

Campi
target_agent

string

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

string

Solo output. Il nome visualizzato dell'agente.

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 di volume (in dB) del volume nativo normale supportato dal rumore ambientale, nell'intervallo [-96,0, 16,0]. Se non è impostato o è impostato su un valore di 0, 0 dB, verrà riprodotto con l'ampiezza del segnale nativo normale. Un valore di -6,0 dB verrà riprodotto a circa metà dell'ampiezza del segnale nativo normale. Un valore di +6,0 (dB) verrà riprodotto a un'ampiezza circa doppia rispetto a quella normale del segnale nativo. Ti consigliamo vivamente di non superare +10 (dB), in quanto di solito non si verifica un aumento effettivo del volume per valori superiori.
Campo unione source. Rumore ambientale da riprodurre con la risposta dell'agente sintetizzata, per migliorare la naturalezza della conversazione. source può essere solo uno dei seguenti tipi:
prebuilt_ambient_noise
(deprecated)

AmbientSoundConfig.PrebuiltAmbientNoise

Facoltativo. Deprecato: prebuilt_ambient_noise è deprecato a favore di 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 la 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 al service agent CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
request_location

ApiKeyConfig.RequestLocation

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 registrazione nel log 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 impostare 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 informazioni aggiuntive 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.
locked

bool

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

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 il ToolContext aggiornato.

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 è un'istantanea dell'app in un momento specifico. È immutabile e non può essere modificato una volta creato.

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 della creazione 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 sintesi della risposta dell'agente, mapping dal codice della lingua a SynthesizeSpeechConfig.

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

Nota: il codice lingua non fa distinzione tra maiuscole e minuscole.
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 comando vocale o interazione) prima che l'agente gli chieda di riprendere l'interazione. Se non viene impostato, l'agente non chiederà all'utente di riprendere l'interazione.
ambient_sound_config

AmbientSoundConfig

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

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. Disattiva l'interruzione da parte dell'utente mentre l'agente sta parlando. Se è true, l'input utente durante la riproduzione della risposta dell'agente verrà ignorato.

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

bool

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

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 in BigQuery è attivata.
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. Il 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 con l'agente.

Campi
description

string

Facoltativo. Descrizione leggibile del callback.
disabled

bool

Facoltativo. Indica se il callback è 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. ATTIVARE CON CAUTELA. In genere, il callback del modello deve essere eseguito solo dopo aver ricevuto tutte le risposte del modello. L'attivazione dell'esecuzione proattiva può avere implicazioni negative sul costo e sulla latenza dell'esecuzione e deve essere attivata solo in rare situazioni.
Campo unione callback. Il callback da eseguire. callback può essere solo uno dei seguenti tipi:
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. L'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.
disable_dtmf

bool

Facoltativo. Indica se disattivare la tecnologia multifrequenza a due toni (DTMF).
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.
web_widget_config

ChannelProfile.WebWidgetConfig

Facoltativo. La configurazione del widget web.
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).
FIVE9 Canale Five9.
CONTACT_CENTER_INTEGRATION Canale di integrazione del contact center di terze parti.

PersonaProperty

Rappresenta la proprietà della persona di un canale.

Campi
persona

ChannelProfile.PersonaProperty.Persona

Facoltativo. La personalità del canale.

Utente tipo

La personalità del canale.

Enum
UNKNOWN Utente tipo SCONOSCIUTO.
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 sia quello tramite chat.
VOICE_ONLY Il widget supporta solo l'input vocale.
CHAT_ONLY Il widget supporta solo l'input della chat.

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, sono consentite tutte le origini. 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.

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

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.

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

ConnectorTool

Uno strumento connettore 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 ignorarlo con una configurazione di autenticazione dell'utente finale diversa. Nota: per specificare una configurazione EUC qui, l'override dell'autenticazione deve essere abilitato nella connessione. In caso contrario, la creazione di ConnectorTool non riuscirà. Per i dettagli, vedi https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override.
name

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 ignorarlo con una configurazione di autenticazione dell'utente finale diversa. Nota: per specificare una configurazione EUC qui, l'override dell'autenticazione deve essere abilitato per la connessione. In caso contrario, la creazione del Toolset non riuscirà. Consulta: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
connector_actions[]

Action

Obbligatorio. L'elenco delle azioni/operazioni sulle entità del connettore per cui generare gli 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

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

Deprecato. Utilizza invece i turni.

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 della conversazione (ad es. immagine) tra l'utente finale e l'agente.

InputType

Il tipo di messaggio di input.

Enum
INPUT_TYPE_UNSPECIFIED Tipo di input non specificato.
INPUT_TYPE_TEXT Il messaggio di input è testo.
INPUT_TYPE_AUDIO Il messaggio di input è audio.
INPUT_TYPE_IMAGE Il messaggio di input è un'immagine.
INPUT_TYPE_BLOB Il messaggio di input è un file blob.
INPUT_TYPE_TOOL_RESPONSE Il messaggio di input è la risposta dello strumento della funzione client.
INPUT_TYPE_VARIABLES Il messaggio di input sono 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 riguarda la valutazione.

Turn

Tutte le informazioni su un singolo turno della conversazione.

Campi
messages[]

Message

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

Span

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

ConversationLoggingSettings

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

Campi
disable_conversation_logging

bool

Facoltativo. Se disattivare la registrazione delle conversazioni per le sessioni.

CreateAgentRequest

Messaggio di richiesta per AgentService.CreateAgent.

Campi
parent

string

Obbligatorio. Il nome della risorsa dell'app in cui creare un agente.
agent_id

string

Facoltativo. L'ID da utilizzare per l'agente, che diventerà il componente finale del nome della risorsa dell'agente. Se non viene fornito, all'agente verrà assegnato automaticamente un ID univoco.
agent

Agent

Obbligatorio. L'agente da creare.

CreateAppRequest

Messaggio di richiesta per AgentService.CreateApp.

Campi
parent

string

Obbligatorio. Il nome della risorsa della posizione in cui creare un'app.
app_id

string

Facoltativo. L'ID da utilizzare per l'app, che diventerà il componente finale del nome della risorsa dell'app. Se non viene fornito, all'app verrà assegnato automaticamente un ID univoco.
app

App

Obbligatorio. L'app per creare.

CreateAppVersionRequest

Messaggio di richiesta per AgentService.CreateAppVersion

Campi
parent

string

Obbligatorio. Il nome della risorsa dell'app in cui creare una versione dell'app.
app_version_id

string

Facoltativo. L'ID da utilizzare per la versione dell'app, che diventerà il componente finale del nome della risorsa della versione dell'app. Se non viene fornito, verrà assegnato automaticamente un ID univoco per la versione dell'app.
app_version

AppVersion

Obbligatorio. La versione dell'app da creare.

CreateDeploymentRequest

Messaggio di richiesta per AgentService.CreateDeployment.

Campi
parent

string

Obbligatorio. L'app genitore. Formato: projects/{project}/locations/{location}/apps/{app}
deployment_id

string

Facoltativo. L'ID da utilizzare per il deployment, che diventerà il componente finale del nome della risorsa del deployment. Se non viene fornito, verrà assegnato automaticamente un ID univoco per il deployment.
deployment

Deployment

Obbligatorio. Il deployment da creare.

CreateExampleRequest

Messaggio di richiesta per AgentService.CreateExample.

Campi
parent

string

Obbligatorio. Il nome della risorsa dell'app in cui creare un esempio.
example_id

string

Facoltativo. L'ID da utilizzare per l'esempio, che diventerà il componente finale del nome della risorsa dell'esempio. Se non viene fornito, all'esempio verrà assegnato automaticamente un ID univoco.
example

Example

Obbligatorio. L'esempio da creare.

CreateGuardrailRequest

Messaggio di richiesta per AgentService.CreateGuardrail.

Campi
parent

string

Obbligatorio. Il nome della risorsa dell'app in cui creare una barriera protettiva.
guardrail_id

string

Facoltativo. L'ID da utilizzare per la barriera protettiva, che diventerà il componente finale del nome della risorsa della barriera protettiva. Se non viene fornito, verrà assegnato automaticamente un ID univoco per la protezione.
guardrail

Guardrail

Obbligatorio. Il guardrail da creare.

CreateToolRequest

Messaggio di richiesta per AgentService.CreateTool.

Campi
parent

string

Obbligatorio. Il nome della risorsa dell'app in cui creare uno strumento.
tool_id

string

Facoltativo. L'ID da utilizzare per lo strumento, che diventerà il componente finale del nome della risorsa dello strumento. Se non viene fornito, verrà assegnato automaticamente un ID univoco per lo strumento.
tool

Tool

Obbligatorio. Lo strumento per creare.

CreateToolsetRequest

Messaggio di richiesta per AgentService.CreateToolset.

Campi
parent

string

Obbligatorio. Il nome della risorsa dell'app in cui creare un set di strumenti.
toolset_id

string

Facoltativo. L'ID da utilizzare per il toolset, che diventerà il componente finale del nome della risorsa del toolset. Se non viene fornito, verrà assegnato automaticamente un ID univoco per il toolset.
toolset

Toolset

Obbligatorio. Il set di strumenti per creare.

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 dell'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

Il 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, pertanto non verrà utilizzato durante la ricerca.
PUBLIC_WEB Un datastore che contiene contenuti web pubblici.
UNSTRUCTURED Un datastore che contiene dati privati non strutturati.
FAQ Un datastore che contiene dati strutturati utilizzati come domande frequenti.
CONNECTOR Un datastore che è 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 dell'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_CHAT Tipo di motore di chat. Il motore SOLUTION_TYPE_CHAT per l'app. Tutti gli archivi dati 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. Aumenta la specifica per aumentare la visibilità di 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

Aumenta la specifica per aumentare la visibilità di determinati documenti.

Campi
condition_boost_specs[]

DataStoreTool.BoostSpec.ConditionBoostSpec

Obbligatorio. Un elenco di specifiche di boosting.

ConditionBoostSpec

Aumenta la specifica per una condizione.

Campi
condition

string

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

float

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

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

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

Se il valore è impostato su 0,0, non viene applicato alcun boost. La condizione di incremento viene ignorata.
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. Offre più controlli per la classificazione personalizzata rispetto alla semplice combinazione (condizione, aumento) riportata sopra.

Campi
field_name

string

Facoltativo. Il nome del campo il cui valore verrà utilizzato per determinare l'importo dell'aggiustamento.
attribute_type

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType

Facoltativo. Il tipo di attributo da utilizzare per determinare l'importo del boost. Il valore dell'attributo può essere derivato dal valore del campo field_name specificato. Nel caso di valori numerici, è semplice, ad esempio attribute_value = numerical_field_value. Nel caso della freschezza, attribute_value = (time.now() - datetime_field_value).
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 Tipo di attributo non specificato.
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 il caso d'uso della freschezza, il valore dell'attributo sarà la durata tra l'ora corrente e la data nel campo datetime specificato. Il valore deve essere formattato come valore XSD dayTimeDuration (un sottoinsieme limitato di un valore di durata ISO 8601). Il pattern è: [nD][T[nH][nM][nS]]. Ad esempio, 5D, 3DT12H30M, T24H.

ControlPoint

I punti di controllo utilizzati per definire la curva. La curva definita da 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 del campo numerico. 2. La specifica della durata per l'aggiornamento: 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

Aumenta le specifiche per dare priorità a determinati documenti. Per ulteriori informazioni, 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 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 viene applicata 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 dei parametri di filtro.

Enum
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED Comportamento predefinito del filtro. Includi il parametro di filtro per i datastore 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 una soglia per la fondatezza della risposta, il che significa che tutte le risposte con un punteggio di fondatezza inferiore alla soglia torneranno a restituire solo snippet pertinenti.

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

bool

Facoltativo. Indica se la messa a terra è disattivata.

ModalityConfig

Se specificato, 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 dello strumento di riscrittura.
summarization_config

DataStoreTool.SummarizationConfig

Facoltativo. La configurazione del riepilogo.
grounding_config

DataStoreTool.GroundingConfig

Facoltativo. La configurazione di messa a terra.

ModalityType

Il tipo di modalità.

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

RewriterConfig

Configurazione dello strumento di riscrittura.

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.

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 a questo intent.
  • Se force = true, elimina l'agente e rimuovilo da tutte le app, gli agenti e 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 attuale 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, per impostazione predefinita verrà applicato Source.Live.

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.

DeleteExampleRequest

Messaggio di richiesta per AgentService.DeleteExample.

Campi
name

string

Obbligatorio. Il nome della risorsa dell'esempio da eliminare.
etag

string

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

DeleteGuardrailRequest

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 come riferimento da app/agenti.

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

string

Facoltativo. L'etag attuale della barriera protettiva. 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.

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 qualche agente fa 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 ad 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.

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.

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

Struct

Facoltativo. Fornisce ulteriori informazioni 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

EndUserAuthConfig.Oauth2AuthCodeConfig

Autenticazione con 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 della concessione di 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>.

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.

ErrorHandlingStrategy

Definisce la strategia per la gestione degli errori.

Enum
ERROR_HANDLING_STRATEGY_UNSPECIFIED Strategia di gestione degli errori non specificata. Il valore predefinito è FALLBACK_RESPONSE.
NONE Non è attivata alcuna gestione specifica.
FALLBACK_RESPONSE In caso di errori del modello linguistico di grandi dimensioni, all'utente verrà restituito un messaggio di riserva.

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

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 delle allucinazioni per le valutazioni di riferimento.
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 dei singoli strumenti. Deve essere un numero in virgola mobile compreso tra 0 e 1. Il valore predefinito è 1.0.

TurnLevelMetricsThresholds

Soglie delle metriche di livello.

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 Utilizza 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 Attiva la metrica di allucinazione.

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 strumento aggiuntiva. 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 Non superare la valutazione se viene rilevata una chiamata aggiuntiva allo strumento.
ALLOW Consenti la chiamata allo strumento aggiuntiva.

Evento

Input evento.

Campi
event

string

Obbligatorio. Il nome dell'evento.

Esempio

Un esempio rappresenta una conversazione di esempio 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.
variables

Struct

Facoltativo. Le variabili disponibili per l'esecuzione dello strumento.
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.

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 le chiavi "output" ed "error" non sono specificate, l'intera "response" viene trattata come risultato dell'esecuzione dello strumento.
variables

Struct

I valori delle variabili al termine dell'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.

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.

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.

ExpressionCondition

Condizione dell'espressione basata sullo stato della sessione.

Campi
expression

string

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

FileSearchTool

Lo strumento di ricerca dei file consente all'agente di eseguire ricerche nei file caricati dallo sviluppatore dell'app/dell'agente. Dispone di impostazioni predefinite 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.

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.

GenerateChatTokenResponse

Messaggio di risposta per WidgetService.GenerateChatToken.

Campi
chat_token

string

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

Timestamp

L'ora in cui scade il token di chat.

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)

Conversation.Source

Facoltativo. Indica l'origine della conversazione. Se non viene impostata, verrà eseguita la ricerca in tutte le fonti.

GetDeploymentRequest

Messaggio di richiesta per AgentService.GetDeployment.

Campi
name

string

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

GetExampleRequest

Messaggio di richiesta per AgentService.GetExample.

Campi
name

string

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

GetGuardrailRequest

Messaggio di richiesta per AgentService.GetGuardrail.

Campi
name

string

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

GetToolRequest

Messaggio di richiesta per AgentService.GetTool.

Campi
name

string

Obbligatorio. Il nome della risorsa dello strumento da recuperare.

GetToolsetRequest

Messaggio di richiesta per AgentService.GetToolset.

Campi
name

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.

GoogleSearchSuggestions

Suggerimenti di ricerca da Google Search Tool.

Campi
htmls[]

string

Stili HTML e CSS conformi 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 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 di 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

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

Campi
name

string

Identificatore. L'identificatore univoco della barriera protettiva. 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 barriera protettiva è 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 impedisce l'utilizzo di determinati contenuti nella conversazione.
llm_prompt_security

Guardrail.LlmPromptSecurity

Facoltativo. Barriera protettiva che blocca la conversazione se il prompt viene considerato non sicuro in base alla classificazione LLM.
llm_policy

Guardrail.LlmPolicy

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

Guardrail.ModelSafety

Facoltativo. Barriera protettiva che blocca la conversazione se la risposta del 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.

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 impedisce l'utilizzo di determinati contenuti nella conversazione.

Campi
banned_contents[]

string

Facoltativo. Elenco di frasi vietate. Si applica sia agli input dell'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 protettiva 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, viene utilizzato un valore predefinito di 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, non eseguire l'operazione e non attivare 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 delle norme 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 dei criteri 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 dei criteri 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 del modello linguistico di grandi dimensioni. - Se true: la barriera di protezione viene bypassata. - Se il valore è false (impostazione predefinita), il guardrail viene attivato/bloccato.

Nota: se viene fornita una norma personalizzata, questo campo viene ignorato a favore della configurazione "fail_open" della norma.
Campo unione security_config. Definisce la modalità di configurazione della sicurezza. L'utente deve scegliere una delle seguenti configurazioni. security_config può essere solo uno dei seguenti tipi:
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 prompt predefinito utilizzato dal sistema. Questo campo viene visualizzato per mostrare all'utente il prompt utilizzato dal sistema per impostazione predefinita. È 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 blocco più esteso).
BLOCK_MEDIUM_AND_ABOVE Blocca la soglia media e superiore.
BLOCK_ONLY_HIGH Blocco solo soglia alta (ovvero 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 del danno è 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 è Contenuti sessualmente espliciti.

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.

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.

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, viene generato un errore INVALID_ARGUMENT.
app_id

string

Facoltativo. L'ID da utilizzare per l'app importata. * Se non specificato, all'app verrà assegnato automaticamente un ID univoco. * In caso contrario, l'app importata utilizzerà questo ID come componente finale del nome della 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 app durante l'importazione. Se è impostato su true, il processo di importazione ignorerà il blocco 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.

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.

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

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. Indica se attivare la soppressione del rumore nell'audio di input. I valori disponibili sono "low", "moderate", "high", "very_high".

InterruptionSignal

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

Campi
barge_in

bool

Indica 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

string

Facoltativo. L'azione da eseguire quando un agente riceve input in una lingua non supportata.

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

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 AgentService.ListAgents dell'elenco.
filter

string

Facoltativo. Filtro da applicare durante l'elenco degli 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 pagine successive.

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 AgentService.ListAppVersions dell'elenco.
filter

string

Facoltativo. Filtro da applicare quando vengono elencate le 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 pagine successive.

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 AgentService.ListApps dell'elenco.
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 pagine successive.
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 AgentService.ListChangelogs dell'elenco.
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 per 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 pagine successive.

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 AgentService.ListConversations dell'elenco.
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, per impostazione predefinita verrà applicato Source.Live. Verrà ritirato a favore del campo sources.
sources[]

Conversation.Source

Facoltativo. Indica le origini delle conversazioni. Se non viene impostato, per impostazione predefinita vengono 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 pagine successive.

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.

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 AgentService.ListExamples dell'elenco.
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 pagine successive.

ListGuardrailsRequest

Messaggio di richiesta per AgentService.ListGuardrails.

Campi
parent

string

Obbligatorio. Il nome della risorsa dell'app da cui elencare le misure di protezione.
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 AgentService.ListGuardrails dell'elenco.
filter

string

Facoltativo. Filtro da applicare durante l'elenco delle protezioni. 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 dei guardrail.
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 pagine successive.

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 AgentService.ListTools dell'elenco.
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 pagine successive.

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 AgentService.ListToolsets dell'elenco.
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 pagine successive.

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

BigQueryExportSettings

Facoltativo. Impostazioni per descrivere i comportamenti di esportazione BigQuery per l'app. Se abilitati, i dati delle conversazioni 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.
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 in streaming. È uguale a server_address in McpToolset. Per ulteriori dettagli, consulta la pagina https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.
api_authentication

ApiAuthentication

Facoltativo. Informazioni di autenticazione necessarie per eseguire lo strumento sul server MCP. Per l'autenticazione con token di autenticazione, il token si applica solo all'esecuzione dello strumento, non agli strumenti di inserzione. Ciò richiede che gli strumenti possano essere elencati senza autenticazione.
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.

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 in streaming. Per ulteriori dettagli, consulta la pagina 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 autenticazione, il token si applica solo all'esecuzione dello strumento, non agli strumenti di inserzione. Ciò richiede che gli strumenti possano essere elencati senza autenticazione.
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.

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

Timestamp

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.

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 è impostato, l'agente erediterà il modello dall'agente principale.
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.

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

string

Obbligatorio. L'endpoint 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.

Omnicanale

Rappresenta una risorsa omnicanale.

Campi
name

string

Identificatore. L'identificatore univoco della risorsa omnicanale. Formato: projects/{project}/locations/{location}/omnichannels/{omnichannel}
display_name

string

Obbligatorio. Nome visualizzato della risorsa omnicanale.
description

string

Facoltativo. Descrizione leggibile della risorsa omnicanale.
create_time

Timestamp

Solo output. Timestamp di creazione della risorsa omnicanale.
update_time

Timestamp

Solo output. Timestamp dell'ultimo aggiornamento della risorsa omnicanale.
etag

string

Solo output. Etag utilizzato per garantire che l'oggetto non sia stato modificato durante un'operazione di lettura, modifica e scrittura.
integration_config

OmnichannelIntegrationConfig

Facoltativo. La configurazione dell'integrazione per la risorsa omnicanale.

OmnichannelIntegrationConfig

OmnichannelIntegrationConfig contiene tutte le configurazioni di integrazione delle app.

Campi
channel_configs

map<string, OmnichannelIntegrationConfig.ChannelConfig>

Facoltativo. Varie configurazioni per la gestione degli eventi delle app.
subscriber_configs

map<string, OmnichannelIntegrationConfig.SubscriberConfig>

Facoltativo. Varie configurazioni degli iscritti.
routing_configs

map<string, OmnichannelIntegrationConfig.RoutingConfig>

Facoltativo. La chiave di routing_configs è una chiave di app_configs, il valore è un RoutingConfig, che contiene la chiave dell'abbonato.

CesAppConfig

Configurazioni per l'app CES.

Campi
app

string

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

ChannelConfig

ChannelConfig contiene la configurazione per varie integrazioni di app.

Campi
Campo unione channel_config. La configurazione dell'app. channel_config può essere solo uno dei seguenti tipi:
whatsapp_config

OmnichannelIntegrationConfig.WhatsappConfig

Configurazione di WhatsApp.

RoutingConfig

La configurazione del routing specifica come/a chi indirizzare gli eventi dell'app a un abbonato.

Campi
subscriber_key

string

La chiave dell'abbonato.

SubscriberConfig

Configurazioni degli abbonati.

Campi
Campo unione subscriber_config. La configurazione per il sottoscrittore. subscriber_config può essere solo uno dei seguenti tipi:
ces_app_config

OmnichannelIntegrationConfig.CesAppConfig

Ces app config.

WhatsappConfig

Come Omnichannel deve ricevere/rispondere agli eventi da WhatsApp.

Campi
phone_number_id

string

L'ID numero di telefono associato all'account WhatsApp Business.
phone_number

string

Il numero di telefono utilizzato per inviare/ricevere messaggi.
whatsapp_business_account_id

string

L'ID account WhatsApp Business (WABA) del cliente.
webhook_verify_token

string

Il token di verifica configurato nella dashboard delle app Meta per la verifica webhook.
whatsapp_business_token

string

Il token di accesso per l'autenticazione delle chiamate API all'API WhatsApp Cloud. https://developers.facebook.com/docs/whatsapp/business-management-api/get-started/#business-integration-system-user-access-tokens
meta_business_portfolio_id

string

L'ID del portafoglio aziendale Meta (MBP). https://www.facebook.com/business/help/1710077379203657

OmnichannelOperationMetadata

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.

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 Open API. Questo campo viene impostato solo negli strumenti nelle dipendenze dell'ambiente durante il processo di esportazione se lo schema contiene un URL del server. Durante il processo di importazione, se questo URL è presente nelle dipendenze dell'ambiente e lo schema contiene il segnaposto $env_var, quest'ultimo verrà sostituito nello schema.

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 Open API. Questo campo viene impostato solo nei toolset nelle dipendenze dell'ambiente durante il processo di esportazione se lo schema contiene un URL del server. Durante il processo di importazione, se questo URL è presente nelle dipendenze dell'ambiente e lo schema contiene il segnaposto $env_var, quest'ultimo verrà sostituito nello schema.

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.

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.

PythonCodeCondition

Blocco di codice Python per valutare la condizione.

Campi
python_code

string

Obbligatorio. Il codice Python da eseguire.

PythonFunction

Uno strumento di funzioni Python.

Campi
name

string

Facoltativo. Il nome della funzione Python da eseguire. Deve corrispondere al nome di una funzione Python definita nel codice Python. Sensibile alle maiuscole. Se il nome non viene fornito, verrà utilizzata la prima funzione definita nel codice Python.
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.

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}

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 per cui è previsto lo schema. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool

ToolsetTool

Lo strumento del set di strumenti per cui è previsto lo schema.

RetrieveToolsRequest

Messaggio di richiesta per ToolService.RetrieveTools.

Campi
toolset

string

Obbligatorio. Il nome del set di strumenti da 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.

RetrieveToolsResponse

Messaggio di risposta per ToolService.RetrieveTools.

Campi
tools[]

Tool

L'elenco degli strumenti inclusi nel toolset specificato.

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.

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.

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 dall'agente di servizio.

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 esempio "America/Los_Angeles".
remote_dialogflow_query_parameters

SessionConfig.RemoteDialogflowQueryParameters

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

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

Struct

Facoltativo. Il payload da inviare in QueryParameters.
end_user_metadata

Struct

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 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 il valore è true, 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.

DiagnosticInfo

Contiene i dettagli di esecuzione durante l'elaborazione.

Campi
messages[]

Message

Elenco dei messaggi che si sono verificati 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 dell'intervallo.
end_time

Timestamp

Solo output. L'ora di fine dell'intervallo.
duration

Duration

Solo output. La durata dell'intervallo.
attributes

Struct

Solo output. Attributi chiave-valore associati allo span.
child_spans[]

Span

Solo output. Gli intervalli secondari nidificati in questo intervallo.

SynthesizeSpeechConfig

Configurazione della sintesi della risposta dell'agente.

Campi
voice

string

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

Per l'elenco delle voci disponibili, consulta Voci e lingue supportate di Cloud Text-to-Speech.
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 è il doppio della velocità, mentre 0.5 è la metà della velocità. I valori al di fuori dell'intervallo [0,25, 2,0] restituiranno un errore.

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.

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 attendibilità SSL predefinito. Se questo campo è vuoto o non specificato, CES utilizzerà l'archivio attendibilità predefinito di Google per verificare i certificati. Nota: assicurati che i certificati del server HTTPS siano firmati con "subject alt name". Ad esempio, un certificato può essere autofirmato utilizzando il seguente comando: openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

Strumento

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

Campi
name

string

Identificatore. L'identificatore univoco dello strumento. Formato: - projects/{project}/locations/{location}/apps/{app}/tools/{tool} per

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 possono essere referenziati 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.
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.
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.
widget_tool

WidgetTool

Facoltativo. Lo strumento widget.

ToolCall

Richiedi 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.
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 allo strumento reale.

ToolResponse

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

Campi
id

string

Facoltativo. L'ID corrispondente 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 le chiavi "output" ed "error" non sono specificate, l'intera "response" viene trattata come risultato dell'esecuzione dello strumento.
Campo unione tool_identifier. L'identificatore dello strumento eseguito. Può trattarsi di uno strumento persistente o di uno strumento di un insieme di strumenti. tool_identifier può essere solo uno dei seguenti tipi:
tool

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 set di strumenti. 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 set di strumenti.
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à simulata.
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 viene 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 dello 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 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. Rispondi 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 con cui l'agente deve rispondere.
disabled

bool

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

TransferAgent

L'agente trasferirà la conversazione a un altro agente.

Campi
agent

string

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

UpdateAgentRequest

Messaggio di richiesta per AgentService.UpdateAgent.

Campi
agent

Agent

Obbligatorio. L'agente da aggiornare.
update_mask

FieldMask

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

UpdateAppRequest

Messaggio di richiesta per AgentService.UpdateApp.

Campi
app

App

Obbligatorio. L'app da aggiornare.
update_mask

FieldMask

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

UpdateDeploymentRequest

Messaggio di richiesta per AgentService.UpdateDeployment.

Campi
deployment

Deployment

Obbligatorio. Il deployment da aggiornare.
update_mask

FieldMask

Facoltativo. L'elenco dei campi da aggiornare.

UpdateExampleRequest

Messaggio di richiesta per AgentService.UpdateExample.

Campi
example

Example

Obbligatorio. L'esempio da aggiornare.
update_mask

FieldMask

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

UpdateGuardrailRequest

Messaggio di richiesta per AgentService.UpdateGuardrail.

Campi
guardrail

Guardrail

Obbligatorio. Il guardrail da aggiornare.
update_mask

FieldMask

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

UpdateToolRequest

Messaggio di richiesta per AgentService.UpdateTool.

Campi
tool

Tool

Obbligatorio. Lo strumento da aggiornare.
update_mask

FieldMask

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

UpdateToolsetRequest

Messaggio di richiesta per AgentService.UpdateToolset.

Campi
toolset

Toolset

Obbligatorio. Il set di strumenti per l'aggiornamento.
update_mask

FieldMask

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

WebSearchQuery

Rappresenta una singola query di ricerca web e il relativo URI di ricerca.

Campi
query

string

Il testo della query di ricerca.
uri

string

L'URI alla pagina dei risultati di ricerca di Google per la query.

WidgetTool

Rappresenta uno strumento widget che l'agente può richiamare. Quando lo strumento viene scelto dall'agente, quest'ultimo restituisce il widget al cliente. Il client è responsabile dell'elaborazione del widget e della generazione della query utente successiva per continuare l'interazione con l'agente.

Campi
name

string

Obbligatorio. Il nome visualizzato dello strumento widget.
description

string

Facoltativo. La descrizione dello strumento widget.
widget_type

WidgetTool.WidgetType

Facoltativo. Il tipo di strumento widget. Se non specificato, il tipo predefinito sarà CUSTOMIZED.
Campo unione input. L'input dello strumento widget. input può essere solo uno dei seguenti tipi:
parameters

Schema

Facoltativo. I parametri di input dello strumento widget.

WidgetType

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

Enum
WIDGET_TYPE_UNSPECIFIED Tipo di widget non specificato.
CUSTOM Tipo di widget personalizzato.
PRODUCT_DETAILS Widget Dettagli prodotto.
QUICK_ACTIONS Widget Azioni rapide.
PRODUCT_COMPARISON Widget di confronto tra prodotti.
ADVANCED_PRODUCT_DETAILS Widget Dettagli del prodotto avanzati.
SHORT_FORM Widget modulo breve.
OVERALL_SATISFACTION Widget di soddisfazione generale.
ORDER_SUMMARY Widget Riepilogo ordine.
APPOINTMENT_DETAILS Widget dei dettagli dell'appuntamento.
APPOINTMENT_SCHEDULER Widget per la programmazione degli appuntamenti.
CONTACT_FORM Widget modulo di contatto.