All Products
Search

This Product

    Alibaba Cloud Model Studio:ListIndexDocuments

    Document Center

    Alibaba Cloud Model Studio:ListIndexDocuments

    Last Updated:Jul 01, 2026

    Mengambil file dan informasi ringkasannya dari basis pengetahuan tertentu.

    Deskripsi operasi

    • Pengguna Resource Access Management (RAM) harus terlebih dahulu memperoleh izin API untuk Studio Model (memerlukan AliyunBailianDataFullAccess, yang mencakup izin sfm:ListIndexFiles) dan bergabung ke ruang kerja sebelum memanggil operasi ini. Akun Alibaba Cloud dapat memanggil operasi ini secara langsung tanpa otorisasi. Gunakan SDK Studio Model 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.

    Pembatasan kecepatan: Operasi ini akan dibatasi kecepatannya jika dipanggil terlalu sering. Jangan melebihi 15 panggilan per detik. Jika kecepatan 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:ListIndexFiles

    list

    *All Resource

    *

    		 None None

    Sintaks permintaan

    GET /{WorkspaceId}/index/list_index_documents HTTP/1.1

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    WorkspaceId

    string

    Yes

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

    llm-3z7uw7fwz0vexxxx

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    IndexId

    string

    Yes

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

    79c0alxxxx
    DocumentStatus

    string

    No

    Memfilter daftar file yang dikembalikan berdasarkan status impor file. Nilai valid:

    • INSERT_ERROR: Gagal diimpor ke indeks.

    • RUNNING: Pembuatan indeks sedang berlangsung.

    • DELETED: Dihapus.

    • FINISH: Pembuatan indeks berhasil.

    • PARSE_FAILED: Penguraian gagal.

    • DOC_PARSING: Penguraian sedang berlangsung.

    Nilai default: kosong, yang berarti tidak ada pemfilteran berdasarkan status impor file.

    Valid values:

    • INSERT_ERROR :

      Gagal mengimpor file.

    • RUNNING :

      File sedang diimpor.

    • DELETED :

      File telah dihapus.

    • FINISH :

      File telah diimpor.

    FINISH
    DocumentName

    string

    No

    Memfilter daftar file yang dikembalikan berdasarkan nama file (tanpa ekstensi file). Nilai default: kosong, yang berarti tidak ada pemfilteran berdasarkan nama file.

    product-overview
    EnableNameLike

    string

    No

    Apakah akan mengaktifkan pencocokan fuzzy untuk nama file. Parameter ini digunakan bersama dengan parameter DocumentName. Nilai valid:

    • true: Melakukan pencocokan fuzzy pada daftar file yang dikembalikan berdasarkan nama file.

    • false: Melakukan pencocokan eksak pada daftar file yang dikembalikan berdasarkan nama file.

    Nilai default: false.

    Valid values:

    • true :

      Diaktifkan.

    • false :

      Dinonaktifkan.

    false
    PageNumber

    integer

    No

    Nomor halaman. Nilai minimum: 1. Nilai default: 1.

    1
    PageSize

    integer

    No

    Jumlah file yang ditampilkan per halaman dalam kueri berhalaman. Tidak ada batas maksimum. Nilai default: 10.

    10

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Skema tanggapan.

    RequestId

    string

    ID permintaan.

    35A267BF-xxxx-54DB-8394-AA3B0742D833
    Code

    string

    Kode status error.

    InvalidParameter
    Message

    string

    Paket error.

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

    boolean

    Apakah operasi berhasil. Nilai valid:

    • true: Berhasil.

    • false: Gagal.

    true
    Data

    object

    Bidang data yang dikembalikan oleh operasi.

    Documents

    array<object>

    Daftar file dalam basis pengetahuan, diurutkan berdasarkan waktu impor dokumen secara menurun (konsisten dengan Konsol).

    object

    Objek file.

    SourceId

    string

    Untuk basis pengetahuan pencarian dokumen, parameter ini menentukan ID kategori, yaitu CategoryId yang dikembalikan oleh operasi AddCategory. Anda juga dapat memperoleh ID kategori dengan mengeklik ikon ID di sebelah nama kategori pada tab File di halaman Data Aplikasi.

    Untuk basis pengetahuan kueri data atau tanya jawab gambar, parameter ini menentukan ID tabel data. Anda dapat memperoleh ID tabel data dengan mengeklik ikon ID di sebelah nama tabel data pada tab Tabel di halaman Data Aplikasi.

    .

    cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx
    Id

    string

    ID file.

    doc_c134aa2073204a5d936d870bf960f56axxxxxxxx
    Name

    string

    Nama file.

    product-overview
    Size

    integer

    Ukuran file, dalam byte.

    996765
    DocumentType

    string

    Tipe format file. Nilai valid: pdf, docx, doc, txt, md, pptx, ppt, png, jpg, jpeg, bmp, gif, dan EXCEL.

    pdf
    Status

    string

    Status impor file. Nilai valid:

    • INSERT_ERROR: Gagal mengimpor file.

    • RUNNING: File sedang diimpor.

    • DELETED: File telah dihapus.

    • FINISH: File telah diimpor.

    Valid values:

    • INSERT_ERROR :

      Gagal mengimpor file.

    • RUNNING :

      File sedang diimpor.

    • DELETED :

      File telah dihapus.

    • FINISH :

      File telah diimpor.

    RUNNING
    Code

    string

    Kode status error untuk impor file.

    110002
    Message

    string

    Paket error untuk impor file.

    check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid
    GmtModified

    integer

    Waktu file diimpor ke basis pengetahuan, dalam format stempel waktu UNIX.

    1744856423000
    IndexId

    string

    ID basis pengetahuan.

    pno97txxxx
    TotalCount

    integer

    Jumlah total hasil yang dikembalikan.

    2437
    PageNumber

    integer

    Nomor halaman yang dikembalikan.

    1
    PageSize

    integer

    Jumlah entri per halaman yang dikembalikan.

    10
    Status

    string

    Kode status yang dikembalikan oleh operasi.

    200

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
  "Code": "InvalidParameter",
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Success": true,
  "Data": {
    "Documents": [
      {
        "SourceId": "cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx",
        "Id": "doc_c134aa2073204a5d936d870bf960f56axxxxxxxx",
        "Name": "product-overview",
        "Size": 996765,
        "DocumentType": "pdf",
        "Status": "RUNNING",
        "Code": "110002",
        "Message": "check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid",
        "GmtModified": 1744856423000
      }
    ],
    "IndexId": "pno97txxxx",
    "TotalCount": 2437,
    "PageNumber": 1,
    "PageSize": 10
  },
  "Status": "200"
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.