All Products
Search

This Product

    Alibaba Cloud Model Studio:CreateIndex

    Document Center

    Alibaba Cloud Model Studio:CreateIndex

    Last Updated:Sep 02, 2026

    Membuat basis pengetahuan, baik basis pengetahuan tidak terstruktur berdasarkan dokumen atau audio/video, maupun basis pengetahuan terstruktur untuk kueri data atau tanya jawab berbasis gambar.

    Deskripsi operasi

    • Persyaratan izin:

      • Pengguna RAM: Dapatkan izin API untuk Alibaba Studio Model Studio terlebih dahulu (Anda dapat menggunakan kebijakan AliyunBailianDataFullAccess, yang mencakup izin sfm:CreateIndex yang diperlukan oleh operasi ini), dan bergabung dengan ruang kerja sebelum memanggil operasi ini.
      • Akun Alibaba Cloud: Memiliki izin secara default dan dapat memanggil operasi ini langsung.

    • Metode pemanggilan: Gunakan Alibaba Studio Model Studio SDK terbaru. SDK telah mengenkapsulasi logika perhitungan tanda tangan yang kompleks dan menyederhanakan prosedur pemanggilan.

    • Langkah selanjutnya: Operasi ini hanya melakukan inisialisasi pekerjaan pembuatan basis pengetahuan. Setelah memanggil operasi ini, Anda harus memanggil operasi SubmitIndexJob untuk menyelesaikan pembuatan (jika tidak, Anda akan mendapatkan basis pengetahuan kosong). Untuk contoh kode, lihat Panduan API Basis Pengetahuan.

    • Idempotensi: Operasi ini tidak memiliki idempotensi. Pemanggilan berulang dapat membuat beberapa basis pengetahuan dengan nama yang sama. Terapkan pemanggilan idempoten dengan melakukan kueri terlebih dahulu lalu membuat.

    Pembatasan laju: Operasi ini tunduk pada pembatasan laju. 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:CreateIndex

    create

    *Semua resource.

    *

    		NoneNone

    Sintaks permintaan 

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

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example

    WorkspaceId

    string

    Yes

    ID ruang kerja, yang menentukan ruang kerja tempat basis pengetahuan dibuat. Untuk informasi lebih lanjut, lihat Cara menggunakan ruang kerja.

    llm-3z7uw7fwz0vexxxx.

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example

    Name

    string

    Yes

    Nama basis pengetahuan. Nama harus memiliki panjang 1 hingga 20 karakter dan dapat berisi karakter Tionghoa, huruf, angka, garis bawah (_), tanda hubung (-), titik (.), dan titik dua (:).

    EnterpriseHelpDocLibrary.

    StructureType

    string

    Yes

    Tipe basis pengetahuan.

    Nilai valid:

    • unstructured: Basis pengetahuan pencarian dokumen atau audio/video. Skenario default untuk tipe pencarian dokumen adalah tanya jawab dokumen dasar.

    Tipe basis pengetahuan tidak dapat diubah setelah pembuatan.

    Valid values:

    • unstructured :

      unstructured.

    unstructured.

    EmbeddingModelName

    string

    No

    • del penyematan yang digunakan oleh basis pengetahuan. Model penyematan mengubah prompt input asli dan teks pengetahuan menjadi vektor numerik untuk perbandingan kemiripan. Model default text-embedding-v2 (tidak dapat diubah) mendukung bahasa Tionghoa, Inggris, dan berbagai bahasa lainnya, serta melakukan normalisasi pada hasil vektor. Untuk informasi lebih lanjut, lihat Vektorisasi. Nilai valid:

    • text-embedding-v2

    Nilai default: kosong, yang menggunakan model text-embedding-v2.

    text-embedding-v4

    RerankModelName

    string

    No

    Model penyusunan ulang yang digunakan oleh basis pengetahuan. Model penyusunan ulang adalah sistem penilaian eksternal yang menghitung skor kemiripan antara kueri pengguna dan setiap chunk teks dalam basis pengetahuan, mengurutkannya secara menurun, dan mengembalikan K chunk teks teratas dengan skor tertinggi. Nilai valid:

    • gte-rerank-hybrid: Penyusunan ulang resmi.

    • gte-rerank: Penyusunan ulang gte-rerank.

    Nilai default: kosong, yang menggunakan gte-rerank-hybrid.

    Jika Anda hanya memerlukan penyusunan ulang semantik, gunakan gte-rerank. Jika Anda memerlukan penyusunan ulang semantik dan fitur pencocokan teks untuk memastikan relevansi, gunakan gte-rerank-hybrid.

    Valid values:

    • gte-rerank-hybrid :

      Penyusunan ulang resmi.

    • gte-rerank :

      Penyusunan ulang gte-rerank.

    gte-rerank-hybrid.

    RerankMinScore

    number

    No

    Ambang batas kemiripan. Hanya chunk teks dengan skor kemiripan yang melebihi nilai ini yang akan dipanggil kembali. Parameter ini memfilter chunk teks yang dikembalikan oleh model penyusunan ulang. Rentang nilai: [0.01-1.00].

    Jika tidak ditentukan, nilai default adalah 0.01.

    0.20

    ChunkSize

    integer

    No

    Ukuran chunk, yang menentukan jumlah maksimum karakter per chunk teks. Ketika panjang ini terlampaui, teks kemungkinan akan terpotong.

    Rentang nilai: [1-6000]. Jika tidak ditentukan, nilai default adalah 500.

    Jika ChunkSize diatur ke nilai kurang dari 100, Anda juga harus mengatur OverlapSize. Anda juga dapat membiarkan kedua parameter tidak ditentukan, dan sistem akan menggunakan nilai default.

    128

    OverlapSize

    integer

    No

    Ukuran tumpang tindih chunk, yang menentukan jumlah karakter yang tumpang tindih antara chunk teks saat ini dan chunk teks sebelumnya. Rentang nilai: [0-1024].

    Jika tidak ditentukan, nilai default adalah 100.

    OverlapSize harus kurang dari ChunkSize. Jika tidak, pengecualian chunking akan terjadi.

    16

    Separator

    string

    No

    Parameter ini tidak tersedia. Jangan berikan parameter ini.

    (?<=。)

    SourceType

    string

    No

    Parameter ini diperlukan dalam SDK terbaru. Jika tidak, memanggil operasi SubmitIndexJob akan mengembalikan error: Required parameter(data_sources) missing or invalid.

    Tipe sumber data. Nilai valid:

    • DATA_CENTER_CATEGORY: Tipe kategori. Mengimpor semua file di bawah kategori tertentu di Application Data. Beberapa kategori dapat diimpor secara bersamaan.

    • DATA_CENTER_FILE: Tipe file. Mengimpor file tertentu dari Application Data. Beberapa file dapat diimpor secara bersamaan.

    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.

    Untuk membuat basis pengetahuan kosong, gunakan kategori kosong yang tidak berisi file: atur parameter ini ke DATA_CENTER_CATEGORY dan berikan ID kategori kosong di CategoryIds.

    Valid values:

    • DATA_CENTER_CATEGORY :

      tipe kategori.

    • DATA_CENTER_FILE :

      tipe file.

    DATA_CENTER_FILE.

    DocumentIds

    array

    No

    Daftar file untuk diimpor saat membuat basis pengetahuan. Tentukan ID file di sini. Kami merekomendasikan untuk mengimpor tidak lebih dari 10.000 file. Untuk file sisanya, panggil operasi SubmitIndexAddDocumentsJob untuk melanjutkan impor.

    string

    No

    ID file, yaitu FileId yang dikembalikan oleh operasi AddFile, atau diperoleh dengan mengklik ikon ID di sebelah nama file pada tab Files dari konektor file Application Data.

    file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx.

    CategoryIds

    array

    No

    Daftar ID kategori untuk diimpor saat membuat basis pengetahuan. Semua file di bawah kategori yang ditentukan akan diimpor. Kami merekomendasikan untuk mengimpor tidak lebih dari 500 file. Untuk file sisanya, panggil operasi SubmitIndexAddDocumentsJob untuk melanjutkan impor.

    string

    No

    ID kategori, yaitu CategoryId yang dikembalikan oleh operasi AddCategory, atau diperoleh dengan mengklik ikon ID di sebelah nama kategori pada tab Files dari konektor file Application Data.

    ca_hiu2383nfxxxx.

    TableIds

    array

    No

    Parameter ini tidak tersedia. Jangan berikan parameter ini.

    string

    No

    SinkType

    string

    Yes

    Tipe penyimpanan vektor basis pengetahuan. Untuk informasi lebih lanjut, lihat Basis pengetahuan. Nilai valid:

    • BUILT_IN: Data vektor dihosting di platform Alibaba Cloud Studio Model.

    • ADB: Database Analitik for PostgreSQL. Jika Anda memerlukan fitur lanjutan seperti manajemen database, audit, dan pemantauan, pilih ADB.

    Jika Anda belum menggunakan penyimpanan ADB di Alibaba Cloud Studio Model sebelumnya, buka halaman Create Knowledge Base, pilih ADB-PG sebagai tipe penyimpanan vektor, dan selesaikan otorisasi sesuai petunjuk. Jika Anda memberikan ADB, Anda harus menentukan parameter SinkInstanceId dan SinkRegion.

    Valid values:

    • BUILT_IN :

      BUILT_IN.

    • ADB :

      ADB.

    BUILT_IN.

    SinkInstanceId

    string

    No

    ID instans Database Analitik for PostgreSQL (hanya diperlukan ketika SinkType diatur ke ADB). Dapatkan ID ini dari halaman daftar instans Database Analitik for PostgreSQL.

    gp-bp32109xxxx.

    SinkRegion

    string

    No

    Wilayah instans Database Analitik for PostgreSQL (hanya diperlukan ketika SinkType diatur ke ADB). Panggil DescribeRegions untuk memperoleh daftar wilayah.

    cn-hangzhou.

    Columns

    array<object>

    No

    Parameter ini tidak tersedia. Jangan berikan parameter ini.

    object

    No

    Parameter ini tidak tersedia. Jangan berikan parameter ini.

    Column

    string

    No

    Parameter ini tidak tersedia. Jangan berikan parameter ini.

    school.

    IsRecall

    boolean

    No

    Parameter ini tidak tersedia. Jangan berikan parameter ini.

    true.

    IsSearch

    boolean

    No

    Parameter ini tidak tersedia. Jangan berikan parameter ini.

    true.

    Name

    string

    No

    Parameter ini tidak tersedia. Jangan berikan parameter ini.

    School.

    Type

    string

    No

    Parameter ini tidak tersedia. Jangan berikan parameter ini.

    string.

    Description

    string

    No

    Deskripsi basis pengetahuan. Deskripsi dapat memiliki panjang hingga 1000 karakter. Nilai default: kosong.

    The enterprise help document library includes important materials such as company policies and product catalogs.

    metaExtractColumns

    array<object>

    No

    Konfigurasi ekstraksi metadata. Metadata adalah sekumpulan atribut tambahan yang terkait dengan konten data tidak terstruktur. Atribut ini diintegrasikan ke dalam chunk teks sebagai pasangan kunci-nilai. Untuk informasi lebih lanjut, lihat Basis pengetahuan.

    object

    No

    Key

    string

    No

    Bidang metadata. Bidang harus memiliki panjang 1 hingga 50 karakter dan hanya dapat berisi huruf dan garis bawah. Jika parameter ini ditentukan, Anda juga harus menentukan parameter Value dan Type.

    author.

    Value

    string

    No

    Nilai bidang metadata.

    Tim.

    Type

    string

    No

    Metode ekstraksi untuk bidang metadata. Nilai valid:

    • constant: Konstanta.

    • variable: Variabel.

    • custom_prompt: Model bahasa besar.

    • regular: Ekspresi reguler.

    • keywords: Pencarian kata kunci.

    Valid values:

    • constant :

      ekstraksi konstanta.

    • keywords :

      ekstraksi kata kunci.

    • custom_prompt :

      model bahasa Tingkat Tinggi.

    • variable :

      ekstraksi variabel.

    • regular :

      ekspresi reguler.

    constant.

    Desc

    string

    No

    Deskripsi bahasa Tionghoa dari bidang metadata. Deskripsi dapat memiliki panjang hingga 1000 karakter dan dapat berisi karakter Tionghoa, huruf, angka, garis bawah (_), tanda hubung (-), titik (.), dan titik dua (:). Nilai default: kosong.

    AuthorName.

    EnableLlm

    boolean

    No

    Apakah bidang metadata ini dan nilainya berpartisipasi dalam proses generasi jawaban model bahasa Tingkat Tinggi bersama dengan konten chunk teks. Nilai valid:

    • true: Diaktifkan.

    • false: Dinonaktifkan.

    Nilai default: false.

    Valid values:

    • true :

      diaktifkan.

    • false :

      dinonaktifkan.

    false.

    EnableSearch

    boolean

    No

    Apakah bidang metadata ini dan nilainya berpartisipasi dalam pengambilan basis pengetahuan bersama dengan konten chunk teks. Nilai valid:

    • true: Diaktifkan.

    • false: Dinonaktifkan.

    Nilai default: false.

    Valid values:

    • true :

      diaktifkan.

    • false :

      dinonaktifkan.

    false.

    enableHeaders

    boolean

    No

    Apakah akan memperlakukan baris pertama dari semua file xlsx dan xls sebagai header dan menggabungkannya ke dalam setiap chunk teks, 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, jangan aktifkan.

    Nilai valid:

    • true: Diaktifkan.

    • false: Dinonaktifkan.

    Jika tidak ditentukan, fitur ini dinonaktifkan secara default.

    Valid values:

    • true :

      diaktifkan.

    • false :

      dinonaktifkan.

    false.

    chunkMode

    string

    No

    Parameter ini tidak tersedia. Jangan berikan parameter ini.

    Valid values:

    • regex :

      chunk berdasarkan ekspresi reguler.

    • length :

      chunk berdasarkan panjang.

    • h1 :

      chunk berdasarkan judul tingkat pertama.

    • h2 :

      chunk berdasarkan judul tingkat kedua.

    • page :

      chunk berdasarkan halaman.

    regex.

    EnableRewrite

    boolean

    No

    Apakah akan mengaktifkan penulisan ulang percakapan multi-turn. Nilai valid:

    • true: Diaktifkan.

    • false: Dinonaktifkan.

    Jika tidak ditentukan, fitur ini diaktifkan secara default.

    Valid values:

    • true :

      diaktifkan.

    • false :

      dinonaktifkan.

    true.

    CreateIndexType

    string

    No

    Parameter ini tidak tersedia. Jangan berikan parameter ini.

    standard.

    pipelineCommercialType

    string

    No

    Parameter ini tidak tersedia. Jangan berikan parameter ini.

    standard.

    pipelineCommercialCu

    integer

    No

    Parameter ini tidak tersedia. Jangan berikan parameter ini.

    1

    pipelineRetrieveRateLimitStrategy

    string

    No

    Parameter ini tidak tersedia. Jangan berikan parameter ini.

    downgrade

    knowledgeType

    string

    No

    Kode sumber data. Diperlukan saat membuat basis pengetahuan kueri data. Digunakan bersama dengan parameter table dan database.

    • Operasi ini tidak mendukung pengasosiasian database kustom. Gunakan Konsol Alibaba Cloud Studio Model untuk membuatnya.

    260xxx.

    RerankMode

    string

    No

    Nama tabel data. Diperlukan saat membuat basis pengetahuan kueri data.

    Tabel data harus ada di sumber data yang ditentukan oleh connectId atau datasourceCode.

    Valid values:

    • similar: 相似模式。 :

      similar: 相似模式。

    • custom: 自定义模式。 :

      custom: 自定义模式。

    • qa:（默认值） 问答模式。 :

      qa:（默认值） 问答模式。

    lance.

    RerankInstruct

    string

    No

    Nama database. Diperlukan saat membuat basis pengetahuan kueri data.

    Database harus ada di sumber data yang ditentukan oleh datasourceCode.

    database_a6eacabe6

    No

    Parameter ini tidak tersedia. Jangan berikan parameter ini.

    document.

    No

    Parameter ini tidak tersedia. Jangan berikan parameter ini.

    basic_document_qa.

    No

    Parameter ini tidak tersedia. Jangan berikan parameter ini.

    conn_mysql_xxx_xxx.

    No

    connector.

    No

    Parameter ini tidak tersedia. Jangan berikan parameter ini. [_single.params.RerankMode.enum.similar: 相似模式。]similar: Mode kemiripan. [_single.params.RerankMode.enum.custom: 自定义模式。]custom: Mode kustom. [_single.params.RerankMode.enum.qa:（默认值） 问答模式。]qa: (Default) Mode tanya jawab. [parameters.33.schema.enumValueTitles.similar: 相似模式。]similar: Mode kemiripan. [parameters.33.schema.enumValueTitles.custom: 自定义模式。]custom: Mode kustom. [parameters.33.schema.enumValueTitles.qa:（默认值） 问答模式。]qa: (Default) Mode tanya jawab. [_single.params.RerankMode.enum.similar: 相似模式。]similar: Mode kemiripan. [_single.params.RerankMode.enum.custom: 自定义模式。]custom: Mode kustom. [_single.params.RerankMode.enum.qa:（默认值） 问答模式。]qa: (Default) Mode tanya jawab. [parameters.33.schema.enumValueTitles.similar: 相似模式。]similar: Mode kemiripan. [parameters.33.schema.enumValueTitles.custom: 自定义模式。]custom: Mode kustom. [parameters.33.schema.enumValueTitles.qa:（默认值） 问答模式。]qa: (Default) Mode tanya jawab. [_single.params.RerankMode.enum.similar: 相似模式。]similar: 相似模式。 [_single.params.RerankMode.enum.custom: 自定义模式。]custom: 自定义模式。 [_single.params.RerankMode.enum.qa:（默认值） 问答模式。]qa:（默认值） 问答模式。 [parameters.33.schema.enumValueTitles.similar: 相似模式。]similar: 相似模式。 [parameters.33.schema.enumValueTitles.custom: 自定义模式。]custom: 自定义模式。 [parameters.33.schema.enumValueTitles.qa:（默认值） 问答模式。]qa:（默认值） 问答模式。

    Valid values:

    • similar: 相似模式。 :

      similar: 相似模式。

    • custom: 自定义模式。 :

      custom: 自定义模式。

    • qa:（默认值） 问答模式。 :

      qa:（默认值） 问答模式。

    qa

    No

    Parameter ini tidak tersedia. Jangan berikan parameter ini.

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Skema Respons.

    Code

    string

    Kode status error.

    Data

    object

    Data bisnis yang dikembalikan ketika permintaan berhasil.

    Id

    string

    ID basis pengetahuan, juga dikenal sebagai IndexId. Ini adalah pengenal unik dari basis pengetahuan yang dibuat.

    Simpan nilai ini dengan benar. Ini diperlukan untuk semua operasi API berikutnya yang terkait dengan basis pengetahuan ini.

    jkurxhxxxx.

    Message

    string

    Paket error.

    RequestId

    string

    ID permintaan.

    17204B98-xxxx-4F9A--2446A84821CA.

    Status

    string

    Kode status yang dikembalikan oleh operasi.

    "200"

    Success

    boolean

    Apakah permintaan berhasil. Nilai valid:

    • true: Berhasil.

    • false: Gagal.

    true.

    Contoh

    Respons sukses

    JSONformat

    {
  "Code": "",
  "Data": {
    "Id": "jkurxhxxxx"
  },
  "Message": "",
  "RequestId": "17204B98-xxxx-4F9A--2446A84821CA",
  "Status": "\"200\"",
  "Success": true
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.