Method: projects.locations.corpora.indexes.patch

更新該語料庫下的索引。使用者可以執行僅限中繼資料的更新,或使用不同的 updateMask 值觸發完整索引重建作業。

HTTP 要求

PATCH https://visionai.googleapis.com/v1/{index.name=projects/*/locations/*/corpora/*/indexes/*}

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
index.name

string

僅供輸出。索引資源的資源名稱。格式:projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/indexes/{indexId}

查詢參數

參數
updateMask

string (FieldMask format)

這是必要旗標,欄位遮罩用於指定更新時會在索引資源中覆寫的欄位。updateMask 中指定的欄位是相對於資源,而非完整要求。如果資源的欄位位於遮罩中,就會遭到覆寫。欄位遮罩不得留空。如果遮罩為「*」,系統會觸發索引的完整更新作業,並重新建構整個索引資料。

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

要求主體

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

回應主體

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

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱驗證總覽一文。

IAM 權限

需要在 name 資源上具備下列 IAM 權限:

  • visionai.indexes.update

詳情請參閱 身分與存取權管理說明文件