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

Menghapus secara permanen semua Document yang dipilih 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, tetapkan PurgeDocumentsRequest.force ke false.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib diisi. 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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsSource": {
    object (GcsSource)
  },
  "inlineSource": {
    object (InlineSource)
  }
  // End of mutually exclusive fields.
}
Kolom
filter

string

Wajib diisi. Filter 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. Jika force ditetapkan ke false, tampilkan jumlah penghapusan yang diharapkan tanpa menghapus dokumen apa pun.
Sumber input yang diinginkan untuk menghapus dokumen berdasarkan ID dokumen. Berikut adalah daftar kolom yang saling eksklusif. Paling banyak satu kolom akan ditetapkan dalam respons:
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.
Akhir kolom yang saling eksklusif.

Isi respons

Jika berhasil, isi respons akan memuat instance Operation.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.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.