All Products
Search

This Product

    Alibaba Cloud Model Studio:SubmitIndexAddDocumentsJob

    Document Center

    Alibaba Cloud Model Studio:SubmitIndexAddDocumentsJob

    Last Updated:Jun 12, 2026

    Menambahkan file yang telah diparsing ke basis pengetahuan tertentu.

    Deskripsi operasi

    • API ini tidak mendukung basis pengetahuan kueri data / Tanya Jawab gambar. Untuk cara memperbarui basis pengetahuan kueri data / Tanya Jawab gambar, lihat deskripsi pembaruan basis pengetahuan di Basis pengetahuan.

    • API ini tidak mendukung basis pengetahuan kueri data / Tanya Jawab gambar. Untuk cara memperbarui basis pengetahuan kueri data / Tanya Jawab gambar, lihat deskripsi pembaruan basis pengetahuan di Basis pengetahuan..

    • Pengguna RAM (akun sekunder) harus terlebih dahulu mendapatkan izin API Studio Model Alibaba Cloud (izin AliyunBailianDataFullAccess diperlukan, yang sudah mencakup aksi sfm:SubmitIndexAddDocumentsJob) dan bergabung ke ruang kerja sebelum dapat memanggil API ini. Akun Alibaba Cloud (akun utama) dapat memanggilnya secara langsung tanpa otorisasi. Kami menyarankan Anda menggunakan versi terbaru dari Alibaba Cloud Model Studio SDK untuk memanggil API ini.

    • Sebelum memanggil API ini, pastikan Basis pengetahuan Anda telah dibuat dan tidak dihapus (artinya, ID Basis pengetahuan IndexId valid).

    • Sebelum memanggil API ini, panggil terlebih dahulu API AddFile untuk mengunggah file yang ingin Anda tambahkan ke Studio Model Alibaba Cloud.

    • Setelah API ini dipanggil, Tugas memerlukan beberapa pengatur waktu untuk dieksekusi, yang dapat memakan waktu berjam-jam selama periode puncak. Jangan memulai permintaan berulang sebelum Tugas selesai. Jika Anda perlu mengkueri status eksekusi Tugas, Anda dapat memanggil API GetIndexJobStatus. Daftar file Documents yang dikembalikan oleh API tersebut berisi semua file dalam penambahan Anda saat ini (diidentifikasi secara unik oleh job_id yang Anda berikan), dan Anda dapat memeriksa apakah setiap file telah berhasil diimpor (diparsing). Perhatikan bahwa panggilan berulang ke API GetIndexJobStatus akan dikenai Pembatasan kecepatan; frekuensinya tidak boleh melebihi 20 panggilan per menit.

    • Setelah API ini berhasil dipanggil, API akan terus dieksekusi selama beberapa pengatur waktu. Jangan memulai permintaan berulang sebelum permintaan kembali. API ini tidak idempoten.

    • Sebelum memanggil API ini, pastikan basis pengetahuan Anda telah dibuat dan tidak dihapus (artinya, ID basis pengetahuan IndexId valid).

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

    create

    *全部资源

    *

    		 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 cara mendapatkannya, 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 API CreateIndex.

    79c0alxxxx
    SourceType

    string

    Yes

    Tipe Sumber data. Nilai valid:

    • DATA_CENTER_CATEGORY: Tipe kategori. Mengimpor semua dokumen di bawah kategori yang ditentukan di Application Data. Beberapa kategori dapat diimpor.

    • DATA_CENTER_FILE: Tipe dokumen. Mengimpor file yang ditentukan di bawah Application Data. Beberapa file dapat diimpor.

    Catatan

    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 API AddFile. Anda juga dapat mendapatkannya di halaman Application Data dengan mengeklik ikon ID di sebelah nama file.

    doc_ea4a504d9ce545508d8aa6d90371bf54xxxxxxxx
    CategoryIds

    array

    No

    Daftar ID kategori.

    string

    No

    ID kategori, yaitu CategoryId yang dikembalikan oleh API AddCategory. Anda juga dapat mendapatkannya di tab Files pada halaman Application Data dengan mengeklik ikon ID di sebelah kategori.

    cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx

    ChunkMode

    string

    No

    Catatan

    Parameter ini belum tersedia. Jangan meneruskannya.

    length
    Separator

    string

    No

    Catatan

    Parameter ini belum tersedia. Jangan meneruskannya.

    (?<=。)
    ChunkSize

    integer

    No

    Catatan

    Parameter ini belum tersedia. Jangan meneruskannya.

    128
    OverlapSize

    integer

    No

    Catatan

    Parameter ini belum tersedia. Jangan meneruskannya.

    16
    EnableHeaders

    boolean

    No

    Apakah akan mendukung perakitan Header untuk file Excel. Saat diaktifkan, Basis pengetahuan memperlakukan baris pertama dari semua file format xlsx dan xls sebagai Header dan secara otomatis menambahkannya ke setiap chunk teks (baris data), untuk mencegah model Tingkat Tinggi salah memperlakukan Header sebagai baris data biasa.

    Catatan

    Disarankan untuk mengaktifkan ini hanya ketika semua file yang diimpor dalam format xlsx atau xls dan mengandung Header. Jika tidak, Anda tidak perlu mengaktifkannya.

    Nilai valid:

    • true: Aktifkan.

    • false: Jangan aktifkan.

    Nilai default adalah false, yaitu tidak diaktifkan.

    Valid values:

    • true :

      Aktifkan.

    • false :

      Jangan aktifkan.

    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

    Field bisnis yang dikembalikan oleh API.

    Id

    string

    ID tugas, juga dikenal sebagai JobId.

    42687eb254a34802bed398357f5498ae
    Status

    string

    Kode status yang dikembalikan oleh API.

    200
    Success

    boolean

    • false: Gagal.

    true
    Message

    string

    Paket error.

    Required parameter(%s) missing or invalid, please check the request parameters.
    Code

    string

    Kode status error.

    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.