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)
  },
  "languageCode": string,
  "starterPrompts": [
    {
      object (StarterPrompt)
    }
  ],
  "customPlaceholderText": string,

  // 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} o projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/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 normalizzato in base al fuso orario UTC 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 normalizzato in base al fuso orario UTC 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: migrazione pianificata alla definizione di AgentCard.
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.
Campo unione definition. La definizione dell'agente. LINT.IfChange(definition) definition può essere solo uno dei seguenti:
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:
suspensionReason

string

Solo output. Il motivo per cui l'agente è stato sospeso. Impostato 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.

Metodi

create

 Crea un Agent.

delete

 Elimina un Agent.

deploy

 Esegue il deployment di un Agent.

disableAgent

 Disabilita un agente.

enableAgent

 Abilita un agente.

get

 Riceve un Agent.

getAgentView

 Restituisce un AgentView per un determinato Agent, che contiene informazioni aggiuntive sull'agente.

getIamPolicy

 Recupera il criterio di controllo dell'accesso per una risorsa agente.

list

 Elenca tutti i Agent sotto 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.

setIamPolicy

 Imposta il criterio di controllo dell'accesso per una risorsa agente.

suspendAgent

 Sospende un agente.

withdrawAgent

 Ritira un agente offerto al pubblico.