Mengkueri informasi dasar file di data aplikasi, termasuk nama file, tipe, dan status.
Deskripsi operasi
- Pengguna RAM harus terlebih dahulu mendapatkan izin API untuk Studio Model (
AliyunBailianDataFullAccessatauAliyunBailianDataReadOnlyAccess, yang keduanya mencakup izin sfm:DescribeFile), 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. - Operasi ini bersifat idempoten.
Pembatasan kecepatan: Operasi ini akan dibatasi kecepatannya jika dipanggil terlalu sering. Jangan melebihi 10 panggilan per detik. Jika kecepatan 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
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:DescribeFile | none | *全部资源
| None | None |
Sintaks permintaan
GET /{WorkspaceId}/datacenter/file/{FileId}/ HTTP/1.1
Path Parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WorkspaceId | string | Yes | ID ruang kerja tempat file berada. Untuk informasi selengkapnya tentang cara mendapatkan ID ruang kerja, lihat Cara menggunakan ruang kerja. | llm-3shx2gu255oqxxxx |
| FileId | string | Yes | ID file, yaitu | file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx |
Parameter permintaan
Parameter | Type | Required | Description | Example |
|---|
Tidak ada parameter yang diperlukan.
Elemen respons
Element | Type | Description | Example |
|---|---|---|---|
object | Skema Tanggapan. | ||
| Code | string | Kode status error. | Success |
| Data | object | Bidang data yang dikembalikan oleh operasi. | |
| CategoryId | string | ID kategori tempat file berada. | cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx |
| CreateTime | string | Stempel waktu saat file ditambahkan ke Studio Model. Format: yyyy-MM-dd HH:mm:ss. Zona waktu: UTC+8. | 2024-09-09 12:45:43 |
| FileId | string | ID file. | file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx |
| FileName | string | Nama file. | XXX产品介绍.pdf |
| FileType | string | Tipe file (ekstensi). Nilai yang mungkin: pdf, docx, doc, txt, md, pptx, ppt, xlsx, xls, html, png, jpg, jpeg, bmp, dan gif. | |
| Parser | string | Tipe parser yang digunakan untuk mengurai file. Nilai yang mungkin:
| DASHSCOPE_DOCMIND |
| SizeInBytes | integer | Ukuran file, dalam byte. | 1234 |
| Status | string | Untuk file yang digunakan di Basis pengetahuan tidak terstruktur (tipe: UNSTRUCTURED), nilai yang mungkin:
| PARSE_SUCCESS |
| Tags | array | Daftar tag yang terkait dengan file. Sebuah file dapat dikaitkan dengan beberapa tag. | |
string | Tag file. | 产品介绍 | |
| ParseResultDownloadUrl | string | ||
| ParseErrorMessage | string | Penyebab kegagalan Penguraian. | Error Message |
| Message | string | Paket error. | Requests throttling triggered. |
| RequestId | string | ID permintaan. | 17204B98-xxxx-4F9A-8464-2446A84821CA |
| Status | string | Kode status yang dikembalikan oleh operasi. | 200 |
| Success | boolean | Apakah panggilan berhasil. Nilai valid:
| true |
Contoh
Respons sukses
JSONformat
{
"Code": "Success",
"Data": {
"CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx",
"CreateTime": "2024-09-09 12:45:43",
"FileId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx",
"FileName": "XXX产品介绍.pdf",
"FileType": "pdf",
"Parser": "DASHSCOPE_DOCMIND",
"SizeInBytes": 1234,
"Status": "PARSE_SUCCESS",
"Tags": [
"产品介绍"
],
"ParseResultDownloadUrl": "",
"ParseErrorMessage": "Error Message"
},
"Message": "Requests throttling triggered.",
"RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
"Status": "200",
"Success": true
}
Kode kesalahan
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.