Alibaba Cloud Model Studio:DeleteIndexDocument

Menghapus file secara permanen dari knowledge base tertentu.

Deskripsi operasi

• Operasi ini tidak mendukung penghapusan data dari knowledge base kueri data atau tanya jawab gambar. Gunakan konsol Model Studio sebagai gantinya.
• Pengguna Resource Access Management (RAM) harus terlebih dahulu mendapatkan izin API untuk Model Studio (memerlukan AliyunBailianDataFullAccess, yang mencakup izin sfm:DeleteIndexDocument), sebelum memanggil operasi ini. Akun Alibaba Cloud dapat memanggil operasi ini secara langsung tanpa otorisasi. Gunakan SDK Model Studio terbaru untuk memanggil operasi ini.
• Sebelum memanggil operasi ini, pastikan knowledge base Anda telah dibuat dan belum dihapus (yaitu, ID knowledge base IndexId valid).
• Anda hanya dapat menghapus file yang statusnya impor gagal (INSERT_ERROR) atau impor berhasil (FINISH) di knowledge base. Untuk mengetahui status file di knowledge base tertentu, panggil operasi ListIndexDocuments.
• Penghapusan bersifat permanen. Konten file yang dihapus tidak dapat dipulihkan, dan operasi Retrieve tidak dapat lagi mengambil informasi terkait. Lanjutkan dengan hati-hati.
• Memanggil operasi ini tidak menghapus dokumen yang telah diimpor ke Data Aplikasi.
• Operasi ini bersifat idempoten.

Pembatasan: Operasi ini akan dibatasi jika dipanggil terlalu sering. Jangan melebihi 10 panggilan per detik. Jika Anda dibatasi, coba lagi nanti.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

• Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

• API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

• Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

• Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

  • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
  • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

• Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

• Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action	Access level	Resource type	Condition key	Dependent action
sfm:DeleteIndexDocument	delete	*All Resources *	None	None

Sintaks permintaan

POST /{WorkspaceId}/index/delete_index_document HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	ID workspace tempat knowledge base berada. Untuk informasi tentang cara mendapatkan ID workspace, lihat Cara menggunakan workspace.	llm-3z7uw7fwz0vxxxx

Parameter permintaan

Parameter	Type	Required	Description	Example
IndexId	string	Yes	ID knowledge base, yaitu Data.Id yang dikembalikan oleh operasi CreateIndex.	79c0alxxxx
DocumentIds	array	Yes	Daftar ID file.
	string	No	ID file, yaitu FileId yang dikembalikan oleh operasi AddFile. Anda juga dapat memperoleh ID file dengan mengklik ikon ID di samping nama file pada tab Data Aplikasi - File.	file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx

Elemen respons

Element	Type	Description	Example
	object	Skema Respons
RequestId	string	ID permintaan.	17204B98-xxxx-4F9A-8464-2446A84821CA
Code	string	Kode kesalahan.	Index.InvalidParameter
Message	string	Pesan kesalahan.	Required parameter(%s) missing or invalid, please check the request parameters.
Success	boolean	Menunjukkan apakah operasi berhasil. Nilai yang valid: true: Operasi berhasil. false: Operasi gagal.	true
Data	object	Bidang data bisnis yang dikembalikan oleh operasi.
DeletedDocument	array	Daftar ID file yang berhasil dihapus.
	string	ID file.	file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx
Status	string	Kode status yang dikembalikan oleh operasi.	200

Contoh

Respons sukses

JSONformat

{
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Code": "Index.InvalidParameter",
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Success": true,
  "Data": {
    "DeletedDocument": [
      "file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx"
    ]
  },
  "Status": "200"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.