All Products
Search

This Product

    Alibaba Cloud Model Studio:ListChunks

    Document Center

    Alibaba Cloud Model Studio:ListChunks

    Last Updated:Sep 02, 2026

    Mengkueri daftar dan informasi chunk teks.

    Deskripsi operasi

    • Untuk basis pengetahuan pencarian dokumen, operasi ini mengkueri semua chunk dari file tertentu. Untuk basis pengetahuan kueri data atau tanya jawab gambar, operasi ini mengambil informasi tentang semua chunk teks.
    • Pengguna Resource Access Management (RAM) harus terlebih dahulu mendapatkan izin API untuk Studio Model (memerlukan AliyunBailianDataFullAccess, yang mencakup izin sfm:ChunkList), dan bergabung ke ruang kerja sebelum memanggil operasi ini. Akun Alibaba Cloud dapat memanggil operasi ini secara langsung tanpa otorisasi. Gunakan Studio Model SDK versi terbaru untuk memanggil operasi ini.
    • Sebelum memanggil operasi ini, pastikan basis pengetahuan Anda telah dibuat dan belum dihapus (artinya, ID basis pengetahuan IndexId valid).
    • Operasi ini bersifat idempoten.

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

    list

    *全部资源

    *

    		NoneNone

    Sintaks permintaan 

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

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example

    WorkspaceId

    string

    Yes

    ID ruang kerja basis pengetahuan. Untuk informasi tentang cara mendapatkan ID ruang kerja, lihat Cara menggunakan ruang kerja.

    llm-3z7uw7fwz0vxxxx

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example

    body

    object

    No

    Body parameter permintaan.

    Fields

    array

    No

    Array nama bidang yang digunakan untuk memfilter bidang non-pribadi (yang tidak diawali dengan garis bawah _) dalam bidang Metadata yang dikembalikan oleh operasi ini. Secara default, Fields kosong, dan semua bidang non-pribadi dalam Metadata dikembalikan. Untuk hanya mengembalikan bidang non-pribadi tertentu dalam Metadata, seperti title, berikan title pada parameter ini.

    Nilai default: kosong.

    string

    No

    Nama bidang.

    name

    Filed

    string

    No

    Bidang ID file pada Studio Model SDK versi lama. Penggunaan dan nilai defaultnya identik dengan bidang FileId. Jika Anda menggunakan Studio Model SDK versi berikut (atau yang lebih baru), gunakan bidang FileId sebagai gantinya. Jika Anda menggunakan SWIFT Studio Model SDK, lanjutkan penggunaan bidang ini.

    • Java (async): 1.0.18

    • Java: 1.10.2

    • TypeScript: 1.10.2

    • Go: 1.10.2

    • PHP: 1.10.2

    • Python: 1.10.2

    • C#: 1.10.2

    • C++: 1.10.17

    Cara memeriksa versi Studio Model SDK: Kunjungi Studio Model SDK center, klik "Install" di panel navigasi sisi kiri, atur versi API menjadi "2023-12-29", pilih bahasa pemrograman Anda, lalu klik "History Versions" untuk melihat versinya.

    file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx

    FileId

    string

    No

    ID file, yaitu FileId yang dikembalikan oleh operasi AddFile. Bidang ini tidak wajib untuk basis pengetahuan kueri data atau tanya jawab gambar. Bidang ini wajib untuk basis pengetahuan pencarian dokumen. Anda juga dapat mendapatkan ID file dengan mengeklik ikon ID di sebelah nama file pada tab Files di Application Data. Anda dapat menggunakan ID file untuk memfilter chunk yang dikembalikan. Nilai default: kosong.

    .

    file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx

    IndexId

    string

    Yes

    ID basis pengetahuan, yaitu Data.Id yang dikembalikan oleh operasi CreateIndex.

    otoru9xxxx

    PageNum

    integer

    No

    Nomor halaman yang akan dikueri. Nilai minimum: 1. Nilai default: 1.

    1

    PageSize

    integer

    No

    Jumlah chunk teks yang ditampilkan per halaman dalam kueri berhalaman. Nilai maksimum: 100. Nilai default: 10.

    10

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Code

    string

    Kode status error.

    Index.InvalidParameter

    Data

    object

    Data bisnis yang dikembalikan oleh operasi.

    Nodes

    array<object>

    Daftar chunk teks.

    object

    Objek chunk teks.

    Metadata

    any

    Peta metadata chunk teks.

    Bidang file_path dalam peta metadata basis pengetahuan pencarian dokumen tidak memiliki arti. Jangan menggunakannya dalam kode bisnis Anda.

    Saat mengambil basis pengetahuan pencarian dokumen, jika chunk berisi gambar, gambar dikembalikan melalui bidang image_url dalam peta metadata, pengatur waktu kedaluwarsa.

    .

    { "file_path": "https://bailian-***", "parent": "阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。", "is_displayed_chunk_content": "true", "image_url": [], "nid": "83***", "source": "0", "_score": 0, "title": "", "doc_id": "file_24e***", "content": "阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。", "_rc_score": 0, "workspace_id": "llm-zna***", "hier_title": "", "doc_name": "什么是阿里云百炼", "pipeline_id": "j6b***", "_id": "llm-zna5***" }

    Score

    number

    Skor kesamaan chunk teks.

    0

    Text

    string

    Konten chunk teks.

    阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。

    Total

    integer

    Jumlah total hasil yang dikembalikan.

    1

    Message

    string

    Paket error.

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

    RequestId

    string

    ID permintaan.

    8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1

    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": {
    "Nodes": [
      {
        "Metadata": "{\n  \"file_path\": \"https://bailian-***\",\n  \"parent\": \"阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。\",\n  \"is_displayed_chunk_content\": \"true\",\n  \"image_url\": [],\n  \"nid\": \"83***\",\n  \"source\": \"0\",\n  \"_score\": 0,\n  \"title\": \"\",\n  \"doc_id\": \"file_24e***\",\n  \"content\": \"阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。\",\n  \"_rc_score\": 0,\n  \"workspace_id\": \"llm-zna***\",\n  \"hier_title\": \"\",\n  \"doc_name\": \"什么是阿里云百炼\",\n  \"pipeline_id\": \"j6b***\",\n  \"_id\": \"llm-zna5***\"\n}",
        "Score": 0,
        "Text": "阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。"
      }
    ],
    "Total": 1
  },
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "RequestId": "8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1",
  "Status": "200",
  "Success": true
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.