Asisten (Tidak Digunakan Lagi) - Alibaba Cloud Model Studio

API Asisten sedang dihentikan penggunaannya. Migrasikan ke API Responses sebagai alternatif. API Responses mencakup beberapa tool bawaan dan mendukung manajemen konteks multi-turn.

Fitur: Untuk informasi lebih lanjut tentang fitur dan penggunaan dasar API Asisten, lihat Ikhtisar API Asisten.

Persistensi: Semua instans asisten disimpan di server Alibaba Cloud Model Studio dan tidak memiliki tanggal kedaluwarsa. Anda dapat mengambil asisten menggunakan assistant.id-nya.

Aplikasi agen dan asisten adalah dua jenis aplikasi LLM dengan fitur dan penggunaan yang berbeda.

Aplikasi agen: Anda hanya dapat membuat, melihat, memperbarui, dan menghapus aplikasi agen di Konsol. Anda dapat memanggilnya menggunakan API pemanggilan aplikasi.
Asisten: Anda hanya dapat membuat, melihat, memperbarui, menghapus, dan memanggil asisten menggunakan API Asisten.

Buat agen

Membuat asisten baru.

HTTP
SDK

Contoh kode

curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/assistants' \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
--data '{
    "model": "qwen-max",
    "name": "Intelligent assistant",
    "description": "This is an intelligent assistant",
    "instructions": "You are an intelligent assistant that can call different tools based on user query and then give responses. Please use tools when needed.",
    "tools": [
        {
            "type": "code_interpreter"
        }
    ],
    "metadata": {}
}'

Parameter permintaan

Nama parameter	Deskripsi	Tipe	Wajib
model	Model yang digunakan oleh agen.	str	Ya
name	Nama agen.	str	Tidak
description	Deskripsi agen.	str	Tidak
instructions	Prompt sistem untuk LLM dalam agen.	str	Tidak
tools	Daftar tool yang dapat dipanggil oleh agen.Menyampaikan informasi otentikasi untuk plugin kustom. `{ "type": "${plugin_id}", "auth": { # Bidang ini hanya digunakan untuk otentikasi tingkat pengguna. "type": "user_http", "user_token": "bearer-token", } }`	Optional[List[Dict]]	Tidak (default: [])
metadata	Parameter lain yang terkait dengan agen. Parameter ini digunakan untuk menyimpan parameter terkait lainnya.	Dict	Tidak
temperature	Mengontrol tingkat keacakan dan keragaman.	float	Tidak
top_p	Ambang batas probabilitas untuk metode pengambilan sampel inti selama generasi.	float	Tidak
top_k	Ukuran set kandidat untuk pengambilan sampel selama generasi.	integer	Tidak

Respons

{
    "id": "asst_49079f4b-d1e8-4015-a12e-2dcdd1f18d84",
    "object": "assistant",
    "created_at": 1711713885724,
    "model": "qwen-max",
    "name": "Intelligent Assistant",
    "description": "This is an intelligent assistant.",
    "instructions": "You are an intelligent assistant. You can call different tools based on user needs to provide answers. Use tools as needed.",
    "tools": [
        {
            "type": "code_interpreter"
        }
    ],
    "metadata": {},
    "temperature": null,
    "top_p": null,
    "top_k": null,
    "max_tokens": null,
    "request_id": "b1778226-3865-9006-9e95-56329a710322"
}

Parameter responsSebuah objek assistant.

Contoh kode

from dashscope import Assistants
import os
import dashscope
dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
assistant = Assistants.create(
        # Setel variabel lingkungan. Jika belum, ganti baris berikut dengan Kunci API Model Studio Anda: api_key="sk-xxx"
        api_key=os.getenv("DASHSCOPE_API_KEY"),
        # Contoh ini menggunakan qwen-max. Anda dapat menggantinya dengan nama model lain sesuai kebutuhan. Untuk daftar model, lihat https://www.alibabacloud.com/help/en/model-studio/getting-started/models
        model='qwen-max',
        name='smart helper',
        description='A tool helper.',
        instructions='You are a helpful assistant. When asked a question, use tools wherever possible.',
        tools=[{
            'type': 'search'
        }, {
            'type': 'function',
            'function': {
                'name': 'big_add',
                'description': 'Add to number',
                'parameters': {
                    'type': 'object',
                    'properties': {
                        'left': {
                            'type': 'integer',
                            'description': 'The left operator'
                        },
                        'right': {
                            'type': 'integer',
                            'description': 'The right operator.'
                        }
                    },
                    'required': ['left', 'right']
                }
            }
        }],
)
print(assistant)

Parameter permintaan

Parameter	Type	Default	Deskripsi
model	string	-	Model yang digunakan oleh agen.
name	string	-	Nama agen.
description	string	-	Deskripsi agen.
instructions	string	-	Tentukan fitur agen
tools	array	[]	Tool yang digunakan oleh agen. Menyampaikan informasi otentikasi untuk tool kustom. `{` `"type": "plugin_type", "auth": {"type": "user_http","user_token": "bearer-token", }` `}` Ketika asisten meminta plugin, token bearer ditempatkan dalam `{"plugin_type":{"user_token": "bearer-token"}}` dan ditambahkan ke header pemanggilan plugin.
metadata	object	None	Informasi yang terkait dengan agen.
workspace	string	None	ID ruang kerja Model Studio. Parameter ini hanya diperlukan ketika `api_key` adalah kunci API sub-ruang kerja.
api_key	string	None	Untuk Kunci API Alibaba Cloud Model Studio, kami merekomendasikan agar Anda menyetelnya sebagai variabel lingkungan (Topik ini akan dihapus dan digabung ke dalam 'Konfigurasi Kunci API').

Respons

{
   "tools":[
      {
         "type":"search"
      },
      {
         "function":{
            "name":"big_add",
            "description":"Add to number",
            "parameters":{
               "type":"object",
               "properties":{
                  "left":{
                     "type":"integer",
                     "description":"The left operator"
                  },
                  "right":{
                     "type":"integer",
                     "description":"The right operator."
                  }
               },
               "required":[
                  "left",
                  "right"
               ]
            }
         },
         "type":"function"
      }
   ],
   "id":"asst_714cac72-81b2-49bf-a75d-c575b90a9398",
   "object":"assistant",
   "created_at":1726033638848,
   "model":"qwen-max",
   "name":"smart helper",
   "description":"A tool helper.",
   "instructions":"You are a helpful assistant. When asked a question, use tools wherever possible.",
   "file_ids":[

   ],
   "metadata":{

   },
   "temperature":"None",
   "top_p":"None",
   "top_k":"None",
   "max_tokens":"None",
   "request_id":"00f5962e-8d9f-92fd-9320-3173fa1525d6",
   "status_code":200
}

Parameter respons

Nama bidang	Type	Deskripsi
status_code	integer	Kode status HTTP untuk pemanggilan. Nilai 200 menunjukkan keberhasilan. Nilai lain menunjukkan kesalahan.
name	string	Nama agen.
id	string	ID agen, yaitu string UUID.
model	string	Nama model yang digunakan oleh agen.
description	string	Deskripsi agen.
instructions	string	Anda dapat menentukan informasi fitur agen.
metadata	object	Metadata agen.
tools	array	Daftar tool yang dapat digunakan oleh agen.
created_at	integer	Stempel waktu UNIX saat agen dibuat.
code	string	Menunjukkan bahwa permintaan gagal. Ini adalah kode kesalahan. Parameter ini diabaikan jika permintaan berhasil. Parameter ini hanya dikembalikan ketika pemanggilan dari Python gagal.
message	string	Menunjukkan bahwa permintaan gagal. Parameter ini memberikan detail tentang kegagalan tersebut. Parameter ini diabaikan jika permintaan berhasil. Parameter ini hanya dikembalikan ketika pemanggilan dari Python gagal.

Daftar agen

Menampilkan daftar asisten.

HTTP
SDK

Contoh kode

curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/assistants?limit=2&order=desc' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"

Parameter permintaan

Nama Parameter Masukan	Deskripsi parameter masukan	Tipe	Wajib
limit	Jumlah agen	int	Tidak
order	Urutan pengurutan berdasarkan waktu pembuatan.	str	Tidak (default: `desc`)

Respons

{
    "object": "list",
    "data": [
        {
            "id": "asst_0678aa33-43e2-4268-95e6-b0010f9f7937",
            "object": "assistant",
            "created_at": 1711435564909,
            "model": "qwen-max",
            "name": "Intelligent Assistant",
            "description": "This is an intelligent assistant.",
            "instructions": "You are an intelligent assistant. You can call different tools based on user needs to provide answers. Use tools as needed.",
            "tools": [
                {
                    "type": "search"
                },
                {
                    "type": "text_to_image"
                },
                {
                    "type": "code_interpreter"
                }
            ],
            "metadata": {}
        },
        {
            "id": "asst_7af23142-52bc-4218-aa98-dfdb1128f19c",
            "object": "assistant",
            "created_at": 1711422620443,
            "model": "qwen-max",
            "name": "helpful assistant",
            "description": "",
            "instructions": "You are a helpful assistant.",
            "tools": [
                {
                    "type": "text_to_image"
                }
            ],
            "file_ids": [],
            "metadata": {}
        }
    ],
    "first_id": "asst_0678aa33-43e2-4268-95e6-b0010f9f7937",
    "last_id": "asst_7af23142-52bc-4218-aa98-dfdb1128f19c",
    "has_more": true,
    "request_id": "bc257359-ce86-9547-98be-d804effba8d1"
}

Parameter responsDaftar objek assistant.

Contoh kode

import dashscope
from dashscope import Assistants
import os

dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
assistants = Assistants.list(
    # Setel variabel lingkungan. Jika belum, ganti baris berikut dengan Kunci API Model Studio Anda: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    limit=1,
    order='desc'
)

Parameter permintaan

Parameter	Tipe	Default	Deskripsi
limit	string	None	Jumlah asisten yang akan ditampilkan. Jika parameter ini tidak ditentukan, nilai default di server akan digunakan.
order	string	None	Urutan pengurutan. Nilai yang valid: `desc` (menurun) dan `asc` (menaik). Jika parameter ini tidak ditentukan, nilai default di server akan digunakan.
workspace	string	None	ID ruang kerja Model Studio. Parameter ini hanya diperlukan ketika `api_key` adalah kunci API sub-ruang kerja.
api_key	string	None	Untuk Kunci API Alibaba Cloud Model Studio, kami merekomendasikan agar Anda mengonfigurasinya dalam variabel lingkungan.

Parameter respons

Nama Bidang	Tipe	Deskripsi
has_more	boolean	Menunjukkan apakah masih ada data tambahan yang tersedia.
last_id	string	ID asisten terakhir dalam data.
first_id	string	ID asisten pertama dalam data.
data	array	Daftar objek agen.
object	string	Format data, seperti `"list"`.
request_id	string	ID permintaan.
status_code	integer	Kode status permintaan.

Agen Pengambilan

HTTP
SDK

Contoh kode

curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/assistants/asst_0678aa33-43e2-4268-95e6-b0010f9f7937' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"

Parameter permintaan

Nama parameter masukan	Deskripsi parameter masukan	Tipe	Wajib
assistant_id	ID agen yang akan diambil.	str	Ya

Respons

{
    "id": "asst_0678aa33-43e2-4268-95e6-b0010f9f7937",
    "object": "assistant",
    "created_at": 1711435564909,
    "model": "qwen-max",
    "name": "Intelligent Assistant",
    "description": "This is an intelligent assistant.",
    "instructions": "You are an intelligent assistant. You can call different tools based on user needs to provide answers. Use tools as needed.",
    "tools": [
        {
            "type": "search"
        },
        {
            "type": "text_to_image"
        },
        {
            "type": "code_interpreter"
        }
    ],
    "metadata": {},
    "request_id": "f0ec05b0-8813-984c-81b5-1166ae3478d1"
}

Parameter responsObjek assistant yang diambil.

Contoh kode

from dashscope import Assistants
import dashscope
import os

dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
assistant = Assistants.retrieve(
    assistant_id='your_assistant_id',
    # Setel variabel lingkungan. Jika belum, ganti baris berikut dengan Kunci API Model Studio Anda: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY")
)

print(assistant)

Parameter permintaan

Parameter	Type	Default	Deskripsi
assistant_id	string	-	ID agen yang akan diambil.
workspace	string	None	ID ruang kerja Model Studio. Parameter ini hanya diperlukan ketika `api_key` adalah kunci API sub-ruang kerja.
api_key	string	None	Kunci API Model Studio. Untuk informasi lebih lanjut, lihat Konfigurasi kunci API sebagai variabel lingkungan.

Parameter responsUntuk informasi lebih lanjut, lihat Objek Asisten.

Perbarui agen

HTTP
SDK

Contoh kode

curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/assistants/asst_0678aa33-43e2-4268-95e6-b0010f9f7937' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
--data '{
    "instructions": "You are a search assistant",
    "name": "New Application-assistantAPI",
    "description": "",
    "model": "qwen-max"
}'

Parameter permintaan

Nama Parameter Masukan	Deskripsi parameter masukan	Tipe	Wajib
assistant_id	ID agen yang akan diambil	str	Ya
*	Parameter masukan opsional lainnya.	str	Tidak
model	ID model yang digunakan oleh agen.	str	Ya
name	Nama agen.	str	Tidak
description	Deskripsi agen.	str	Tidak
instructions	Prompt sistem untuk LLM dalam agen.	str	Tidak
tools	Daftar tool yang dapat dipanggil oleh agen. Tool tersebut harus terdaftar di Alibaba Cloud Model Studio.	Optional[List[Dict]]	Tidak (default: [])
metadata	Menyimpan parameter terkait lainnya untuk agen.	Dict	Tidak

Respons

{
    "id": "asst_0678aa33-43e2-4268-95e6-b0010f9f7937",
    "object": "assistant",
    "created_at": 1711435564909,
    "model": "qwen-max",
    "name": "New-Application-assistantAPI",
    "description": "",
    "instructions": "You are a search assistant.",
    "tools": [
        {
            "type": "search"
        },
        {
            "type": "text_to_image"
        },
        {
            "type": "code_interpreter"
        }
    ],
    "metadata": {},
    "request_id": "b0993831-a98b-9e71-b235-75174df9046e"
}

Parameter responsObjek assistant yang diperbarui.

Contoh kode

from dashscope import Assistants
import dashscope
import os

dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
assistants = Assistants.update(
    'assistant_id',
    model='new_model_name',
    # Setel variabel lingkungan. Jika belum, ganti baris berikut dengan Kunci API Model Studio Anda: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY")
)

Parameter permintaan

Parameter	Tipe	Default	Deskripsi
assistant_id	string	-	ID asisten yang akan diperbarui.
model	string	-	Model yang digunakan oleh agen.
name	string	None	Nama agen.
description	string	None	Deskripsi agen.
instructions	string	None	Anda dapat menentukan informasi fitur untuk agen.
tools	array	[]	Tool yang digunakan oleh agen.
metadata	object	None	Informasi yang terkait dengan agen.
workspace	string	None	ID ruang kerja Model Studio. Parameter ini hanya diperlukan ketika `api_key` adalah kunci API sub-ruang kerja.
api_key	string	None	Untuk Kunci API Alibaba Cloud Model Studio, kami merekomendasikan agar Anda menyetel kunci API sebagai variabel lingkungan.

Parameter responsUntuk informasi lebih lanjut, lihat Objek Asisten.

Hapus agen

HTTP
SDK

Contoh kode

curl --location --request DELETE 'https://dashscope-intl.aliyuncs.com/api/v1/assistants/asst_0678aa33-43e2-4268-95e6-b0010f9f7937' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"

Parameter permintaan

Nama Parameter Masukan	Deskripsi	Tipe	Wajib
assistant_id	ID agen yang akan diambil.	str	Ya

Respons

{
    "id": "asst_0678aa33-43e2-4268-95e6-b0010f9f7937",
    "object": "assistant.deleted",
    "deleted": true,
    "request_id": "6af9320f-0430-9d01-b92f-d1beb6424dc5"
}

Parameter responsMenampilkan status asisten yang dihapus.

Contoh kode

from dashscope import Assistants
import dashscope
import os

dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
assistants = Assistants.delete(
    'assistant_id',
    # Setel variabel lingkungan. Jika belum, ganti baris berikut dengan Kunci API Model Studio Anda: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY")
)

Parameter permintaan

Parameter	Tipe	Default	Deskripsi
assistant_id	string	-	ID agen yang akan dihapus.
workspace	string	None	ID ruang kerja Model Studio. Parameter ini hanya diperlukan ketika `api_key` adalah kunci API sub-ruang kerja.
api_key	string	None	Untuk Kunci API Alibaba Cloud Model Studio Anda, kami merekomendasikan agar Anda menyetelnya sebagai variabel lingkungan (Topik ini akan dihapus dan digabung ke dalam 'Konfigurasi Kunci API').

Parameter respons

Nama bidang	Tipe	Deskripsi
id	string	ID objek yang dihapus.
object	string	Target permintaan. Contoh: `'assistant.deleted'`
deleted	boolean	Konfirmasi Penghapusan
request_id	string	ID permintaan.
status_code	integer	Kode status permintaan.

Objek agen

Objek Assistant yang dapat memanggil model dan menggunakan tool. Contoh Objek Agen

{
    "id": "asst_49079f4b-d1e8-4015-a12e-2dcdd1f18d84",
    "object": "assistant",
    "created_at": 1711713885724,
    "model": "qwen-max",
    "name": "Intelligent Assistant",
    "description": "This is an intelligent assistant.",
    "instructions": "You are an intelligent assistant. You can call different tools based on user needs to provide answers. Use tools as needed.",
    "tools": [
        {
            "type": "code_interpreter"
        }
    ],
    "metadata": {},
    "temperature": null,
    "top_p": null,
    "top_k": null,
    "max_tokens": null,
    "request_id": "b1778226-3865-9006-9e95-56329a710322"
}

Nama parameter	Tipe data	Deskripsi
id	string	Identifier unik agen, yaitu ID asisten.
object	string	Tipe objek. Nilai ini selalu `assistant`.
created_at	integer	Stempel waktu Unix 13 digit, dalam milidetik, saat agen dibuat.
model	string	Nama model yang digunakan oleh agen. Anda dapat melihat semua model yang tersedia di Ikhtisar API Asisten atau lihat Daftar model untuk detail lebih lanjut.
name	string	Nama agen.
description	string	Deskripsi agen.
instructions	string	Instruksi sistem yang digunakan oleh agen.
tools	array	Daftar tool yang diaktifkan pada agen. Tool tersebut dapat berupa plugin resmi (seperti `code_interpreter`, `quark_search`, atau `text_to_image`), Generasi yang Diperkaya dengan Pengambilan Data (RAG), atau pemanggilan fungsi.
metadata	dict	Informasi tambahan tentang objek agen yang disimpan dalam format terstruktur.
temperature	float	Suhu pengambilan sampel, yang berkisar antara 0 hingga 2. Nilai yang lebih tinggi, seperti 1, membuat output lebih acak. Nilai yang lebih rendah, seperti 0,2, membuat output lebih fokus dan deterministik.
top_p	float	Alternatif dari pengambilan sampel suhu, yang disebut pengambilan sampel inti. Dalam metode pengambilan sampel ini, LLM memilih hasil token yang memiliki massa probabilitas kumulatif sebesar `top_p`. Nilai 0,1 berarti hanya token yang membentuk 10% teratas dari massa probabilitas yang dipertimbangkan. Atur parameter ini atau `temperature`, tetapi jangan keduanya sekaligus.
top_k	integer	Mirip dengan `top_p`, tetapi sampel dipilih dari k token dengan probabilitas tertinggi, tanpa mempertimbangkan massa probabilitas kumulatifnya. Jangan atur parameter ini bersamaan dengan `temperature` atau `top_p` secara bersamaan.
max_tokens	integer	Jumlah maksimum token yang dapat dihasilkan agen dalam satu kali.
request_id	string	Identifier unik pemanggilan yang terkait dengan agen.

Kode kesalahan

Jika pemanggilan model gagal dan mengembalikan pesan kesalahan, lihat Pesan kesalahan untuk informasi troubleshooting.

​Buat agen

​Daftar agen

​Agen Pengambilan

​Perbarui agen

​Hapus agen

​Objek agen

​Kode kesalahan

Buat agen

Daftar agen

Agen Pengambilan

Perbarui agen

Hapus agen

Objek agen

Kode kesalahan