Mengajukan lease upload untuk mengunggah file basis pengetahuan atau file untuk interaksi percakapan aplikasi agen.
Deskripsi operasi
- Pengguna RAM (sub-akun) harus terlebih dahulu mendapatkan izin API untuk Alibaba Cloud Model Studio (memerlukan
AliyunBailianDataFullAccess, yang mencakup izin sfm:ApplyFileUploadLease), dan bergabung dengan workspace sebelum memanggil API ini. Akun Alibaba Cloud (akun utama) dapat langsung memanggil API ini tanpa otorisasi. Kami menyarankan Anda memanggil API ini menggunakan SDK Alibaba Cloud Model Studio terbaru. - API ini tidak idempoten.
Pembatasan laju: API ini akan dibatasi jika dipanggil terlalu sering. Frekuensi tidak boleh melebihi 10 panggilan per detik. Jika dibatasi, silakan 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:ApplyFileUploadLease | none | *全部资源
| None | None |
Sintaks permintaan
POST /{WorkspaceId}/datacenter/category/{CategoryId} HTTP/1.1
Path Parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| CategoryId | string | Yes | Saat mengunggah file untuk membangun basis pengetahuan:
Untuk membuat tabel data baru dan mengunggah data, gunakan konsol Alibaba Cloud Model Studio. Ini tidak didukung melalui API.
| cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx |
| WorkspaceId | string | Yes | ID workspace tempat file yang diunggah berada. Untuk informasi tentang cara mendapatkan ID workspace, lihat Cara menggunakan workspace. | llm-3z7uw7fwz0vexxxx |
Parameter permintaan
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| FileName | string | Yes | Saat mengunggah file untuk membangun basis pengetahuan:
Untuk membuat tabel data baru dan mengunggah data, gunakan konsol Alibaba Cloud Model Studio. Ini tidak didukung melalui API. | XXXX产品清单.pdf |
| Md5 | string | Yes | Nilai MD5 dari file yang diunggah. Server akan memverifikasi field ini (saat ini belum diaktifkan). Harap isi dengan nilai yang benar. | 19657c391f6c70bcea63c154d8606bb3 |
| SizeInBytes | string | Yes | Ukuran file yang diunggah dalam byte. Server akan memverifikasi field ini (saat ini belum diaktifkan). Harap isi dengan nilai yang benar. Nilai yang valid: 1 B hingga 100 MB. | 1000 |
| CategoryType | string | No | Jenis kategori. Jika parameter ini tidak ditentukan, nilai defaultnya adalah UNSTRUCTURED. Nilai yang valid: UNSTRUCTURED: kategori untuk skenario pembangunan basis pengetahuan. SESSION_FILE: mengunggah file untuk interaksi percakapan aplikasi agen. Untuk membuat tabel data baru dan mengunggah data, gunakan konsol Alibaba Cloud Model Studio. Ini tidak didukung melalui API. | UNSTRUCTURED |
| UseInternalEndpoint | boolean | No | Jika Anda telah mengaktifkan penyimpanan aman Alibaba Cloud Model Studio dan perlu menghasilkan URL lease yang hanya dapat diakses dari jaringan internal Alibaba Cloud di region yang sama, Anda dapat mengatur parameter ini ke true untuk meningkatkan keamanan. Jika parameter ini tidak ditentukan, nilai defaultnya adalah false, yang menghasilkan URL lease yang dapat diakses secara publik. Jika Anda belum mengaktifkan penyimpanan aman Alibaba Cloud Model Studio, atau tidak yakin apakah Anda menggunakannya, jangan atur parameter ini ke true (upload akan gagal). | false |
Elemen respons
Element | Type | Description | Example |
|---|---|---|---|
object | Skema Respons | ||
| Code | string | Kode error. | DataCenter.FileTooLarge |
| Data | object | Data yang dikembalikan. | |
| FileUploadLeaseId | string | ID unik dari lease. Anda perlu menggunakan parameter ini saat memanggil API AddFile. | 1e6a159107384782be5e45ac4759b247.1719325231035 |
| Param | object | Parameter permintaan HTTP untuk mengunggah file. | |
| Headers | any | Pasangan kunci-nilai yang akan disertakan dalam header permintaan HTTP. Baik kunci maupun nilai berupa string. Content-Type yang dikembalikan mungkin kosong. Gunakan nilai kosong tersebut apa adanya saat mengunggah. | "X-bailian-extra":"MTAwNTQyNjQ5NTE2OTE3OA==", "Content-Type":"application/pdf" |
| Method | string | Metode HTTP. Nilai valid:
| PUT |
| Url | string | URL unggah untuk file. URL ini adalah URL yang ditandatangani. URL ini tidak mendukung unggahan FormData. Gunakan unggahan biner sebagai gantinya. | |
| Type | string | Metode upload file. Nilai yang valid:
| HTTP |
| Message | string | Pesan error. | User not authorized to operate on the specified resource |
| RequestId | string | ID permintaan. | 778C0B3B-xxxx-5FC1-A947-36EDD13606AB |
| Status | string | Kode status yang dikembalikan. | 200 |
| Success | boolean | Menunjukkan apakah panggilan API berhasil. Nilai yang valid:
| true |
Contoh
Respons sukses
JSONformat
{
"Code": "DataCenter.FileTooLarge",
"Data": {
"FileUploadLeaseId": "1e6a159107384782be5e45ac4759b247.1719325231035",
"Param": {
"Headers": "\"X-bailian-extra\":\"MTAwNTQyNjQ5NTE2OTE3OA==\",\n\"Content-Type\":\"application/pdf\"",
"Method": "PUT",
"Url": "https://bailian-datahub-data-origin-prod.oss-cn-hangzhou.aliyuncs.com/1005426495169178/10024405/68abd1dea7b6404d8f7d7b9f7fbd332d.1716698936847.pdf?Expires=1716699536&OSSAccessKeyId=YOUR_ACCESS_KEY_ID&Signature=YOUR_SIGNATURE"
},
"Type": "HTTP"
},
"Message": "User not authorized to operate on the specified resource",
"RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
"Status": "200",
"Success": true
}
Kode kesalahan
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.