SubmitIndexJob - Alibaba Cloud Model Studio - Alibaba Cloud Documentation Center

Deskripsi operasi

Pengguna Resource Access Management (RAM) harus terlebih dahulu memperoleh izin API untuk Studio Model (memerlukan AliyunBailianDataFullAccess, yang mencakup izin sfm:SubmitIndexJob), dan bergabung ke ruang kerja sebelum memanggil operasi ini. Akun Alibaba Cloud dapat memanggil operasi ini secara langsung tanpa otorisasi. Gunakan SDK Studio Model versi terbaru untuk memanggil operasi ini.
Sebelum memanggil operasi ini, Anda harus memanggil operasi CreateIndex dan memperoleh IndexId yang sesuai.
Setelah memanggil operasi ini, node memerlukan waktu untuk dieksekusi dan dapat memakan waktu beberapa jam selama periode puncak. Jangan mengirimkan permintaan duplikat sebelum node selesai. Untuk mengkueri status eksekusi node, panggil operasi GetIndexJobStatus.
Setelah Basis pengetahuan dibuat, Anda dapat mengaitkannya dengan Aplikasi agen di ruang kerja yang sama melalui Manajemen Aplikasi (atau meneruskan IndexID melalui rag_options di Pemanggilan Aplikasi) untuk melengkapi aplikasi Studio Model Anda dengan pengetahuan pribadi dan informasi terkini. Anda juga dapat memilih untuk tidak menggunakan aplikasi Studio Model dan langsung mengkueri Basis pengetahuan dengan memanggil operasi Retrieve.
Operasi ini tidak mendukung idempotensi.

Batas laju: Operasi ini akan dibatasi jika dipanggil terlalu sering. 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.

Test

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

create

*All resources

*

None

Sintaks permintaan

POST /{WorkspaceId}/index/submit_index_job 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

Elemen respons

Element	Type	Description	Example
	object	Skema Respons.
Code	string	Kode kesalahan.	Index.InvalidParameter
Data	object	Data bisnis yang dikembalikan oleh operasi.
Id	string	ID tugas, yaitu `JobId` yang diperlukan saat memanggil operasi GetIndexJobStatus.	eFDr2fGRzP9gdDZWAdo3xxxx
IndexId	string	ID basis pengetahuan.	79c0alxxxx
Message	string	Paket kesalahan.	Required parameter(%s) missing or invalid, please check the request parameters.
RequestId	string	ID permintaan.	17204B98-xxxx-4F9A-8464-2446A84821CA
Status	string	Kode status yang dikembalikan oleh operasi.	200
Success	boolean	Apakah operasi berhasil. Nilai valid: true: Berhasil. false: Gagal.	true

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	RagIndex.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.	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.