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

Sperrt einen Agent. Sie ist weiterhin verfügbar, kann aber nicht verwendet werden. Die state des Agents wird zu SUSPENDED. Kann für einen Agenten im Status ENABLED aufgerufen werden. Andernfalls wird ein Fehler zurückgegeben.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Der Name des Agents, der gesperrt werden soll. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}

Suchparameter

Parameter
suspensionReason

string

Erforderlich. Der Grund für die Sperrung des KI‑Agenten. Diese Informationen werden den Nutzern des KI‑Agenten angezeigt.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Agent.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.