全部产品
Search
文档中心

Alibaba Cloud Model Studio:Plugin kustom

更新时间:Dec 26, 2025

Jika plugin resmi di Alibaba Cloud Model Studio tidak memenuhi kebutuhan bisnis Anda, Anda dapat membuat plugin kustom untuk memperluas kemampuan model bahasa besar (LLM). Dokumen ini memandu Anda melalui proses pembuatan, debugging, dan penggunaan plugin guna mengintegrasikan API yang diperlukan.

Alur Kerja

  1. Create a plugin: Definisikan informasi dasar plugin.

  2. Add a tool: Konfigurasikan path API, parameter permintaan, dan data respons untuk plugin tersebut.

  3. Debug and publish: Uji konektivitas API secara online dan publikasikan tool setelah memastikan berfungsi dengan benar.

  4. Use in an application: Kaitkan plugin dengan agen dan panggil melalui pengujian percakapan atau integrasi API.

Buat plugin kustom

Buat plugin hasil pengembangan kustom

Langkah 1: Buat plugin

  1. Buka halaman Plug-ins, lalu klik Create Plug-in.

    image

  2. Masukkan informasi plugin.

    image

    Plug-in Name: Masukkan nama deskriptif. Anda dapat menggunakan karakter Tionghoa dan Inggris.

    Contoh: Dormitory Agreement Query Tool Test

    Plug-in Description: Masukkan deskripsi singkat tentang fitur dan skenario penggunaan plugin. Deskripsi ini membantu LLM menentukan apakah akan memanggil plugin untuk tugas saat ini. Gunakan bahasa alami dalam deskripsi tersebut.

    Contoh: Mengkueri konten entri perjanjian asrama tertentu berdasarkan indeks numerik yang dimasukkan.

    Plug-in URL: Titik akhir (endpoint) plugin.

    Contoh:https://domitorgreement-plugin-example-icohrkdjxy.cn-beijing.fcapp.run
    • Untuk nama domain yang sama, path berbeda dianggap sebagai API berbeda. Path-path ini sesuai dengan Tool Path yang Anda konfigurasikan saat membuat tool.

    • Tool-tool berbeda dalam satu plugin menggunakan nama domain yang sama. Path tool masing-masing bersesuaian dengan API terpisah.

      Sebagai contoh, sebuah plugin berisi dua API:

      Query: https://xxx.com/query

      Delete: https://xxx.com/delete

      Dalam contoh ini, https://xxx.com adalah Plug-in URL. /query dan /delete bersesuaian dengan Tool Path. Hal ini menunjukkan bahwa plugin tersebut berisi dua tool.

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

    Deskripsi parameter autentikasi

    Headers (Opsional)

    Jika autentikasi diperlukan, Anda dapat meneruskan informasi autentikasi melalui header kustom.

    Enable Authentication (Opsional)

    Menentukan apakah autentikasi diperlukan ketika aplikasi Model Studio memanggil plugin kustom Anda. Kebutuhan autentikasi bergantung pada kebijakan keamanan penyedia API.

    Authentication Type

    Metode autentikasi terdiri dari Service-level Authentication dan User-level Authentication.

    • Location: Anda dapat menempatkan informasi autentikasi di Header atau kueri.

      • Header: Tempatkan informasi autentikasi di bidang Authorization pada Header permintaan HTTP. Informasi ini tidak terlihat di URL.

      • Query: Tempatkan informasi autentikasi di URL. Contohnya: https://example.com?api_key=123456.

    • Parameter Name: Jika Anda menempatkan informasi autentikasi di query, tentukan parameter yang digunakan untuk autentikasi, misalnya "api_key". Jika Anda menempatkannya di header, parameter default-nya adalah "Authorization".

    • Type:

      • basic: Tidak ada konten yang ditambahkan sebelum token yang Anda berikan.

      • bearer: "Bearer" ditambahkan sebelum token.

      • appcode: "APPCODE" ditambahkan sebelum token.

      Kedua jenis tersebut ditentukan dalam parameter autentikasi. Misalnya, jika Anda memilih `bearer`, format pemanggilan plugin-nya adalah `("Authorization": "Bearer <YOUR_TOKEN>")`.

    • Token (Service-level Authentication): Token otentikasi yang diperoleh dari penyedia API, seperti Kunci API.

  3. Setelah memasukkan informasi, 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 atur konfigurasi lanjutan.

    image

    Deskripsi parameter tool

    Informasi tool

    Tool Name

    Masukkan nama deskriptif. Mendukung karakter Tionghoa dan Inggris.

    Tool Description

    Deskripsi singkat tentang fitur dan skenario penggunaan tool.

    Hal ini membantu model besar menentukan apakah akan memanggil tool untuk tugas saat ini. Gunakan bahasa alami dalam deskripsi dan berikan contoh jika memungkinkan.

    Tool Path

    Path relatif terhadap Plug-in URL.

    Path harus diawali dengan garis miring (/).

    Path ini ditambahkan ke Plug-in URL untuk membentuk URL lengkap.

    Request Method

    Pilih metode permintaan GET atau POST sesuai kebutuhan untuk memanggil Operasi API.

    Submission Method

    Tipe encoding untuk permintaan atau respons.

    • application/json: Konten body berupa data dalam format JSON.

    • application/x-www-form-urlencoded: Mengenkoding data formulir menjadi pasangan kunci-nilai.

      • Metode enkoding ini digunakan untuk permintaan POST. Data formulir dienkoding menjadi pasangan kunci-nilai dan dikirim melalui enkoding URL. Beberapa pasangan kunci-nilai dipisahkan oleh tanda ampersand (&). Setiap kunci dan nilai dipisahkan oleh tanda sama dengan (=). Enkoding URL mengubah karakter khusus menjadi tanda persen (%) diikuti dua digit heksadesimal. Misalnya, spasi dienkoding sebagai %20, & sebagai %26, dan = sebagai %3D.

      • Contoh: name=John Doe&age=25 dienkoding menjadi name=John%20Doe&age=25.

    Konfigurasikan parameter input dan output

    Configure Input Parameters

    Klik Add Input Parameter dan konfigurasikan parameter-parameter tersebut.

    Parameter Name: Gunakan nama yang sedeskriptif mungkin untuk membantu LLM memahami informasi parameter apa yang perlu diidentifikasi. Misalnya, gunakan kata bermakna seperti city.

    Parameter Description: Deskripsi singkat dan akurat tentang fungsi parameter input. Hal ini membantu LLM lebih memahami cara mengambil parameter tersebut. Sebagai contoh, untuk parameter date, Anda dapat menjelaskan format tanggalnya, seperti yyyy-MM-dd.

    Type: Tipe parameter.

    Penting

    Sub-properti di bawah tipe Object tidak boleh kosong. Klik ikon image di akhir baris objek untuk menambahkan sub-properti.

    Passing Method: Atur parameter ini secara akurat.

    • LLM Recognition: Nilai parameter perlu diekstraksi dari input pengguna oleh LLM.

    • Business Pass-through: Nilai parameter diteruskan secara aktif dari sumber eksternal. Data tidak diproses atau dimodifikasi selama transmisi.

      Saat Anda memanggil aplikasi menggunakan SDK DashScope atau antarmuka HTTP, parameter input bertipe business pass-through dalam plugin diteruskan ke aplikasi melalui biz_params dan user_defined_params. Untuk informasi selengkapnya, lihat Pass plug-in parameters through an API.

    Configure Output Parameters

    Klik Add Output Parameter dan konfigurasikan parameter-parameter tersebut. Semua parameter bersifat wajib.

    LLM menyaring dan mengatur ulang hasil yang dikembalikan oleh API berdasarkan definisi parameter output dan pertanyaan pengguna. Jawaban akhir kemudian dikembalikan kepada pengguna.

    Seperti halnya parameter input, parameter output harus dideskripsikan secara ringkas dan akurat, dengan tingkat nested sesedikit mungkin.

    Penting

    Baik metode permintaan GET maupun POST mendukung tipe Object untuk parameter. Namun, sub-properti di bawah tipe Object tidak boleh kosong. Klik ikon image di akhir baris objek untuk menambahkan sub-properti.

    Konfigurasi Lanjutan (Opsional)

    Advanced Configuration

    Tambahkan contoh pemanggilan untuk LLM guna mengurangi missed recall dan incorrect recall.

    Fitur ini biasanya digunakan dalam skenario di mana parameter input kompleks dan model rentan melakukan kesalahan konstruksi. Memberikan contoh meningkatkan akurasi LLM dalam memanggil plugin.

    Value: Parameter input pemanggilan yang diharapkan dibangun oleh LLM ketika pengguna memasukkan kueri saat ini. Sebagai contoh, jika pengguna memasukkan "Kueri cuaca di Hangzhou untuk besok", parameter input yang diharapkan adalah {"city": "Hangzhou", "date": "2025-04-25"}.

  2. Setelah konfigurasi selesai, klik Save Draft.

  3. Debug API tool secara online untuk memeriksa apakah tool tersebut dapat dipanggil.

    image

    Klik Test Tool. Jika autentikasi diaktifkan, 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 eksekusi berhasil.

    Anda dapat memasukkan nilai parameter input secara manual atau menggunakan kode. Untuk parameter input yang kompleks, gunakan mode Code Editing. Di editor kode, Anda dapat mengirimkan parameter input lengkap beserta nilainya dalam format JSON.

  4. Setelah pengujian berhasil, klik Publish. Hanya tool yang berstatus Published yang dapat dipanggil dalam aplikasi.

Gunakan plugin

Konsol

  • Method 1: Di daftar Tools, tambahkan tool yang telah dipublikasikan ke aplikasi.

    Tool hanya dapat dikaitkan dengan Agent Application yang berada di ruang kerja yang sama.
    1. Di baris yang berisi tool tersebut, klik Add to Application dan pilih aplikasi target.

    2. Di aplikasi tersebut, Anda dapat melihat bahwa tool telah berhasil ditambahkan.

      Anda juga dapat menambahkan tool lainnya. Anda dapat menambahkan hingga 10 tool. Aplikasi akan menentukan tool mana yang akan dipanggil.
    3. Uji apakah plugin berfungsi sesuai harapan.

      • Tanpa autentikasi: Anda dapat mengobrol dengan LLM di kotak input untuk menguji plugin.

      • Autentikasi tingkat pengguna atau tingkat layanan: Sebelum memulai percakapan, klik image untuk mengonfigurasi token autentikasi yang akan diteruskan. Jika Anda tidak meninggalkan halaman ini, Anda hanya perlu mengonfigurasinya sekali.

      • Jika Passing Method untuk parameter input tool diatur ke Business Pass-through, Anda harus mengklik image untuk mengonfigurasi nilai variabel yang akan diteruskan sebelum memulai percakapan. Jika Anda tidak meninggalkan halaman ini, Anda hanya perlu memasukkan nilainya sekali.

    4. Setelah pengujian selesai, Publish aplikasi tersebut.

  • Method 2: Di daftar Plug-ins, tambahkan tool-tool di bawah plugin ke agen.

    1. Temukan plugin target dan klik Add to Agent.

      Tool hanya dapat dikaitkan dengan Agent Application yang berada di ruang kerja yang sama.
      Secara default, hanya tool yang telah dipublikasikan yang ditambahkan. Anda dapat memilih hingga 10 tool yang telah dipublikasikan untuk ditambahkan ke aplikasi agen.
    2. Ikuti langkah-langkah pada Method 1 untuk menguji plugin di halaman detail aplikasi dan Publish aplikasi tersebut.

  • Method 3: Di Model Studio Applications, tambahkan tool plugin, uji plugin tersebut, dan publish aplikasi.

API

Peroleh ID tool

ID tool mengidentifikasi tool tertentu. Saat Anda memanggil tool menggunakan API, Anda harus meneruskan ID tool yang benar agar permintaan dapat diidentifikasi dengan tepat.

  1. Di daftar Plug-ins, temukan plugin tempat tool tersebut berada dan klik View.

  2. Arahkan pointer mouse ke ikon image di sebelah nama tool.

  3. Klik ikon image untuk menyalin ID tool tersebut.

    image

  • Saat Anda memanggil aplikasi menggunakan API, jika plugin yang terkait dengan aplikasi memiliki parameter business pass-through atau telah mengaktifkan user-level authentication, Anda harus meneruskan informasi autentikasi atau informasi parameter pass-through menggunakan parameter biz_params. Untuk informasi selengkapnya, lihat DashScope API Reference.

Kelola plugin dan tool kustom

Hapus plugin

Penting

Jika Anda menghapus plugin, semua tool di bawah plugin tersebut akan dihapus dan aplikasi yang memanggil plugin tersebut menjadi tidak valid. Operasi ini tidak dapat dibatalkan. Lakukan dengan hati-hati.

Di daftar Plug-ins, temukan plugin target dan klik ... > Delete.

Ubah Plugin

  1. Di daftar Plug-ins, temukan plugin target dan klik View.

  2. Di pojok kanan atas, klik Edit Plug-in, ubah informasi plugin, lalu simpan perubahan.

    Informasi plugin langsung berlaku setelah disimpan. Jika Anda mengubah URL plugin, header, atau informasi autentikasi, pemanggilan tool mungkin terpengaruh. Anda harus menguji dan mempublikasikan ulang tool tersebut.

Alat Pengeditan

Setelah Anda mengubah informasi tool, Anda harus menguji dan mempublikasikan ulang tool tersebut agar perubahan berlaku.

  1. Di daftar Plug-ins, temukan plugin tempat tool tersebut berada dan klik View.

  2. Di baris yang berisi tool tersebut, klik Edit, ubah informasi tool, lalu klik Save Draft.

  3. Klik Test Tool untuk melakukan debugging tool secara online.

  4. Setelah eksekusi berhasil, klik Publish.

Hapus alat

Penting

Jika Anda menghapus tool, aplikasi yang memanggil tool tersebut menjadi tidak valid. Operasi ini tidak dapat dibatalkan. Lakukan dengan hati-hati.

  1. Di daftar Plug-ins, temukan plugin tempat tool tersebut berada dan klik View.

  2. Di baris yang berisi tool tersebut, klik Delete.

Kode error

Tabel berikut menjelaskan pesan error umum yang mungkin muncul saat Anda mempublikasikan tool.

Kode error

Pesan error

Deskripsi

130040

The parameter description for xx is missing.

Penyebab: Deskripsi untuk parameter xx tidak tersedia.

Solusi: Tambahkan deskripsi parameter dan publikasikan ulang tool tersebut.

130022

Failed to save the tool information/Check whether the sample parameters are correct.

Kemungkinan penyebab 1: Sub-properti dari parameter bertipe Object pada parameter input atau output kosong.

Solusi: Klik ikon image di akhir baris objek untuk menambahkan sub-properti.

Kemungkinan penyebab 2: Metode permintaan adalah GET, tetapi parameter input bertipe Object.

Solusi: Metode permintaan GET tidak mendukung tipe Object untuk parameter input. Pilih tipe lainnya.