Method: projects.locations.collections.dataStores.branches.documents.purge

Menghapus semua Document yang dipilih secara permanen di cabang.

Proses ini bersifat asinkron. Bergantung pada jumlah Document yang akan dihapus, operasi ini dapat memerlukan waktu berjam-jam untuk diselesaikan. Sebelum operasi penghapusan selesai, beberapa Document mungkin masih ditampilkan oleh DocumentService.GetDocument atau DocumentService.ListDocuments.

Untuk mendapatkan daftar Document yang akan dihapus, setel PurgeDocumentsRequest.force ke false.

Permintaan HTTP

POST https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents:purge

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama resource induk, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "filter": string,
  "errorConfig": {
    object (PurgeErrorConfig)
  },
  "force": boolean,

  // Union field source can be only one of the following:
  "gcsSource": {
    object (GcsSource)
  },
  "inlineSource": {
    object (InlineSource)
  }
  // End of list of possible types for union field source.
}
Kolom
filter

string

Wajib. Memfilter dokumen yang cocok untuk dihapus. Satu-satunya nilai yang saat ini didukung adalah * (semua item).
errorConfig

object (PurgeErrorConfig)

Lokasi yang diinginkan untuk error yang terjadi selama penghapusan.
force

boolean

Benar-benar melakukan penghapusan permanen. Jika force disetel ke salah (false), kembalikan jumlah penghapusan yang diharapkan tanpa menghapus dokumen apa pun.
Kolom union source. Sumber input yang diinginkan untuk menghapus dokumen berdasarkan ID dokumen. source hanya ada berupa salah satu diantara berikut:
gcsSource

object (GcsSource)

Lokasi Cloud Storage untuk konten input. dataSchema yang didukung: * documentId: Satu Document.id yang valid per baris.
inlineSource

object (InlineSource)

Sumber inline untuk konten input yang akan dihapus.

Isi respons

Jika berhasil, isi respons akan berisi instance Operation.

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 parent:

  • discoveryengine.documents.purge

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.