AddFilesFromAuthorizedOss - Alibaba Cloud Model Studio - Alibaba Cloud Documentation Center

Mengimpor file dari bucket OSS yang telah diotorisasi ke dalam data aplikasi Alibaba Cloud Studio Model.

Deskripsi operasi

Pastikan bucket OSS berada di bawah akun Alibaba Cloud yang sama dengan Konsol Studio Model dan otorisasi telah selesai dilakukan seperti yang dijelaskan dalam Petunjuk konfigurasi impor data dari OSS.
- Jenis penyimpanan bucket yang didukung tidak mencakup Archive, Penyimpanan Arsip Dingin, atau Deep Cold Archive. Bucket dengan enkripsi konten yang diaktifkan didukung. Bucket dengan akses baca/tulis publik, baca publik, atau privat didukung.
- Untuk menggunakan bucket dengan Perlindungan hotlink berbasis Referer yang diaktifkan, tambahkan nama domain *.console.aliyun.com ke Daftar putih Referer seperti yang dijelaskan dalam Mengizinkan akses hanya dari situs web tepercaya.
Pengguna Resource Access Management (RAM) harus terlebih dahulu memperoleh izin API untuk Studio Model (izin AliyunBailianDataFullAccess diperlukan, yang mencakup izin sfm:AddFilesFromAuthorizedOss) dan bergabung dengan ruang kerja sebelum memanggil operasi ini. Akun Alibaba Cloud dapat memanggil operasi ini secara langsung tanpa otorisasi. Panggil operasi ini dengan menggunakan SDK Studio Model terbaru .
Operasi ini tidak memiliki idempotensi.

Batas laju: Operasi ini akan dibatasi jika dipanggil terlalu sering. Jangan melebihi 5 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:AddFilesFromAuthorizedOss

create

*All Resource

*

None

Sintaks permintaan

POST /{WorkspaceId}/datacenter/file/fromoss HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	ID ruang kerja. File diimpor ke dalam ruang kerja ini. Untuk informasi lebih lanjut tentang cara memperoleh ID ruang kerja, lihat Cara menggunakan ruang kerja.	llm-3z7uw7fwz0vxxxx

Parameter permintaan

Parameter	Type	Required	Description	Example
CategoryId	string	Yes	ID kategori tempat file diimpor. Ini adalah `CategoryId` yang dikembalikan oleh operasi AddCategory. Anda juga dapat memperoleh ID kategori dengan mengklik ikon ID di sebelah nama kategori pada tab Data Aplikasi - File. Anda dapat memasukkan `default` untuk menggunakan kategori default yang dibuat sistem.	cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx
CategoryType	string	Yes	Tipe kategori. Opsional. Nilai default: UNSTRUCTURED. Nilai valid: UNSTRUCTURED: kategori untuk membangun skenario basis pengetahuan. Valid values: UNSTRUCTURED : UNSTRUCTURED.	UNSTRUCTURED
OssRegionId	string	Yes	ID wilayah bucket OSS. Untuk informasi lebih lanjut, lihat Wilayah dan endpoint OSS.	cn-beijing
OssBucketName	string	Yes	Nama bucket OSS. Untuk informasi lebih lanjut, lihat Bucket.	bucketNamexxxxx
FileDetails	array<object>	Yes	Daftar file yang akan diimpor. Maksimal 10 file dapat diunggah sekaligus. Catatan Maksimal 10 file dapat diunggah sekaligus.
	array<object>	Yes	Objek file.
FileName	string	Yes	Nama file yang akan diimpor. Nama file harus menyertakan ekstensi format file. Format yang didukung: pdf, docx, doc, txt, md, pptx, ppt, xlsx, xls, html, png, jpg, jpeg, bmp, dan gif. Panjang nama file harus antara 4 hingga 128 karakter. Untuk persyaratan dan batas pengunggahan file, lihat Kuota dan batas basis pengetahuan. Penting Jika nama file yang diimpor sama dengan file yang sudah ada di basis pengetahuan, operasi tetap mengembalikan `Status` `SUCCESS`, tetapi file tidak benar-benar diimpor. File yang sudah ada dengan nama yang sama tetap tidak berubah. Pastikan setiap nama file yang diimpor unik. Catatan Untuk membuat tabel data dan mengunggah data, gunakan Konsol Studio Model. Hal ini tidak didukung melalui API.	this_is_temp_xxxx.pdf
OssKey	string	Yes	Kunci file di bucket OSS. Untuk informasi lebih lanjut, lihat Konvensi penamaan objek.	root/path/this_is_temp_xxxx.pdf
Parser	string	No	Tipe parser. Nilai valid: DOCMIND: penguraian dokumen cerdas. DOCMIND_DIGITAL: penguraian dokumen elektronik. DOCMIND_LLM_VERSION: penguraian dokumen berbasis LLM. DASH_QWEN_VL_PARSER: penguraian Qwen VL. DOCMIND_LLM_VERSION_MEDIA: penguraian audio dan video. AUTO_SELECT: pemilihan parser otomatis. Catatan File yang diunggah diurai menggunakan parser yang ditentukan. Jika Anda menetapkan parameter ini ke AUTO_SELECT, parser yang dikonfigurasi untuk kategori tersebut akan digunakan.	AUTO_SELECT
ParserConfig	object	No	Konfigurasi parser. Parameter ini diperlukan hanya ketika tipe parser diatur ke penguraian Qwen VL.
ModelName	string	No	Nama model.	qwen-vl-max
ModelPrompt	string	No	Prompt yang digunakan saat memanggil penguraian Qwen VL.	#角色你是一个专业的图片内容标注人员，擅长识别并描述出图片中的内容。 # 任务目标请结合输入图片，详细描述图片中的内容。
Tags	array	No	Daftar tag yang terkait dengan file. Nilai default: kosong, yang berarti file tidak terkait dengan tag apa pun. Maksimal 10 tag dapat ditentukan.
	string	No	Tag file. Setiap tag dapat memiliki panjang hingga 12 karakter dan mendukung karakter dalam kategori huruf Unicode (termasuk huruf Inggris, karakter Tiongkok, dan digit), garis bawah (_), dan tanda hubung (-).	产品介绍
OverWriteFileByOssKey	boolean	No	Apakah akan menimpa file dengan OssKey yang sama di kategori. Nilai default: false, yang berarti file tidak ditimpa.	false

Elemen respons

Element	Type	Description	Example
	object	Skema Respons.
Code	string	Kode kesalahan.	success
Data	object	Bidang data yang dikembalikan oleh operasi.
AddFileResultList	array<object>	Daftar hasil impor file.
	object	Daftar hasil impor file.
FileId	string	The file ID. Please keep this value safe, as it will be used for all subsequent API operations related to this file.	file_809f469a59ac449586ec692576xxxxx_102248XXX
OssKey	string	The key name (Key) of the imported file in the OSS Bucket.	root/path/this_is_temp_xxxx.pdf
Status	string	File import status. Possible values: SUCCESS: Import (application data) completed. FAILED: Import (application data) failed. Catatan Only files with the SUCCESS status can be used to create or update knowledge bases.	SUCCESS
Msg	string	Error information returned when file import fails.	size too large
Message	string	Pesan kesalahan.	Cant find out category for category_id param.
RequestId	string	ID permintaan.	17204B98-xxxx-4F9A-8464-2446A84821CA
Status	string	Kode status yang dikembalikan oleh operasi.	200
Success	string	Apakah panggilan berhasil. Nilai valid: true: Berhasil. false: Gagal.	true

Contoh

Respons sukses

JSONformat

{
  "Code": "success",
  "Data": {
    "AddFileResultList": [
      {
        "FileId": "file_809f469a59ac449586ec692576xxxxx_102248XXX",
        "OssKey": "root/path/this_is_temp_xxxx.pdf",
        "Status": "SUCCESS",
        "Msg": "size too large"
      }
    ]
  },
  "Message": "Cant find out category for category_id param.",
  "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.