Method: projects.locations.dataStores.purgeDocuments

啟動長時間執行的作業，從資料儲存庫清除文件。

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

HTTP 要求

POST https://vectorsearch.googleapis.com/v1beta/{name}:purgeDocuments

路徑參數

參數
name

string

這是必要旗標，要清除文件的 DataStore 資源名稱。格式：projects/{project}/locations/{location}/dataStores/{dataStore}。

要求主體

要求主體包含下列結構的資料：

JSON 表示法 
{
  "purgeOutputConfig": {
    object (PurgeOutputConfig)
  },
  "force": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsSource": {
    object (GcsSource)
  }
  // End of mutually exclusive fields.
}
欄位
purgeOutputConfig

object (PurgeOutputConfig)

選用。清除文件輸出目的地的設定。
force

boolean

選用。實際執行清除作業。如果 force 設為 false，則會傳回預估的清除次數，但不會刪除任何文件。
要清除的文件，以文件 ID 指定。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位：
gcsSource

object (GcsSource)

Cloud Storage 檔案，列出要清除的文件，每行一個文件 ID。每行只包含 ID，不含完整資源名稱。每個 URI 都必須命名單一檔案：不支援模式和資料夾。

如果某行不是有效的文件 ID，系統會回報錯誤，且不含有效 ID 的檔案無法清除。系統會略過未命名任何文件的 ID，並計入作業中繼資料的 ignoredCount。每個檔案最多可列出 100,000 個 ID。
互斥欄位結束。

回應主體

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

授權範圍

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

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

詳情請參閱Authentication Overview。

PurgeOutputConfig

清除相關輸出的目的地設定。

JSON 表示法 
{
  "errorGcsPrefix": string
}
欄位
errorGcsPrefix

string

選用。清除錯誤的 Cloud Storage 前置字串。前置字串不得包含任何物件。清除錯誤會寫入這個前置字元下的 shard 檔案，每行一個，並以 JSON 編碼的 google.rpc.Status 訊息形式呈現。