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

Suspende un agente. Aún está disponible para su visualización, pero no para su uso. El state del agente se convierte en SUSPENDED. Se puede llamar a 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 usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
name

string

Obligatorio. Es el nombre del agente que se suspenderá. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}

Parámetros de consulta

Parámetros
suspensionReason

string

Obligatorio. Es el motivo por el que se suspendió el 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 se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Agent.

Alcances de autorización

Se necesita 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 Authentication Overview.