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

Suspende um agente. Ele ainda está disponível para visualização, mas não para uso. O state do agente se torna SUSPENDED. Pode ser chamado em um agente no estado ENABLED. Caso contrário, retorna um erro.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome do agente a ser suspenso. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}

Parâmetros de consulta

Parâmetros
suspensionReason

string

Obrigatório. O motivo da suspensão do agente. Isso vai aparecer para os usuários do agente.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Agent.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.