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

暫停代理程式。你仍可查看，但無法使用。Agent 的 state會變成 SUSPENDED。可以在 ENABLED 狀態的代理程式上呼叫，否則會傳回錯誤。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
name

string

這是必要旗標，要暫停的代理程式名稱。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}

查詢參數

參數
suspensionReason

string

這是必要旗標，暫停服務專員的原因。這項資訊會向 Agent 使用者顯示。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體會包含 Agent 的執行個體。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱Authentication Overview。