Skip to main content
Pemanggilan Aplikasi

Transmisi langsung parameter aplikasi kustom

Transmisikan parameter kustom—terutama ke plugin kustom dan node kustom—saat memanggil Agent Application dan Workflow Application Alibaba Cloud Model Studio (yang menggantikan aplikasi orkestrasi agen).

Buat Kunci API dan ekspor kunci API sebagai variabel lingkungan. Jika Anda menggunakan SDK untuk melakukan panggilan, instal DashScope SDK.

Parameter plugin kustom

Artikel ini menggunakan dormitory convention query tool untuk menunjukkan cara pass parameter ke plugin kustom melalui API.
Parameter untuk plugin kustom diteruskan melalui Agent Application atau Workflow Application yang terkait melalui node plugin-nya.
Contoh berikut menunjukkan cara meneruskan parameter plugin kustom untuk Agent Application.

Penggunaan

Langkah 1: Buat plugin kustom

Jika Anda telah membuat tool plugin atau mengimpor plugin, lewati langkah ini.
  1. Buat plugin kustom: Buka halaman Plugins di Konsol Model Studio dan klik Add Custom Plug-in. Masukkan informasi plugin. Jika otentikasi diperlukan, aktifkan sakelar Enable Authentication dan konfigurasikan pengaturannya.
    Deskripsi Plugin Contoh: Menanyakan konvensi asrama dan mencari entri tertentu berdasarkan indeks numerik.
    URL Plugin Contoh: https://domitorgreement-plugin-example-icohrkdjxy.cn-beijing.fcapp.run
    image
    Catatan: Plug-in Description secara singkat merangkum tujuan plugin. Hal ini membantu model besar memutuskan apakah akan memanggil plugin untuk suatu tugas tertentu. Jelaskan dalam bahasa alami.
  2. Buat tool: Isi informasi tool dan konfigurasikan parameter input dan output. Catatan:
    1. Tool Description membantu model besar lebih memahami fungsi dan kasus penggunaan tool tersebut. Gunakan bahasa alami dan berikan contoh jika memungkinkan.
    2. Parameter Name yang deskriptif membantu model besar memahami informasi yang diwakilinya.
    3. Parameter Description menjelaskan fungsi parameter input. Harus ringkas dan akurat agar model besar dapat menentukan nilai yang tepat untuk digunakan.
    4. Anda harus memilih Business Pass-through untuk Passing Method parameter input.
    Dalam contoh ini, indeks konten konvensi asrama, article_index, ditetapkan sebagai parameter transmisi langsung.
    image
  3. Klik Test Tool. Setelah pengujian berhasil, Publish plugin tersebut.

Langkah 2: Asosiasikan plugin dengan agen

Anda hanya dapat mengasosiasikan plugin dengan Agent Application yang berada dalam ruang kerja yang sama.
  1. Pada kartu plugin yang telah dipublikasikan, klik Add to Agent dan pilih aplikasi agen.
  2. Atau, klik + Plugin di dalam aplikasi untuk mengasosiasikan plugin kustom.
  3. Akhirnya, Publish aplikasi tersebut.

Langkah 3: Panggilan API

  • Saat otentikasi tidak diperlukan: Untuk memanggil plugin kustom melalui API, gunakan parameter user_defined_params dari biz_params untuk meneruskan informasi plugin kustom, ganti your_plugin_code dengan ID plugin sebenarnya, dan teruskan pasangan kunci-nilai dari parameter input yang dikonfigurasi di plugin.
    Anda dapat menemukan ID plugin pada kartu plugin.
    Dalam contoh ini, meneruskan nilai 2 ke parameter article_index menanyakan konten konvensi asrama kedua dan mengembalikan hasil yang benar.
    • Python
    • Java
    • HTTP
    Contoh permintaan
    import os
    from http import HTTPStatus
    # Kami merekomendasikan menggunakan DashScope SDK v1.14.0 atau yang lebih baru.
    import dashscope
    from dashscope import Application
    
    dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
    biz_params = {
        # Teruskan parameter input untuk plugin kustom aplikasi agen. Ganti `your_plugin_code` dengan ID plugin Anda.
        "user_defined_params": {
            "your_plugin_code": {
                "article_index": 2}}}
    response = Application.call(
            # Jika variabel lingkungan belum diatur, Anda dapat menggunakan Kunci API Model Studio Anda dengan mengganti baris berikut menjadi api_key="sk-xxx". Kami merekomendasikan penggunaan variabel lingkungan di lingkungan produksi untuk menghindari kebocoran kunci API Anda.
            api_key=os.getenv("DASHSCOPE_API_KEY"),
            app_id='YOUR_APP_ID',
            prompt='Dormitory convention content',
            biz_params=biz_params)
    
    if response.status_code != HTTPStatus.OK:
        print(f'request_id={response.request_id}')
        print(f'code={response.status_code}')
        print(f'message={response.message}')
        print(f'Untuk informasi lebih lanjut, lihat: https://www.alibabacloud.com/help/en/model-studio/developer-reference/error-code')
    else:
        print('%s\n' % (response.output.text))  # Proses dan keluarkan hanya teksnya.
        # print('%s\n' % (response.usage))
    
    Contoh tanggapan
    The second article of the dormitory convention is as follows:
    
    "Roommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere."
    
    This suggests that roommates should foster a positive living and learning environment by supporting and helping each other, while also learning to understand and respect others. If you want to learn about other articles of the convention, just ask!
    
  • Saat otentikasi diperlukan: Skenario ini menjelaskan cara memanggil plugin kustom yang memiliki Authentication diaktifkan dan dikonfigurasi dengan User-level Authentication.
    Anda dapat menemukan ID plugin pada kartu plugin.
    • Gunakan user_defined_params di bidang biz_params untuk meneruskan informasi plugin kustom. Ganti your_plugin_code dengan ID plugin Anda, dan berikan parameter input sebagai pasangan kunci-nilai.
    • Gunakan user_defined_tokens di bidang biz_params untuk meneruskan kredensial otentikasi. Ganti your_plugin_code dengan ID plugin Anda, dan atur nilai user_token ke token otentikasi Anda, seperti kunci API DashScope.
    • Setelah otentikasi berhasil, layanan menanyakan item yang ditentukan berdasarkan parameter indeks yang diberikan dan mengembalikan hasil yang benar.
    Dalam contoh ini, parameter article_index diatur ke 2, dan nilai user_token, YOUR_TOKEN, diganti dengan DASHSCOPE_API_KEY sebenarnya. Setelah otentikasi berhasil, konten aturan asrama kedua ditanyakan, dan hasil yang benar dikembalikan.
    • Python
    • Java
    • HTTP
    Minta contoh
    from http import HTTPStatus
    import os
    # Kami merekomendasikan menggunakan DashScope SDK v1.14.0 atau yang lebih baru.
    import dashscope
    from dashscope import Application
    
    dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
    biz_params = {
        # Teruskan kredensial otentikasi untuk plugin kustom aplikasi agen.
        # Ganti your_plugin_code dengan ID plugin Anda dan YOUR_TOKEN dengan token otentikasi Anda, seperti kunci API.
        "user_defined_params": {
            "your_plugin_code": {
                "article_index": 2}},
        "user_defined_tokens": {
            "your_plugin_code": {
                "user_token": "YOUR_TOKEN"}}}
    response = Application.call(
                # Jika variabel lingkungan belum dikonfigurasi, Anda dapat menggunakan kunci API DashScope dengan mengganti baris berikut menjadi: api_key="sk-xxx".
                # Namun, kami tidak merekomendasikan hardcoding kunci API di lingkungan produksi untuk mengurangi risiko kebocoran kunci.
                api_key=os.getenv("DASHSCOPE_API_KEY"),
                app_id='YOUR_APP_ID',
                prompt='Dormitory convention content',
                biz_params=biz_params)
    
    if response.status_code != HTTPStatus.OK:
        print(f'request_id={response.request_id}')
        print(f'code={response.status_code}')
        print(f'message={response.message}')
        print(f'Untuk informasi lebih lanjut, lihat: https://www.alibabacloud.com/help/en/model-studio/developer-reference/error-code')
    else:
        print('%s\n' % (response.output.text))  # Proses dan keluarkan hanya teksnya.
        # print('%s\n' % (response.usage))
    
    Contoh tanggapan
    The second article of the dormitory convention is as follows:
    
    Roommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere.
    
    If you need to know about other articles of the convention, please let me know.
    

Teruskan parameter node kustom

Topik ini menggunakan contoh Menanyakan pembagian administratif berdasarkan nama kota untuk menunjukkan cara meneruskan parameter node kustom ke aplikasi melalui panggilan API.
Parameter node kustom untuk aplikasi diteruskan melalui node awal Workflow Application.
Contoh berikut menunjukkan cara meneruskan parameter kustom ke node awal dalam Workflow Application.

Penggunaan

Langkah 1: Konfigurasikan parameter node kustom

Buka halaman My Applications di Konsol Model Studio. Pilih Workflow Application dan definisikan parameter kustom untuk start node-nya. Untuk contoh ini, buat variabel String bernama city. Kemudian, masukkan variabel city dan query ke dalam prompt dan Publish aplikasi tersebut.

Langkah 2: Lakukan panggilan API

Saat melakukan panggilan API, teruskan nilai city di bidang biz_params dan nilai query di bidang prompt.
  • Python
  • Java
  • HTTP
contoh permintaan
import os
from http import HTTPStatus
import dashscope
from dashscope import Application
# Teruskan parameter kustom untuk aplikasi alur kerja.

dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
biz_params = {"city": "Hangzhou"}
response = Application.call(
    # Jika Anda belum mengonfigurasi variabel lingkungan, Anda dapat menggunakan Kunci API Model Studio Anda dengan mengganti baris berikut menjadi: api_key="sk-xxx".
    # Kami merekomendasikan agar Anda tidak melakukan hardcoding kunci API di kode Anda di lingkungan produksi untuk mengurangi risiko kebocoran kunci API.
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    app_id='YOUR_APP_ID',  # Ganti dengan ID aplikasi sebenarnya Anda.
    prompt='Query the administrative divisions of this city',
    biz_params=biz_params  # Teruskan parameter bisnis.
)

if response.status_code != HTTPStatus.OK:
    print(f'request_id={response.request_id}')
    print(f'code={response.status_code}')
    print(f'message={response.message}')
    print(f'Untuk informasi lebih lanjut, lihat: https://www.alibabacloud.com/help/en/model-studio/developer-reference/error-code')
else:
    print(f'{response.output.text}')  # Proses dan keluarkan hanya teksnya.
contoh tanggapan
Hangzhou, ibu kota Provinsi Zhejiang, dibagi menjadi 10 distrik kota: Shangcheng, Gongshu, Xihu, Binjiang, Xiaoshan, Yuhang, Linping, Qiantang, Fuyang, dan Lin'an. Setiap distrik memiliki fitur unik dan prioritas pengembangan sendiri.

- Distrik Shangcheng: Terletak di pusat Hangzhou, merupakan salah satu pusat politik, ekonomi, dan budaya kota.
- Distrik Gongshu: Dikenal dengan budaya kanalnya dan banyak situs warisan sejarah dan budaya.
- Distrik Xihu: Rumah bagi kawasan wisata Danau Barat yang terkenal, destinasi wisata utama.
- Distrik Binjiang: Pusat industri teknologi tinggi, tempat perusahaan terkenal seperti Alibaba berlokasi.
- Distrik Xiaoshan: Distrik administratif di tenggara yang dikenal karena perkembangan ekonominya yang pesat, terutama di sektor manufaktur.
- Distrik Yuhang: Berkembang pesat dalam beberapa tahun terakhir, terutama di ekonomi internet. Kantor pusat Alibaba juga berlokasi di sini (Catatan: Kantor pusat Alibaba sebenarnya berada di Distrik Binjiang).
- Distrik Linping: Distrik administratif yang baru dibentuk bertujuan untuk mendorong pengembangan ekonomi dan sosial komprehensif di wilayah tersebut.
- Distrik Qiantang: Juga hasil penyesuaian pembagian administratif baru-baru ini, menekankan pengembangan inovatif dan perlindungan ekologis.
- Distrik Fuyang: Terletak di barat daya Hangzhou, dikenal karena lanskap alamnya yang kaya dan sejarah serta budayanya yang panjang.
- Distrik Lin'an: Terletak di bagian barat Hangzhou, terkenal karena ekologinya yang indah dan warisan budaya yang mendalam.

Catatan bahwa perencanaan perkotaan spesifik dapat berubah seiring waktu. Rujuk informasi resmi terbaru.

Dokumentasi terkait

Plugin kustom: Pelajari cara membuat plugin kustom. Pemanggilan aplikasi: Pelajari cara memanggil aplikasi dan jelajahi lebih banyak kasus penggunaan. API pemanggilan aplikasi: Referensi daftar parameter lengkap dan contoh pemanggilan.