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

一般公開されている Agent を拒否します。Agent の state が PRIVATE になります。状態が DISABLED の Agent に対して呼び出すことができます。それ以外の場合はエラーが返されます。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
name

string

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

クエリ パラメータ

パラメータ
rejectionReason

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 をご覧ください。