Method: projects.locations.dataStores.patch

更新單一資料儲存庫的參數。

dataStores.patch、dataStores.importDocuments 和 dataStores.purgeDocuments 每次只會對一個 DataStore 執行。一項作業執行時，另一項作業可以等待；在執行中的作業完成前，任何其他要求都會失敗，並傳回 ABORTED。

HTTP 要求

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

路徑參數

參數
dataStore.name

string

ID。DataStore 的完整資源名稱。

格式：projects/{project}/locations/{location}/dataStores/{dataStoreId}

查詢參數

參數
updateMask

string (FieldMask format)

選用。欄位遮罩用於指定 DataStore 資源中要由更新覆寫的欄位。updateMask 中指定的欄位與資源相關，而非完整要求。如果欄位在遮罩中，系統會覆寫該欄位。如果路徑指定訊息名稱，則會取代整則訊息：要求中省略的子欄位會清除，並在 processingConfig 下重設為預設值。

如果使用者未提供遮罩，系統會覆寫要求設為非預設值的每個欄位。系統不會套用空白訊息 (例如 layoutParsingConfig: {}) 和設為預設值的欄位 (例如 false)，請改為在遮罩中命名。

以下欄位支援更新：displayName、description、labels、processingConfig 和 documentMetadataSchema。documentMetadataSchema 必須整體更新 (遮罩路徑為 documentMetadataSchema)，且只能新增屬性，無法移除或變更現有屬性。

如果在 updateMask 中提供 *，系統會執行完整替換作業。

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

string

選用。選用的要求 ID，用於識別要求。請指定專屬要求 ID，這樣一來，如果您必須重試要求，伺服器就會知道要忽略已完成的要求。伺服器會保證從第一次要求起至少 60 分鐘內有效。

舉例來說，假設您提出初始要求，但要求逾時。如果您使用相同的要求 ID 再次提出要求，伺服器會檢查是否已收到具有相同要求 ID 的原始作業，如果是，則會忽略第二個要求。避免用戶端不小心建立重複的承諾使用合約。

要求 ID 必須是有效的 UUID，但不得為零 UUID (00000000-0000-0000-0000-000000000000)。

要求主體

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

回應主體

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

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱Authentication Overview。