Standar API dan SDK siap pakai dalam berbagai bahasa
Spesifikasi OpenAPI produk ini (bailian/2023-12-29) mematuhi standar ROA. Alibaba Cloud menyediakan SDK siap pakai untuk berbagai bahasa pemrograman populer guna mengabstraksi kompleksitas tingkat rendah seperti request signing. Hal ini memungkinkan developer untuk memanggil API menggunakan sintaks khusus tanpa perlu menangani detail HTTP secara langsung.
Signature kustom
Jika SDK tidak mendukung kebutuhan spesifik Anda, seperti signature kustom, Anda harus menandatangani request secara manual menggunakan signature mechanism. Perhatikan bahwa proses penandatanganan manual memerlukan upaya yang signifikan (estimasi 5 hari kerja). Untuk mendapatkan dukungan, bergabunglah dengan grup DingTalk kami (ID: 147535001692).
Sebelum Anda mulai
Akun Alibaba Cloud memiliki hak administratif penuh. Jika pasangan AccessKey dikompromikan, semua resource terkait dapat terekspos terhadap akses tidak sah, sehingga menimbulkan risiko keamanan yang signifikan. Buat Resource Access Management (RAM) user dengan akses khusus API dan gunakan kebijakan RAM untuk menerapkan principle of least privilege (PoLP). Gunakan akun Alibaba Cloud hanya jika benar-benar diperlukan.
Untuk memanggil API secara aman, konfigurasikan hal berikut:
- Akun RAM user
- Pasangan AccessKey untuk akun tersebut
Koneksi data (sebelumnya data aplikasi)
API | Judul | Deskripsi |
|---|---|---|
| AddCategory | Tambah Kategori | Buat sebuah kategori dalam ruang bisnis yang ditentukan untuk mengklasifikasikan dan mengelola file. Setiap ruang bisnis dapat membuat maksimal 500 kategori. |
| ListCategory | Daftar Kategori | Menanyakan detail satu atau beberapa kategori di bawah ruang kerja yang ditentukan. |
| DeleteCategory | Hapus Kategori | Menghapus kategori tertentu secara permanen. |
| ApplyFileUploadLease | Mengajukan lease upload file | Mengajukan lease upload untuk mengunggah file basis pengetahuan atau file untuk interaksi percakapan aplikasi agen. |
| AddFile | Tambah File. | Mengimpor file dari penyimpanan sementara Alibaba Studio Model Studio ke koneksi data Alibaba Studio Model Studio (sebelumnya dikenal sebagai data aplikasi). |
| AddFilesFromAuthorizedOss | Mengimpor file dari bucket OSS yang telah diotorisasi. | Mengimpor file dari bucket OSS yang telah diotorisasi ke dalam data aplikasi Alibaba Cloud Studio Model. |
| ListFile | Daftar File | Mengambil detail satu atau beberapa dokumen dalam kategori tertentu. |
| DescribeFile | Kueri Status File | Mengkueri informasi dasar file di data aplikasi, termasuk nama file, tipe, dan status. |
| UpdateFileTag | Perbarui Tag File | Memperbarui tag file tertentu. |
| BatchUpdateFileTag | Pembaruan Batch Tag Dokumen | Membarui tag dokumen secara batch dalam koneksi data. |
| DeleteFile | Menghapus File | Menghapus secara permanen file tertentu di Application Data. Menghapus tabel data melalui API tidak didukung. Untuk detail, lihat deskripsi API di bawah ini. |
| DeleteFiles | Menghapus File Secara Batch | Menghapus file secara batch. |
| GetParseSettings | Get Category Parsing Settings | Mengkueri pengaturan penguraian data kategori tertentu. |
| GetAvailableParserTypes | Tipe parser yang didukung untuk file | Mengambil daftar semua tipe parser yang didukung berdasarkan tipe file (ekstensi nama file) yang ditentukan. |
| ChangeParseSetting | Ubah pengaturan penguraian kategori. | Mengonfigurasi metode penguraian untuk tipe file tertentu. Misalnya, menentukan penguraian dokumen model tingkat tinggi untuk file .pdf atau penguraian Qwen VL untuk file .jpg. |
| AddTable | AddTable | Menambahkan tabel untuk konektor data tabel. |
| UpdateTableFromAuthorizedOss | Memperbarui Tabel dari Bucket OSS yang Telah Diotorisasi | Memperbarui tabel dalam konektor tabel pada koneksi data Alibaba Cloud Studio Model (Bailian) menggunakan file dari Bucket OSS yang telah diotorisasi. |
| AddConnector | Membuat konektor | Membuat konektor. Operasi ini hanya mendukung pembuatan konektor bertipe file. |
| GetConnector | Mengambil Informasi Connector | Mengambil informasi connector. Saat ini, operasi ini hanya mendukung pengambilan informasi file connector. |
| UpdateConnector | Edit Konektor | Edit Konektor |
Basis pengetahuan
API | Judul | Deskripsi |
|---|---|---|
| CreateIndex | Membuat basis pengetahuan | Membuat basis pengetahuan, baik basis pengetahuan tidak terstruktur berdasarkan dokumen atau audio/video, maupun basis pengetahuan terstruktur untuk kueri data atau tanya jawab berbasis gambar. |
| GetIndexJobStatus | Kueri Status Pekerjaan Basis Pengetahuan. | Mengkueri status saat ini dari tugas pembuatan basis pengetahuan atau tugas penambahan dokumen basis pengetahuan tertentu. |
| SubmitIndexJob | Mengirimkan Tugas Pembuatan Basis Pengetahuan | Mengirimkan tugas CreateIndex tertentu untuk menyelesaikan pembuatan basis pengetahuan. |
| SubmitIndexAddDocumentsJob | Mengirimkan tugas penambahan basis pengetahuan | Menambahkan file yang telah diparsing ke basis pengetahuan tertentu. |
| Retrieve | Mengambil Basis Pengetahuan | Mengambil informasi dari basis pengetahuan yang ditentukan. |
| ListIndexDocuments | Mengkueri File dalam Basis Pengetahuan. | Mengambil file dan informasi ringkasannya dari basis pengetahuan tertentu. |
| ListIndexFileDetails | Mengkueri detail file dalam basis pengetahuan. | Mengambil file dalam basis pengetahuan tertentu beserta detailnya. |
| DeleteIndexDocument | Menghapus file dari knowledge base | Menghapus file secara permanen dari knowledge base tertentu. |
| ListIndices | Daftar Basis Pengetahuan | Mengambil daftar basis pengetahuan di ruang kerja tertentu. |
| DeleteIndex | Menghapus Basis Pengetahuan | Menghapus secara permanen basis pengetahuan tertentu. |
| ListChunks | Mengkueri Daftar Chunk pada Indeks | Mengkueri daftar dan informasi chunk teks. |
| UpdateChunk | Memperbarui chunk | Mengubah konten dan judul chunk teks tertentu di Basis pengetahuan, serta menentukan apakah chunk tersebut berpartisipasi dalam Pengambilan Basis pengetahuan. |
| DeleteChunk | Hapus chunk | Menghapus chunk teks tertentu dari basis pengetahuan. Chunk teks yang dihapus tidak dapat diambil atau dipanggil kembali. |
Rekayasa prompt
API | Judul | Deskripsi |
|---|---|---|
| CreatePromptTemplate | Membuat Templat Prompt | Membuat templat prompt. |
| GetPromptTemplate | Get Prompt Template | Mengambil templat prompt berdasarkan ID templat. |
| UpdatePromptTemplate | Memperbarui Templat Prompt | Memperbarui templat prompt secara inkremental berdasarkan ID templat. |
| DeletePromptTemplate | Hapus Templat Prompt | Menghapus templat prompt berdasarkan ID templat. |
| ListPromptTemplates | Daftar Templat Prompt | Mengambil daftar templat prompt. |
Lainnya
API | Judul | Deskripsi |
|---|---|---|
| CreateMemory | Membuat memori jangka panjang | Membuat memori jangka panjang. |
| GetMemory | Retrieve long-term memory | Mengambil deskripsi memori jangka panjang tertentu. |
| UpdateMemory | Update long-term memory | Memperbarui deskripsi memori jangka panjang tertentu. |
| DeleteMemory | Hapus Memori Jangka Panjang | Menghapus memori jangka panjang tertentu secara permanen. |
| ListMemories | Daftar Memori Jangka Panjang | Mengambil detail satu atau beberapa entitas memori jangka panjang di ruang kerja tertentu. |
| CreateMemoryNode | Membuat Node Memori | Membuat node memori. |
| GetMemoryNode | Mengambil Fragmen Memori | Mengambil fragmen memori. |
| UpdateMemoryNode | Memperbarui Fragmen Memori | Memperbarui fragmen memori. |
| DeleteMemoryNode | Menghapus Fragmen Memori | Menghapus fragmen memori. |
| ListMemoryNodes | Mengambil daftar node memori | Mengambil daftar node memori. |
| ApplyTempStorageLease | Meminta lease unggah file sementara | Meminta lease unggah file sementara. Operasi ini hanya digunakan untuk penerapan pro-code dan tidak didukung dalam skenario lain. Setelah mendapatkan lease, Anda harus menyelesaikan unggahan file sendiri. |
Others
API | Judul | Deskripsi |
|---|---|---|
| AddChunk | Tambahkan chunk. | Menambahkan chunk ke basis pengetahuan pencarian dokumen (document), kueri data (table), atau tanya jawab gambar (image). |