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

暂停代理。您仍然可以查看，但无法使用。代理的 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 实例。

授权范围

需要以下 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。