REST Resource: projects.locations.collections.engines.assistants.agents

Risorsa: Agente

Svolge un'attività specifica predefinita.

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "icon": {
    object (Image)
  },
  "createTime": string,
  "updateTime": string,
  "authorizations": [
    string
  ],
  "authorizationConfig": {
    object (AuthorizationConfig)
  },
  "dataStoreSpecs": {
    object (DataStoreSpecs)
  },
  "state": enum (State),
  "toolSettings": {
    object (AgentToolSettings)
  },
  "agentInvocationSpec": {
    object (AgentInvocationSpec)
  },
  "languageCode": string,
  "starterPrompts": [
    {
      object (StarterPrompt)
    }
  ],
  "customPlaceholderText": string,
  "sharingConfig": {
    object (SharingConfig)
  },

  // Union field definition can be only one of the following:
  "adkAgentDefinition": {
    object (AdkAgentDefinition)
  },
  "managedAgentDefinition": {
    object (ManagedAgentDefinition)
  },
  "a2aAgentDefinition": {
    object (A2AAgentDefinition)
  },
  "dialogflowAgentDefinition": {
    object (DialogflowAgentDefinition)
  }
  // End of list of possible types for union field definition.

  // Union field agent_state_reason can be only one of the following:
  "suspensionReason": string,
  "rejectionReason": string,
  "deploymentFailureReason": string
  // End of list of possible types for union field agent_state_reason.
}
Campi
name

string

Identificatore. Nome della risorsa dell'agente. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}
displayName

string

Obbligatorio. Il nome visualizzato dell'agente. Potrebbe essere utilizzato da un LLM per selezionare automaticamente un agente a cui rispondere a una query dell'utente.
description

string

Obbligatorio. Descrizione dell'agente leggibile. Potrebbe essere utilizzato da un LLM per selezionare automaticamente un agente a cui rispondere a una query dell'utente.
icon

object (Image)

Facoltativo. L'icona che rappresenta l'agente nell'interfaccia utente.
createTime

string (Timestamp format)

Solo output. Timestamp di creazione di questo agente.

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

string (Timestamp format)

Solo output. Timestamp dell'ultimo aggiornamento di questo agente.

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

string

Facoltativo. Deprecato: utilizza Agent.authorization_config. Elenco delle autorizzazioni richieste per questo agente.
authorizationConfig

object (AuthorizationConfig)

Facoltativo. Le autorizzazioni richieste dall'agente.
dataStoreSpecs

object (DataStoreSpecs)

Facoltativo. DataStoreSpecs associati all'agente. Se non imposti questo campo, verranno utilizzati tutti i datastore nel motore.
state

enum (State)

Solo output. Lo stato del ciclo di vita dell'agente.
toolSettings
(deprecated)

object (AgentToolSettings)

Facoltativo. DEPRECATO: utilizza invece agentInvocationSpec.
agentInvocationSpec

object (AgentInvocationSpec)

Facoltativo. La specifica di invocazione dell'agente, utilizzata dal modello LLM per decidere quando utilizzarlo.
languageCode

string

Facoltativo. Il codice della lingua del testo nei campi description, displayName e starterPrompts.
starterPrompts[]

object (StarterPrompt)

Facoltativo. I suggerimenti per i prompt iniziali da mostrare all'utente nella pagina di destinazione dell'agente.
customPlaceholderText

string

Facoltativo. Il testo segnaposto personalizzato che viene visualizzato nella casella di testo prima che l'utente inserisca un testo.
sharingConfig

object (SharingConfig)

Facoltativo. La configurazione di condivisione dell'agente.
Campo unione definition. La definizione dell'agente. LINT.IfChange(definition) definition può essere solo uno dei seguenti valori:
adkAgentDefinition

object (AdkAgentDefinition)

Facoltativo. Il comportamento dell'agente è definito come agente ADK.
managedAgentDefinition

object (ManagedAgentDefinition)

Facoltativo. Il comportamento dell'agente gestito da Google.
a2aAgentDefinition

object (A2AAgentDefinition)

Facoltativo. Il comportamento dell'agente è definito come agente A2A.
dialogflowAgentDefinition

object (DialogflowAgentDefinition)

Facoltativo. Il comportamento dell'agente è definito come agente Dialogflow.
Campo unione agent_state_reason. Il motivo per cui l'agente si trova nel suo stato attuale. agent_state_reason può essere solo uno dei seguenti tipi:
suspensionReason

string

Solo output. Il motivo per cui l'agente è stato sospeso. Imposta solo se lo stato è SUSPENDED.
rejectionReason

string

Solo output. Il motivo per cui l'agente è stato rifiutato. Impostato solo se lo stato è PRIVATE e si è arrivati a questo stato tramite rifiuto.
deploymentFailureReason

string

Solo output. Il motivo per cui il deployment dell'agente non è riuscito. Impostato solo se lo stato è DEPLOYMENT_FAILED.

AdkAgentDefinition

Memorizza la definizione di un agente che utilizza l'ADK e viene implementato in Agent Engine (precedentemente noto come Reasoning Engine).

Rappresentazione JSON 
{
  "toolSettings": {
    object (AgentToolSettings)
  },
  "provisionedReasoningEngine": {
    object (ProvisionedReasoningEngine)
  },
  "authorizations": [
    string
  ]
}
Campi
toolSettings
(deprecated)

object (AgentToolSettings)

Facoltativo. I parametri che definiscono il modo in cui l'agente viene presentato al modello LLM del pianificatore. DEPRECATO: utilizza Agent.agent_invocation_spec.
provisionedReasoningEngine

object (ProvisionedReasoningEngine)

Facoltativo. Il motore di ragionamento a cui è connesso l'agente.
authorizations[]
(deprecated)

string

Facoltativo. DEPRECATO: utilizza Agent.authorizations. Nomi delle risorse delle autorizzazioni richieste. Se l'utente non è autorizzato, il servizio restituirà una serie di URI di autorizzazione che l'utente deve aprire in un browser e autorizzare. Una volta concesse tutte le autorizzazioni, l'utente può riprovare la query e le autorizzazioni verranno inoltrate all'agente.

Formato: projects/{project}/locations/{location}/authorizations/{authorization}

AgentToolSettings

DEPRECATO: utilizza AgentInvocationSpec. Impostazioni dello strumento che rappresenta l'agente per il LLM del pianificatore di Agentspace.

Rappresentazione JSON 
{
  "toolDescription": string,
  "inputParameterName": string,
  "inputParameterDescription": string
}
Campi
toolDescription

string

Obbligatorio. Questo valore potrebbe essere utilizzato da un LLM per descrivere quando deve essere utilizzato l'agente.
inputParameterName

string

Facoltativo. Nome del parametro per la chiamata di funzione. Questo nome del parametro fornirà un suggerimento al modello LLM sul tipo di contenuti che il parametro dovrebbe contenere, ad esempio una "domanda", un "comando", una "query di ricerca" e così via.
inputParameterDescription

string

Facoltativo. Descrizione del parametro per la chiamata di funzione. Questa descrizione fornirà all'LLM maggiori informazioni sul parametro, ovvero quale tipo di contenuto ci si aspetta che venga trasmesso e quali azioni devono essere eseguite.

ProvisionedReasoningEngine

Tiene traccia del motore di ragionamento a cui è connesso l'agente. Questo messaggio non ha lo scopo di tenere traccia del ciclo di vita dell'agente. Viene invece utilizzato solo per definire i parametri per connettersi all'agente già implementato in un motore di ragionamento.

Rappresentazione JSON 
{
  "reasoningEngine": string
}
Campi
reasoningEngine

string

Obbligatorio. Il motore di ragionamento a cui è connesso l'agente. Formato: projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}

ManagedAgentDefinition

Memorizza la definizione di un agente gestito da Google.

Rappresentazione JSON 
{
  "toolSettings": {
    object (AgentToolSettings)
  },
  "authorizations": [
    string
  ],
  "deploymentInfo": {
    object (DeploymentInfo)
  },

  // Union field agent_config can be only one of the following:
  "dataScienceAgentConfig": {
    object (DataScienceAgentConfig)
  }
  // End of list of possible types for union field agent_config.
}
Campi
toolSettings
(deprecated)

object (AgentToolSettings)

Facoltativo. I parametri che definiscono il modo in cui l'agente viene presentato al modello LLM del pianificatore. DEPRECATO: utilizza Agent.agent_invocation_spec.
authorizations[]
(deprecated)

string

Facoltativo. DEPRECATO: utilizza Agent.authorizations. Nomi delle risorse delle autorizzazioni richieste. Se l'utente non è autorizzato, il servizio restituirà una serie di URI di autorizzazione che l'utente deve aprire in un browser e autorizzare. Una volta concesse tutte le autorizzazioni, l'utente può riprovare la query e le autorizzazioni verranno inoltrate all'agente.

Formato: projects/{project}/locations/{location}/authorizations/{authorization}
deploymentInfo

object (DeploymentInfo)

Solo output. Informazioni sul deployment automatico dell'agente.
Campo unione agent_config. Configurazione specifica del tipo di agente. agent_config può essere solo uno dei seguenti tipi:
dataScienceAgentConfig

object (DataScienceAgentConfig)

Facoltativo. Configurazione specifica per gli agenti di data science predefiniti di Google. Questa struttura di dati è pensata per archiviare la configurazione dell'ora di deployment e di richiesta per l'agente.

DataScienceAgentConfig

Configurazione specifica per gli agenti di data science predefiniti di Google. Questa struttura di dati è pensata per archiviare la configurazione dell'ora di deployment e di richiesta per l'agente.

Rappresentazione JSON 
{
  "bqProjectId": string,
  "bqDatasetId": string,
  "blocklistTables": [
    string
  ],
  "allowlistTables": [
    string
  ],
  "nlQueryConfig": {
    object (NlQueryConfig)
  }
}
Campi
bqProjectId

string

Obbligatorio. L'ID progetto BigQuery in cui si trova il set di dati.
bqDatasetId

string

Obbligatorio. L'ID set di dati BigQuery da utilizzare per l'agente. Il set di dati deve trovarsi nel progetto specificato da bqProjectId.
blocklistTables[]

string

Facoltativo. Le tabelle BigQuery da bloccare per impedire che vengano utilizzate dall'agente.
allowlistTables[]

string

Facoltativo. Le tabelle BigQuery da consentire all'agente.
nlQueryConfig

object (NlQueryConfig)

Facoltativo. Configurazione fornita dal cliente.

NlQueryConfig

Definisci le configurazioni fornite dal cliente specifiche per la traduzione dal linguaggio naturale al codice SQL/Python.

Rappresentazione JSON 
{
  "nl2sqlPrompt": string,
  "nl2pyPrompt": string,
  "nl2sqlExamples": [
    {
      object (Nl2SqlExample)
    }
  ],
  "schemaDescription": string,
  "bqSqlGenUseCustomPrompt": boolean
}
Campi
nl2sqlPrompt

string

Facoltativo. Il cliente ha fornito istruzioni NL2SQL
nl2pyPrompt

string

Facoltativo. Il cliente ha fornito istruzioni all'LLM per scrivere codice Python per l'analisi dei dati.
nl2sqlExamples[]

object (Nl2SqlExample)

Facoltativo. Il cliente ha fornito esempi di NL2SQL, inclusi sia l'input che l'SQL previsto.
schemaDescription

string

Facoltativo. La descrizione in linguaggio naturale dello schema del set di dati BigQuery.
bqSqlGenUseCustomPrompt

boolean

Facoltativo. Indica se utilizzare il prompt personalizzato per il servizio BigQuery SQL Gen.

Nl2SqlExample

Un singolo esempio di NL2SQL.

Rappresentazione JSON 
{
  "query": string,
  "expectedSql": string,
  "expectedResponse": string
}
Campi
query

string

Facoltativo. La query in linguaggio naturale a cui rispondere.
expectedSql

string

Facoltativo. L'output SQL previsto.
expectedResponse

string

Facoltativo. La risposta prevista alla query.

DeploymentInfo

Informazioni sul deployment automatico dell'agente.

Rappresentazione JSON 
{
  "operation": string,
  "finishTime": string
}
Campi
operation

string

Solo output. Risorsa dell'operazione a lunga esecuzione per il deployment. Può essere utilizzato per eseguire il polling dello stato del deployment. Al termine del deployment, questo campo sarà vuoto. Se il deployment non va a buon fine,il campo conterrà il nome della risorsa dell'operazione di lunga durata non riuscita, ma la risorsa dell'operazione stessa verrà eliminata automaticamente dopo un po' di tempo.
finishTime

string (Timestamp format)

Solo output. Ora di fine del deployment: impostata solo se il deployment è stato completato o non è riuscito.

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

A2AAgentDefinition

Definizione archiviata di un agente che utilizza A2A.

Rappresentazione JSON 
{
  "cloudMarketplaceConfig": {
    object (CloudMarketplaceConfig)
  },

  // Union field agent_card can be only one of the following:
  "jsonAgentCard": string,
  "remoteAgentCard": {
    object (RemoteAgentcard)
  }
  // End of list of possible types for union field agent_card.
}
Campi
cloudMarketplaceConfig

object (CloudMarketplaceConfig)

Facoltativo. Configurazione specifica per gli agenti di cui viene eseguito il deployment da Cloud Marketplace.
Campo unione agent_card. Il nome, le funzionalità, i dati di autenticazione e così via dell'agente dello store agent_card possono essere solo uno dei seguenti:
jsonAgentCard

string

Facoltativo. La scheda dell'agente è una stringa JSON.
remoteAgentCard

object (RemoteAgentcard)

Facoltativo. Una tessera di agente remoto (terze parti).

RemoteAgentcard

Definizione di una scheda dell'agente ospitata in remoto.

Rappresentazione JSON 
{
  "uri": string
}
Campi
uri

string

Obbligatorio. L'URI della scheda dell'agente.

CloudMarketplaceConfig

Configurazione specifica per gli agenti di cui viene eseguito il deployment da Cloud Marketplace.

Rappresentazione JSON 
{
  "entitlement": string,
  "order": string
}
Campi
entitlement

string

Obbligatorio. Il diritto del marketplace a cui è associato questo agente. Formato: projects/{project}/entitlements/{entitlement}.
order

string

Solo output. L'ordine del marketplace a cui appartiene questo agente. Formato: billingAccounts/{billingAccount}/orders/{order}

DialogflowAgentDefinition

Definizione archiviata di un agente che utilizza un agente Dialogflow.

Rappresentazione JSON 
{
  "toolSettings": {
    object (AgentToolSettings)
  },
  "dialogflowAgent": string
}
Campi
toolSettings
(deprecated)

object (AgentToolSettings)

Facoltativo. I parametri che definiscono il modo in cui l'agente viene presentato al modello LLM del pianificatore. DEPRECATO: utilizza agentInvocationSpec.
dialogflowAgent

string

Obbligatorio. Nome risorsa dell'agente Dialogflow sottostante. Formato: projects/{project}/locations/{location}/agents/{agent}

Immagine

Rappresenta un'immagine.

Rappresentazione JSON 
{

  // Union field storage_method can be only one of the following:
  "uri": string,
  "content": string
  // End of list of possible types for union field storage_method.
}
Campi
Campo unione storage_method. Può essere un URI o i contenuti codificati come stringa Base64. storage_method può essere solo uno dei seguenti tipi:
uri

string

URI immagine.
content

string

Contenuti del file immagine con codifica Base64.

AuthorizationConfig

Descrive le autorizzazioni richieste.

Rappresentazione JSON 
{
  "toolAuthorizations": [
    string
  ],
  "agentAuthorization": string
}
Campi
toolAuthorizations[]

string

Facoltativo. Elenco delle autorizzazioni richieste per consentire all'agente di accedere ad altre risorse. I token di autenticazione verranno trasmessi all'agente come parte del corpo della richiesta.
agentAuthorization

string

Facoltativo. L'autorizzazione necessaria per richiamare l'agente. I token di autenticazione verranno passati all'agente come parte dell'intestazione di autenticazione della richiesta.

DataStoreSpecs

Rappresenta un insieme di specifiche del datastore.

Rappresentazione JSON 
{
  "specs": [
    {
      object (DataStoreSpec)
    }
  ]
}
Campi
specs[]

object (DataStoreSpec)

Facoltativo. Specifiche che definiscono i DataStore su cui filtrare in una chiamata di ricerca e le configurazioni per questi datastore. Questo aspetto viene preso in considerazione solo per i Engine con più datastore.

Stato

Valori possibili per lo stato del ciclo di vita dell'agente.

Enum
STATE_UNSPECIFIED Lo stato non è specificato.
CONFIGURED L'agente è configurato, ma non è ancora stato attivato alcun deployment.
DEPLOYING È in corso il deployment dell'agente.
DISABLED L'agente è disponibile solo per gli amministratori.
DEPLOYMENT_FAILED Il deployment dell'agente non è riuscito.
PRIVATE L'agente è disponibile solo per il suo creatore.
ENABLED L'agente è disponibile per gli utenti che hanno accesso.
SUSPENDED L'agente non è temporaneamente disponibile, ma è visibile agli utenti che hanno accesso.

AgentInvocationSpec

Specifica di chiamata per l'agente, utilizzata dal modello LLM per decidere quando chiamare l'agente.

Rappresentazione JSON 
{
  "description": string
}
Campi
description

string

Obbligatorio. Descrizione che guida l'LLM su quando richiamare l'agente. Una buona descrizione spiega in modo chiaro e conciso le funzionalità dell'agente, ad esempio: "Questo agente può prenotare voli e controllare lo stato dei voli".

StarterPrompt

Il suggerimento di prompt iniziale da mostrare all'utente nella pagina di destinazione dell'agente.

Rappresentazione JSON 
{
  "text": string
}
Campi
text

string

Obbligatorio. Il testo del prompt iniziale.

SharingConfig

Configurazione relativa alla condivisione.

Rappresentazione JSON 
{
  "scope": enum (Scope)
}
Campi
scope

enum (Scope)

Facoltativo. L'ambito di condivisione dell'agente.

Ambito

L'ambito di condivisione dell'agente.

Enum
SCOPE_UNSPECIFIED Valore predefinito. Si comporta come RESTRICTED.
RESTRICTED L'agente viene condiviso in base al criterio IAM.
ALL_USERS L'agente è condiviso con tutti gli utenti.

Metodi

create

 Crea un Agent.

delete

 Elimina un Agent.

deploy

 Esegue il deployment di un Agent.

get

 Riceve un Agent.

list

 Elenca tutti i Agent in un Assistant creati dal chiamante.

patch

 Aggiorna un Agent

rejectAgent

 Rifiuta un agente offerto al pubblico.

requestAgentReview

 Presenta un agente agli amministratori rendendolo disponibile per la revisione.

withdrawAgent

 Ritira un agente offerto al pubblico.