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

Memperbarui Document.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
document.name

string

Tidak dapat diubah. Nama lengkap resource dokumen. Format projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}.

Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter.

Parameter kueri

Parameter
allowMissing

boolean

Jika disetel ke true dan Document tidak ditemukan, Document baru akan dibuat.

updateMask

string (FieldMask format)

Menunjukkan kolom mana dalam 'dokumen' yang diimpor yang akan diperbarui. Jika tidak disetel, secara default akan memperbarui semua kolom.

Ini adalah comma-separated list berisi 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 salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource name:

  • discoveryengine.documents.update

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.