Alibaba Cloud Model Studio:GetIndexJobStatus

Mengkueri status saat ini dari tugas pembuatan basis pengetahuan atau tugas penambahan dokumen basis pengetahuan tertentu.

Deskripsi operasi

• Pengguna Resource Access Management (RAM) harus terlebih dahulu memperoleh izin API untuk Alibaba Studio Model Studio (AliyunBailianDataFullAccess atau AliyunBailianDataReadOnlyAccess, yang keduanya mencakup izin sfm:GetIndexJobStatus), dan bergabung dengan ruang kerja sebelum memanggil operasi ini. Akun Alibaba Cloud dapat memanggil operasi ini secara langsung tanpa otorisasi. Gunakan Alibaba Studio Model Studio SDK terbaru untuk memanggil operasi ini.
• Anda harus memiliki pekerjaan basis pengetahuan yang sedang berjalan. Anda dapat membuat tugas pembuatan basis pengetahuan dengan memanggil operasi SubmitIndexJob, atau membuat tugas penambahan dokumen basis pengetahuan dengan memanggil operasi SubmitIndexAddDocumentsJob. Dapatkan JobId yang sesuai.
• Panggil operasi ini dengan interval 5 detik atau lebih.
• Operasi ini mendukung idempotensi.

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:GetIndexJobStatus	get	*All Resource *	None	None

Sintaks permintaan

GET /{WorkspaceId}/index/job/status HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	ID ruang kerja. Pastikan basis pengetahuan yang ingin Anda operasikan berada di ruang kerja ini. Untuk informasi tentang cara mendapatkan ID ruang kerja, lihat Cara menggunakan ruang kerja.	llm-3z7uw7fwz0vexxxx

Parameter permintaan

Parameter	Type	Required	Description	Example
JobId	string	Yes	ID pekerjaan basis pengetahuan, yaitu Data.Id yang dikembalikan oleh operasi SubmitIndexJob atau SubmitIndexAddDocumentsJob.	20230718xxxx-146c93bf
IndexId	string	Yes	ID basis pengetahuan, yaitu Data.Id yang dikembalikan oleh operasi CreateIndex.	79c0alxxxx
PageNumber	integer	No	Operasi SubmitIndexJob dan SubmitIndexAddDocumentsJob mendukung impor file batch. Operasi ini mengembalikan status keseluruhan pekerjaan basis pengetahuan (Status) dan status impor setiap file (Document.Status). Jika terdapat banyak file, gunakan parameter PageNumber untuk kueri berhalaman. Nilai minimum: 1. Nilai default: 1.	1
pageSize	integer	No	Jumlah tugas impor file yang ditampilkan per halaman dalam kueri berhalaman. Tidak ada batas maksimum. Nilai default: 10.	10

Elemen respons

Element	Type	Description	Example
	object	Skema Respons.
Code	string	Kode status error.	Index.Forbidden
Data	object	Bidang data yang dikembalikan oleh operasi.
Documents	array<object>	Daftar file yang diimpor dalam pekerjaan ini.
	object	Objek file.
Code	string	Kode kesalahan.	Index.Document.ChunkError
DocId	string	ID file.	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
DocName	string	Nama file.	XXX产品介绍
Message	string	Paket kesalahan.	document parse error
Status	string	Status impor file. Nilai valid: INSERT_ERROR: Impor file gagal. RUNNING: File sedang diimpor. DELETED: File telah dihapus. FINISH: File telah diimpor.	RUNNING
GmtModified	integer
JobId	string	ID pekerjaan.	66122af12a4e45ddae6bd6c84555xxxx
Status	string	Status saat ini dari pekerjaan basis pengetahuan. Nilai valid: COMPLETED: Eksekusi berhasil. FAILED: Eksekusi gagal. RUNNING: Eksekusi sedang berlangsung. PENDING: Menunggu eksekusi. Valid values: COMPLETED : Eksekusi berhasil. FAILED : Eksekusi gagal. RUNNING : Eksekusi sedang berlangsung. PENDING : Menunggu eksekusi.	PENDING
Message	string	Paket error.	User not authorized to operate on the specified resource.
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.Forbidden",
  "Data": {
    "Documents": [
      {
        "Code": "Index.Document.ChunkError",
        "DocId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx",
        "DocName": "XXX产品介绍",
        "Message": "document parse error",
        "Status": "RUNNING",
        "GmtModified": 0
      }
    ],
    "JobId": "66122af12a4e45ddae6bd6c84555xxxx",
    "Status": "PENDING"
  },
  "Message": "User not authorized to operate on the specified resource.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.