Method: corpora.documents.patch

更新 Document。

HTTP 要求

PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

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

路徑參數

參數
document.name

string

無法變更。ID。Document 資源名稱。ID (名稱不含「corpora/*/documents/」前置字元) 最多可以包含 40 個字元，且只能使用小寫英數字元或破折號 (-)，且 ID 的開頭或結尾不得為破折號。如果建立時名稱空白，系統就會從 displayName 衍生不重複名稱，以及 12 個半形字元的隨機後置字串。範例：corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

查詢參數

參數
updateMask

string (FieldMask format)

必要欄位。要更新的欄位清單。目前，這個做法僅支援更新 displayName 和 customMetadata。

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

要求主體

要求主體包含 Document 的例項。

回應主體

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

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/generative-language.retriever

詳情請參閱驗證總覽。