Method: projects.locations.collections.engines.assistants.agents.suspendAgent

Sospende un agente. È ancora disponibile per la visualizzazione, ma non per l'utilizzo. Il state dell'agente diventa SUSPENDED. Può essere chiamato su un agente nello stato ENABLED, altrimenti restituisce un errore.

Richiesta HTTP

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}:suspendAgent

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Obbligatorio. Il nome dell'agente da sospendere. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}

Parametri di query

Parametri
suspensionReason

string

Obbligatorio. Il motivo della sospensione dell'agente. Verrà mostrato agli utenti dell'agente.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Agent.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

Per ulteriori informazioni, consulta Authentication Overview.