Mengambil detail satu atau beberapa dokumen dalam kategori tertentu.
Deskripsi operasi
- Pengguna Resource Access Management (RAM) harus terlebih dahulu mendapatkan izin API untuk Alibaba Cloud Studio Model (memerlukan
AliyunBailianDataFullAccess, yang mencakup izin sfm:ListFile), dan bergabung ke ruang kerja sebelum memanggil operasi ini. Akun Alibaba Cloud dapat memanggil operasi ini secara langsung tanpa otorisasi. Panggil operasi ini menggunakan Alibaba Cloud Model Studio SDK versi terbaru. - Untuk paging pada halaman pertama, cukup tetapkan
MaxResultsuntuk membatasi jumlah entri yang dikembalikan.NextTokendalam tanggapan berfungsi sebagai kredensial untuk mengkueri halaman berikutnya. Saat mengkueri halaman berikutnya, tetapkan parameterNextTokenke nilaiNextTokenyang diperoleh dari tanggapan sebelumnya (jikaNextTokenkosong, semua hasil telah dikembalikan dan tidak perlu permintaan lebih lanjut), dan tetapkanMaxResultsuntuk membatasi jumlah entri yang dikembalikan. - Operasi ini bersifat idempoten.
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
Actionpada 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
Resourcepada kebijakan. - Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen
Resourcepada kebijakan.
- 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
- 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:ListFile | list | *全部资源
| None | None |
Sintaks permintaan
Path Parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WorkspaceId | string | Yes | ID ruang kerja tempat kategori berada. Untuk informasi tentang cara mendapatkan ID ruang kerja, lihat Cara menggunakan ruang kerja. | llm-3shx2gu255oqxxxx |
Parameter permintaan
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| CategoryId | string | Yes | ID kategori, yaitu . | cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx |
| NextToken | string | No | Token pagination. Tetapkan ini ke nilai NextToken yang dikembalikan oleh panggilan API sebelumnya. | AAAAAdH70eOCSCKtacdomNzak4U= |
| MaxResults | integer | No | Jumlah entri per halaman untuk paging. Nilai valid: 1 hingga 200. Nilai default: Jika tidak ada nilai yang ditetapkan atau nilai kurang dari 1, nilai default adalah 20. Jika nilai ditetapkan lebih dari 200, nilai default adalah 200. | 20 |
| FileName | string | No | Nama file (tanpa ekstensi). Hanya pencocokan tepat yang didukung. Pencarian fuzzy tidak didukung. | product-overview |
| FileIds | array | No | Daftar ID file yang akan dikueri. Maksimal 20 file dapat dikueri sekaligus. | |
string | No | ID file. | file_xxxx |
Elemen respons
Element | Type | Description | Example |
|---|---|---|---|
object | Skema Respons. | ||
| Code | string | Kode kesalahan. | success |
| Data | object | Bidang data yang dikembalikan oleh operasi. | |
| FileList | array<object> | Daftar file dalam kategori. | |
object | Objek file. | ||
| CategoryId | string | ID kategori tempat file berada. | cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx |
| CreateTime | string | Stempel waktu saat file ditambahkan ke Alibaba Cloud Studio Model. Format: yyyy-MM-dd HH:mm:ss. Zona waktu: UTC+8. | 2024-09-09 11:03:35 |
| FileId | string | ID file, yaitu | file_5ff599b3455a45db8c41b0054b361518_xxxxxxxx |
| FileName | string | Nama file. | product-overview.pdf |
| FileType | string | Tipe format file. Nilai valid: pdf, docx, doc, txt, md, pptx, ppt, xlsx, xls, html, png, jpg, jpeg, bmp, dan gif. | docx |
| Parser | string | Parser dokumen. Nilai valid:
| DASHSCOPE_DOCMIND |
| SizeInBytes | integer | Ukuran file dalam byte. | 512 |
| Status | string | Status penguraian file. Nilai valid:
| PARSE_SUCCESS |
| ParseErrorMessage | string | Error Message | |
| Tags | array | Daftar tag yang terkait dengan file. Dokumen dapat dikaitkan dengan beberapa tag. | |
string | Tag file. | tag-A | |
| HasNext | boolean | Menunjukkan apakah ada halaman berikutnya dari data kategori yang sesuai dengan kondisi kueri. Nilai valid:
| true |
| MaxResults | integer | Jumlah entri per halaman untuk paging. | 20 |
| NextToken | string | Token pagination yang dikembalikan oleh panggilan ini. | 4jzbJk9J6lNeuXD9hP0viA== |
| TotalCount | integer | Jumlah total entri dalam hasil yang dikembalikan. | 48 |
| Message | string | Paket kesalahan. | Requests throttling triggered. |
| RequestId | string | ID permintaan. | 8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1 |
| Status | string | Kode status yang dikembalikan oleh operasi. | 200 |
| Success | boolean | Menunjukkan apakah operasi berhasil. Nilai valid:
| true |
Contoh
Respons sukses
JSONformat