Alibaba Cloud Model Studio:Plugin kustom

Langkah 1: Buat plugin

1. Buka halaman Plugins dan klik Create Plugin.

2. Masukkan informasi plugin.

   Plug-in Name: Masukkan nama deskriptif. Mendukung bahasa Tiongkok dan Inggris. Contoh: Dormitory Agreement Query Tool Test

   Plug-in Description: Jelaskan secara singkat fitur dan tujuan plugin dalam bahasa alami. Deskripsi ini membantu model memutuskan kapan harus menggunakan plugin tersebut. Contoh: Menanyakan konten entri perjanjian asrama tertentu berdasarkan indeks numerik yang dimasukkan.

   Plug-in URL: Titik akhir akses plugin. Contoh:https://domitorgreement-plugin-example-icohrkdjxy.cn-beijing.fcapp.run Model Studio memperlakukan path berbeda di bawah domain yang sama sebagai API berbeda. Path-path ini sesuai dengan Tool Path yang Anda konfigurasikan saat membuat tool. Tool dalam satu plugin berbagi nama domain yang sama, tetapi masing-masing path tool memetakan ke API unik. Sebagai contoh, sebuah plugin berisi dua API: Query: https://xxx.com/query Delete: https://xxx.com/delete Pada contoh ini, https://xxx.com adalah Plug-in URL, sedangkan /query dan /delete adalah nilai Tool Path. Hal ini menunjukkan bahwa plugin tersebut berisi dua tool.

   Jika autentikasi diperlukan, aktifkan sakelar Enable Authentication dan masukkan pengaturan autentikasi.

   Parameter autentikasi

   Headers (Opsional)	Jika autentikasi diperlukan, Anda dapat mengirimkan informasi autentikasi dalam header kustom.
   Enable Authentication (Opsional)	Menentukan apakah aplikasi harus menyediakan autentikasi untuk memanggil plugin kustom Anda. Hal ini bergantung pada kebijakan keamanan penyedia API Anda.
   Authentication Type	Terdapat dua metode autentikasi: service-level authentication dan user-level authentication. Location: Anda dapat menempatkan informasi autentikasi di header permintaan atau string kueri. Header: Opsi ini menempatkan informasi autentikasi di header Authorization permintaan HTTP, sehingga tidak terlihat di URL. Query: Opsi ini menempatkan informasi autentikasi di URL. Contohnya: https://example.com?api_key=123456. Parameter Name: Jika Anda menempatkan informasi autentikasi di string kueri, tentukan nama parameter yang digunakan untuk autentikasi, seperti api_key. Jika ditempatkan di header, parameter default-nya adalah Authorization. Type: basic: Tidak menambahkan awalan apa pun ke token yang Anda berikan. bearer: Menambahkan awalan Bearer ke token. appcode: Menambahkan awalan APPCODE ke token. Awalan tersebut disertakan dalam bidang autentikasi. Misalnya, jika Anda memilih bearer, header Authorization menjadi Authorization: Bearer <YOUR_TOKEN>. Token (untuk service-level authentication): Token otentikasi dari penyedia API, seperti Kunci API.

3. Setelah formulir selesai diisi, klik Confirm Create Plug-in > Create Tool atau klik Continue to Add Tool.

Langkah 2: Buat tool

1. Masukkan informasi tool, konfigurasikan parameter input dan output, serta definisikan pengaturan lanjutan jika diperlukan.

   Pada contoh ini, masukkan "Dormitory Rules Query Tool" untuk Tool Name dan "Menanyakan konten aturan asrama tertentu berdasarkan indeks numerik yang dimasukkan" untuk Tool Description. Atur Tool Path menjadi /article, pilih POST untuk Request Method, dan pilih application/json untuk Submission Method. Untuk parameter input, atur nama parameter menjadi article_index, deskripsi parameter menjadi "index", dan tipe menjadi Number. Parameter ini dikirimkan dalam Body, bersifat wajib, dan metode pengirimannya adalah LLM recognition. Untuk parameter output, atur nama parameter menjadi article, deskripsi parameter menjadi "konten aturan asrama", dan tipe menjadi String. Pada pengaturan lanjutan, kueri input pengguna adalah "Tanyakan konten aturan asrama yang sesuai berdasarkan nilai indeks yang dimasukkan", dan nilai parameter input article_index adalah 5.

   Parameter tool

   Informasi Alat

   Tool Name	Masukkan nama deskriptif. Mendukung bahasa Tiongkok dan Inggris.
   Tool Description	Deskripsi singkat mengenai fitur dan kasus penggunaan tool tersebut. Hal ini membantu model memutuskan kapan harus memanggil tool. Gunakan bahasa alami dan berikan contoh bila memungkinkan.
   Tool Path	Path relatif terhadap Plug-in URL. Path harus diawali dengan garis miring (/). Sistem akan menambahkan path ini ke Plug-in URL untuk membentuk URL permintaan lengkap.
   Request Method	Pilih GET atau POST sebagai metode permintaan untuk memanggil API.
   Submission Method	Tipe encoding untuk badan permintaan. application/json: Konten badan berupa data berformat JSON. application/x-www-form-urlencoded: Mengkodekan data formulir sebagai pasangan kunci-nilai. Metode encoding ini berlaku untuk permintaan POST. Data formulir dikodekan menjadi pasangan kunci-nilai, dipisahkan dengan tanda ampersand (&), dan kunci dipisahkan dari nilai dengan tanda sama dengan (=). Data kemudian di-URL-encode, yang mengubah karakter khusus menjadi tanda persen (%) diikuti dua digit heksadesimal. Misalnya, spasi dikodekan sebagai %20, & sebagai %26, dan = sebagai %3D. Contoh: name=John Doe&age=25 dikodekan menjadi name=John%20Doe&age=25.

   Konfigurasikan parameter input dan output

   Configure Input Parameters	Klik Add Input Parameter untuk mengonfigurasi parameter.
   	Parameter Name: Gunakan nama deskriptif agar model memahami representasi parameter tersebut. Misalnya, city.
   	Parameter Description: Deskripsi ringkas dan akurat mengenai fungsi parameter input. Hal ini membantu model memahami cara mengambil nilai parameter. Misalnya, untuk parameter bernama date, Anda dapat menjelaskannya sebagai tanggal dan menentukan formatnya, seperti yyyy-MM-dd.
   	Type: Tipe data parameter. Penting Sub-properti tipe Object tidak boleh kosong. Klik ikon di ujung baris objek untuk menambahkan sub-properti.
   	Passing Method: Menentukan cara nilai parameter dikirimkan. Pengaturan ini sangat penting untuk operasi yang benar. LLM Recognition: Model mengekstraksi nilai parameter dari input pengguna. Business Pass-through: Sistem meneruskan nilai parameter langsung dari sumber eksternal tanpa pemrosesan atau modifikasi. Saat Anda memanggil aplikasi menggunakan SDK DashScope atau API HTTP, sistem meneruskan parameter input bertipe business pass-through ke aplikasi melalui biz_params dan user_defined_params. Untuk informasi selengkapnya, lihat Pass parameters to an application.
   Configure Output Parameters	Klik Add Output Parameters dan konfigurasikan parameter tersebut. Semua parameter bersifat wajib. Model menggunakan definisi parameter output untuk memfilter dan menyusun ulang respons API berdasarkan kueri pengguna, lalu mengembalikan jawaban akhir. Seperti parameter input, parameter output harus dijelaskan secara ringkas dan akurat, dengan tingkat nesting minimal. Penting Metode permintaan GET dan POST sama-sama mendukung tipe Object untuk parameter. Namun, sub-properti tipe Object tidak boleh kosong. Klik ikon di ujung baris objek untuk menambahkan sub-properti.

   Konfigurasi lanjutan (Opsional)

   Advanced Configuration	Berikan contoh pemanggilan untuk membantu model menghindari pemanggilan tool yang terlewat atau salah. Jika parameter input kompleks dan model mungkin salah menyusunnya, memberikan contoh dapat meningkatkan akurasi pemanggilan.
   	Value: Menentukan parameter pemanggilan yang diharapkan dihasilkan model dari kueri pengguna. Misalnya, untuk input pengguna "Bagaimana cuaca di Hangzhou besok?", parameter yang diharapkan adalah {"city": "Hangzhou", "date": "2025-04-25"}.

2. Setelah konfigurasi selesai, klik Save Draft.

3. Debug tool secara online untuk memverifikasi bahwa API dapat dipanggil.

   Klik Test Tool. Jika Anda mengaktifkan autentikasi, masukkan informasi autentikasi dan nilai parameter input. Lalu, klik Start Running. Jika eksekusi gagal, sesuaikan konfigurasi berdasarkan pesan error di bagian Run Result dan uji kembali hingga berhasil. Anda dapat memasukkan nilai parameter input secara manual atau sebagai kode. Untuk parameter kompleks, gunakan Code Editing. Di editor kode, Anda dapat mengirimkan parameter input lengkap berformat JSON beserta nilainya.

4. Setelah pengujian berhasil, klik Publish. Aplikasi hanya dapat memanggil tool yang telah Published.

Dapatkan ID tool

ID tool mengidentifikasi tool tertentu. Saat Anda memanggil tool melalui API, Anda harus mengirimkan ID tool yang benar agar sistem dapat mengenali permintaan dengan tepat.

1. Di daftar Plugins, temukan plugin yang berisi tool tersebut dan klik View Details.

2. Arahkan kursor ke ikon di samping nama tool.

3. Klik ikon untuk menyalin ID tool.