Method: projects.locations.collections.patch

更新單一集合的參數。

HTTP 要求

PATCH https://vectorsearch.googleapis.com/v1beta/{collection.name}

路徑參數

參數
collection.name

string

ID。資源名稱

查詢參數

參數
updateMask

string (FieldMask format)

選用。欄位遮罩用於指定要透過更新作業覆寫的 Collection 資源欄位。updateMask 中指定的欄位與資源相關,而非完整要求。如果欄位位於遮罩中,系統會覆寫該欄位。如果使用者未提供遮罩,系統會覆寫要求中的所有欄位。

以下欄位支援更新:displayNamedescriptionlabelsdataSchemavectorSchema。如果是 dataSchemavectorSchema,只能新增欄位,無法刪除,但 vectorSchema 中的 vertexEmbeddingConfig 可以新增或移除。dataSchemavectorSchema 的部分更新也支援在 updateMask 中使用子欄位路徑,例如 dataSchema.properties.foovectorSchema.my_vector_field

如果 updateMask 中提供 *,系統會執行完整取代作業。

這是以半形逗號分隔的完整欄位名稱清單,範例:"user.displayName,photo"

requestId

string

選用。(選用) 用於識別要求的 ID。指定專屬要求 ID,這樣一來,如果必須重試要求,伺服器就會知道要忽略已完成的要求。伺服器會保證至少在第一次要求後的 60 分鐘內,

舉例來說,假設您提出初始要求,但要求逾時。如果使用相同要求 ID 再次提出要求,伺服器可以檢查是否已收到具有相同要求 ID 的原始作業,如果已收到,就會忽略第二次要求。避免客戶不慎建立重複的約期。

要求 ID 必須是有效的 UUID,但系統不支援零 UUID (00000000-0000-0000-0000-000000000000)。

要求主體

要求主體包含 Collection 的執行個體。

回應主體

如果成功,回應主體會包含 Operation 的執行個體。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/cloud-platform

詳情請參閱Authentication Overview

IAM 權限

需要 name 資源的下列 IAM 權限:

  • vectorsearch.collections.update

詳情請參閱 IAM 說明文件