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

Agent を一時停止します。閲覧はできますが、使用はできません。Agent の state が SUSPENDED になります。ENABLED という状態の Agent で呼び出すことができます。それ以外の場合はエラーが返されます。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。一時停止する Agent の名前。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}

クエリ パラメータ

パラメータ
suspensionReason

string

必須。Agent を一時停止する理由。これは 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 をご覧ください。