Method: corpora.documents.patch

Document を更新します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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

詳細については、認証の概要をご覧ください。