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

Suspend un agent. Vous pouvez toujours le consulter, mais pas l'utiliser. Le state de l'agent devient SUSPENDED. Peut être appelé sur un agent à l'état ENABLED, sinon il renvoie une erreur.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom de l'agent à suspendre. Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}

Paramètres de requête

Paramètres
suspensionReason

string

Obligatoire. Raison de la suspension de l'agent. Les utilisateurs de l'agent verront cette description.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Agent.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.