Method: projects.locations.collections.engines.assistants.cannedQueries.patch

CannedQuery を更新します。

HTTP リクエスト

PATCH https://discoveryengine.googleapis.com/v1alpha/{cannedQuery.name=projects/*/locations/*/collections/*/engines/*/assistants/*/cannedQueries/*}

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

パスパラメータ

パラメータ
cannedQuery.name

string

変更不可。事前定義されたクエリのリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{cannedQuery}

長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

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

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

リクエストの本文

リクエストの本文には CannedQuery のインスタンスが含まれます。

レスポンスの本文

成功した場合、レスポンスの本文には CannedQuery のインスタンスが含まれます。

認可スコープ

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