ListIndices - Alibaba Cloud Model Studio - Alibaba Cloud Documentation Center

Mengambil daftar basis pengetahuan di ruang kerja tertentu.

Deskripsi operasi

Pengguna Resource Access Management (RAM) harus terlebih dahulu mendapatkan izin API untuk Alibaba Studio Model Studio (memerlukan AliyunBailianDataFullAccess, yang mencakup izin sfm:ListIndex) sebelum memanggil operasi ini. Akun Alibaba Cloud dapat memanggil operasi ini secara langsung tanpa otorisasi. Gunakan Alibaba Studio Model Studio SDK versi terbaru untuk memanggil operasi ini.
Operasi ini bersifat idempoten.

Batas laju: Operasi ini akan dibatasi jika dipanggil terlalu sering. Jangan melebihi 10 panggilan per detik. Jika 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:ListIndex

list

*全部资源

*

None

Sintaks permintaan

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

Path Parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	ID ruang kerja tempat basis pengetahuan berada. Untuk informasi selengkapnya, lihat Cara menggunakan ruang kerja.	llm-3shx2gu255oq6xxxx

Parameter permintaan

Parameter	Type	Required	Description	Example
IndexName	string	No	Nama basis pengetahuan. Anda dapat menggunakan parameter ini untuk mencari basis pengetahuan berdasarkan nama. Panjang nama harus 1 hingga 20 karakter dan dapat berisi karakter yang diklasifikasikan sebagai huruf dalam Unicode (termasuk huruf Inggris, karakter Tionghoa, dan digit). Nama juga dapat berisi titik dua (:), garis bawah (_), titik (.), atau tanda hubung (-). Nilai default: kosong, yang mengkueri semua basis pengetahuan di ruang kerja yang ditentukan.	idx_status_score
PageNumber	string	No	Nomor halaman. Nilai minimum: 1. Nilai default: 1.	1
PageSize	string	No	Jumlah basis pengetahuan yang ditampilkan per halaman dalam kueri halaman. Tidak ada batas maksimum. Nilai default: 10.	10

Elemen respons

Element	Type	Description	Example
	object	Skema Tanggapan.
RequestId	string	ID permintaan.	17204B98-xxxx-4F9A-8464-2446A84821CA
Data	object	Data yang dikembalikan.
PageNumber	integer	Nomor halaman yang dikembalikan.	1
PageSize	integer	Jumlah entri per halaman yang dikembalikan.	10
TotalCount	integer	Jumlah total entri yang dikembalikan.	48
Indices	array<object>	Daftar basis pengetahuan.
	object	Objek basis pengetahuan.
Id	string	ID basis pengetahuan, yaitu `Data.Id` yang dikembalikan oleh operasi CreateIndex.	lecxr5xxxx
Name	string	Nama basis pengetahuan.	XXXX产品清单
Description	string	Deskripsi basis pengetahuan.	清单中产品主要面向海外客户。
StructureType	string	Tipe basis pengetahuan. Nilai valid: UNSTRUCTURED: pencarian dokumen.	UNSTRUCTURED
ChunkSize	integer	Panjang chunk yang diperkirakan. Nilai valid: 1 hingga 2048.	5
OverlapSize	integer	Panjang tumpang tindih chunk. Nilai valid: 0 hingga 1024.	10
Separator	string	Pemisah kalimat. Jika beberapa pemisah digunakan, pemisah tersebut dipisahkan oleh \|. Nilai valid: \n: baris baru ，: koma Tionghoa ,: koma Inggris 。: periode Tionghoa .: periode Inggris ！: tanda seru Tionghoa !: tanda seru Inggris ；: titik koma Tionghoa ;: titik koma Inggris ？: tanda tanya Tionghoa ?: tanda tanya Inggris.	\n
EmbeddingModelName	string	Nama model penyematan. Nilai valid: text-embedding-v2: model text-embedding-v2..	text-embedding-v2
RerankModelName	string	Nama model penyusunan ulang. Nilai valid: gte-rerank-hybrid: penyusunan ulang resmi. gte-rerank: penyusunan ulang gte-rerank. .	gte-rerank-hybrid
RerankMinScore	string	Ambang batas kesamaan. Nilai valid: 0.01 hingga 1.00.	0.01
SourceType	string	Tipe data data aplikasi Studio Model Alibaba Cloud. Untuk basis pengetahuan pencarian dokumen, nilai valid: DATA_CENTER_CATEGORY: tipe kategori. DATA_CENTER_FILE: tipe file. Untuk basis pengetahuan kueri data/tanya jawab gambar, nilai valid: DATA_CENTER_STRUCTURED_TABLE: tipe tabel data.	DATA_CENTER_FILE
DocumentIds	array	Daftar ID file.
	string	ID file.	file_8c67b438043848199ffaa903d29addd4_xxxxxxxx
SinkType	string	Tipe penyimpanan vektor basis pengetahuan. Nilai valid: ES: database vektor bawaan. BUILT_IN: database vektor bawaan. ADB: database Database Analitik for PostgreSQL.	BUILT_IN
SinkInstanceId	string	ID instans penyimpanan vektor untuk basis pengetahuan.	gp-bp1gq62t1788yxxxx
SinkRegion	string	Wilayah instans penyimpanan vektor untuk basis pengetahuan.	cn-hangzhou
ConfgModel	string	Mode konfigurasi yang digunakan oleh basis pengetahuan ini. Nilai valid: recommend: konfigurasi rekomendasi. user-defined: konfigurasi kustom.	recommend
EnableRewrite	boolean	Apakah penulisan ulang percakapan multi-putaran diaktifkan untuk basis pengetahuan ini. Nilai valid: true: Diaktifkan. false: Dinonaktifkan.	false
Code	string	Kode kesalahan.	Index.InvalidParameter
Message	string	Paket kesalahan.	Required parameter(%s) missing or invalid, please check the request parameters.
Success	boolean	Apakah operasi berhasil. Nilai valid: true: Berhasil. false: Gagal.	true
Status	string	Kode status yang dikembalikan oleh operasi.	200

Contoh

Respons sukses

JSONformat

{
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 48,
    "Indices": [
      {
        "Id": "lecxr5xxxx",
        "Name": "XXXX产品清单",
        "Description": "清单中产品主要面向海外客户。",
        "StructureType": "UNSTRUCTURED",
        "ChunkSize": 5,
        "OverlapSize": 10,
        "Separator": "\\n",
        "EmbeddingModelName": "text-embedding-v2",
        "RerankModelName": "gte-rerank-hybrid",
        "RerankMinScore": "0.01",
        "SourceType": "DATA_CENTER_FILE",
        "DocumentIds": [
          "file_8c67b438043848199ffaa903d29addd4_xxxxxxxx"
        ],
        "SinkType": "BUILT_IN",
        "SinkInstanceId": "gp-bp1gq62t1788yxxxx",
        "SinkRegion": "cn-hangzhou",
        "ConfgModel": "recommend",
        "EnableRewrite": false
      }
    ]
  },
  "Code": "Index.InvalidParameter",
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Success": true,
  "Status": "200"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.