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

Suspende un agente. Sigue estando disponible para verla, pero no para usarla. El state del agente pasa a ser SUSPENDED. Se puede llamar en un agente en el estado ENABLED. De lo contrario, devuelve un error.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
name

string

Obligatorio. Nombre del agente que se va a suspender. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}

Los parámetros de consulta

Parámetros
suspensionReason

string

Obligatorio. El motivo de la suspensión del agente. Se mostrará a los usuarios del agente.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si la solicitud se hace correctamente, en el cuerpo de la respuesta se incluye una instancia de Agent.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el Authentication Overview.