Method: corpora.documents.patch

Memperbarui Document.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
document.name

string

Tidak dapat diubah. ID. Nama resource Document. ID (nama tidak termasuk awalan "corpora/*/documents/") dapat berisi hingga 40 karakter yang merupakan alfanumerik huruf kecil atau tanda hubung (-). ID tidak dapat diawali atau diakhiri dengan tanda hubung. Jika nama saat pembuatan kosong, nama unik akan diambil dari displayName beserta akhiran acak 12 karakter. Contoh: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

Parameter kueri

Parameter
updateMask

string (FieldMask format)

Wajib. Daftar kolom yang akan diperbarui. Saat ini, fitur ini hanya mendukung update displayName dan customMetadata.

Ini adalah daftar yang dipisahkan koma yang berisi nama-nama kolom yang sepenuhnya memenuhi syarat. Contoh: "user.displayName,photo".

Isi permintaan

Isi permintaan memuat instance Document.

Isi respons

Jika berhasil, isi respons akan berisi instance Document.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.