Method: projects.locations.collections.engines.agents.patch

Agent を更新します

HTTP リクエスト

PATCH https://discoveryengine.googleapis.com/v1alpha/{agent.name=projects/*/locations/*/collections/*/engines/*/agents/*}

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

パスパラメータ

パラメータ
agent.name

string

ID。エージェントのリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent} または projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/agents/{agent}

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

省略可。更新するフィールドのリスト。

完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo"。

リクエストの本文

リクエストの本文には 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 をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • discoveryengine.agents.update

詳細については、IAM のドキュメントをご覧ください。