Alibaba Cloud Model Studio:SubmitIndexAddDocumentsJob

Menambahkan file yang telah diparsing ke basis pengetahuan tertentu.

Deskripsi operasi

• Operasi ini tidak mendukung basis pengetahuan kueri data atau tanya jawab gambar. Untuk informasi tentang cara memperbarui basis pengetahuan kueri data atau tanya jawab gambar, lihat instruksi pembaruan basis pengetahuan di Basis pengetahuan.
• Pengguna Resource Access Management (RAM) harus terlebih dahulu memperoleh izin API untuk Studio Model (memerlukan AliyunBailianDataFullAccess, yang mencakup izin sfm:SubmitIndexAddDocumentsJob), dan bergabung dengan ruang kerja sebelum memanggil operasi ini. Akun Alibaba Cloud dapat memanggil operasi ini secara langsung tanpa otorisasi. Gunakan SDK Studio Model terbaru untuk memanggil operasi ini.
• Sebelum memanggil operasi ini, pastikan bahwa basis pengetahuan Anda telah dibuat dan belum dihapus (yaitu, ID basis pengetahuan IndexId valid).
• Sebelum memanggil operasi ini, panggil operasi AddFile untuk mengunggah file yang ingin Anda tambahkan ke Studio Model.
• Setelah memanggil operasi ini, node memerlukan waktu untuk dieksekusi dan mungkin memakan waktu beberapa jam selama periode puncak. Jangan kirim permintaan duplikat sebelum node selesai. Untuk mengkueri status eksekusi node, panggil operasi GetIndexJobStatus. Daftar file Documents yang dikembalikan oleh operasi ini berisi semua file dalam pekerjaan penambahan ini (diidentifikasi secara unik oleh job_id yang Anda berikan), dan Anda dapat memeriksa apakah setiap file berhasil diimpor (diparsing). Perhatikan bahwa memanggil GetIndexJobStatus terlalu sering akan memicu pembatasan laju. Jangan melebihi frekuensi 20 kali per menit.
• Setelah operasi ini berhasil dipanggil, diperlukan waktu untuk eksekusi. Jangan kirim permintaan duplikat sebelum tanggapan dikembalikan. Operasi ini tidak memiliki idempotensi.

Batasan laju: Panggilan yang sering ke operasi ini akan dibatasi. Jangan melebihi 10 panggilan per detik. Jika 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:SubmitIndexAddDocumentsJob	create	*Semua resource. *	None	None

Sintaks permintaan

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

Path Parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	ID ruang kerja tempat basis pengetahuan berada. Untuk informasi tentang cara memperoleh ID ruang kerja, lihat Cara menggunakan ruang kerja.	llm-3shx2gu255oqxxxx

Parameter permintaan

Parameter	Type	Required	Description	Example
IndexId	string	Yes	ID basis pengetahuan, yaitu Data.Id yang dikembalikan oleh operasi CreateIndex.	79c0alxxxx
SourceType	string	Yes	Tipe sumber data. Nilai valid: DATA_CENTER_CATEGORY: tipe kategori. Mengimpor semua dokumen di bawah kategori tertentu di Application Data. Mendukung beberapa kategori. DATA_CENTER_FILE: tipe dokumen. Mengimpor file tertentu dari Application Data. Mendukung beberapa file. Jika parameter ini diatur ke DATA_CENTER_CATEGORY, Anda harus menentukan parameter CategoryIds. Jika parameter ini diatur ke DATA_CENTER_FILE, Anda harus menentukan parameter DocumentIds. Valid values: DATA_CENTER_CATEGORY : tipe kategori. DATA_CENTER_FILE : tipe dokumen.	DATA_CENTER_FILE
DocumentIds	array	No	Daftar ID file.
	string	No	ID file, yaitu FileId yang dikembalikan oleh operasi AddFile. Anda juga dapat memperoleh ID file di halaman Application Data dengan mengklik ikon ID di sebelah nama file.	doc_ea4a504d9ce545508d8aa6d90371bf54xxxxxxxx
CategoryIds	array	No	Daftar ID kategori.
	string	No	ID kategori, yaitu CategoryId yang dikembalikan oleh operasi AddCategory. Anda juga dapat memperoleh ID kategori di tab Files Application Data dengan mengklik ikon ID di sebelah kategori.	cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx
ChunkMode	string	No	Parameter ini belum tersedia. Jangan tentukan parameter ini.	length
Separator	string	No	Parameter ini belum tersedia. Jangan tentukan parameter ini.	(?<=。)
ChunkSize	integer	No	Parameter ini belum tersedia. Jangan tentukan parameter ini.	128
OverlapSize	integer	No	Parameter ini belum tersedia. Jangan tentukan parameter ini.	16
EnableHeaders	boolean	No	Apakah akan mengaktifkan perakitan header untuk file Excel. Saat diaktifkan, basis pengetahuan memperlakukan baris pertama dari semua file xlsx dan xls sebagai header dan secara otomatis menambahkannya ke setiap chunk teks (baris data), mencegah model bahasa Tingkat Tinggi memperlakukan header sebagai baris data biasa. Aktifkan fitur ini hanya ketika semua file yang diimpor berformat xlsx atau xls dan mengandung header. Jika tidak, biarkan dinonaktifkan. Nilai valid: true: Diaktifkan. false: Dinonaktifkan. Nilai default: false. Valid values: true : Diaktifkan. false : Dinonaktifkan.	false
Extra	object	No
uniqueId	string	No

Elemen respons

Element	Type	Description	Example
	object	Skema Respons.
RequestId	string	ID permintaan.	778C0B3B-xxxx-5FC1-A947-36EDD13606AB
Data	object	Data bisnis yang dikembalikan oleh operasi.
Id	string	ID tugas, juga dikenal sebagai JobId.	42687eb254a34802bed398357f5498ae
Status	string	Kode status yang dikembalikan oleh operasi.	200
Success	boolean	Apakah operasi berhasil. Nilai valid: true: Berhasil. false: Gagal.	true
Message	string	Pesan kesalahan.	Required parameter(%s) missing or invalid, please check the request parameters
Code	string	Kode kesalahan.	Index.InvalidParameter

Contoh

Respons sukses

JSONformat

{
  "RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
  "Data": {
    "Id": "42687eb254a34802bed398357f5498ae"
  },
  "Status": "200",
  "Success": true,
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Code": "Index.InvalidParameter"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.