Method: projects.locations.dataStores.branches.documents.patch

• HTTP 要求
• 路徑參數
• 查詢參數
• 要求主體
• 回應主體
• 授權範圍
• IAM 權限

更新 Document。

HTTP 要求

PATCH https://discoveryengine.googleapis.com/v1alpha/{document.name=projects/*/locations/*/dataStores/*/branches/*/documents/*}

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

路徑參數

參數
document.name	string 不可變動。文件的完整資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}。 這個欄位必須是 UTF-8 編碼的字串，長度上限為 1024 個字元。

查詢參數

參數
allowMissing	boolean 如果設為 true，且系統找不到 Document，就會建立新的 Document。
updateMask	string (FieldMask format) 指出要更新所匯入「文件」的哪些欄位。如未設定，預設會更新所有欄位。 這是以半形逗號分隔的完整欄位名稱清單。範例："user.displayName,photo"。

要求主體

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

回應主體

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

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

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

• discoveryengine.documents.update

詳情請參閱 IAM 說明文件。