Asisten - Alibaba Cloud Model Studio

Assistant API menyederhanakan proses pembuatan Asisten. Topik ini menjelaskan metode yang disediakan oleh Assistant API untuk mengelola Asisten, termasuk membuat, menampilkan daftar, mengambil, memperbarui, dan menghapusnya.

Pengenalan: Untuk mempelajari fitur dan penggunaan dasar Assistant API, lihat Ikhtisar Assistant API.

Masa berlaku: Semua instans Asisten disimpan di server Model Studio. Saat ini, instans tersebut tidak memiliki tanggal kedaluwarsa. Anda dapat mengambil asisten menggunakan assistant.id-nya.

Catatan

Aplikasi agen dan Asisten keduanya merupakan aplikasi model, tetapi memiliki fitur dan penggunaan yang berbeda.

Aplikasi agen: Anda hanya dapat membuat, melihat, memperbarui, dan menghapus aplikasi agen di Konsol, serta memanggilnya menggunakan Application calling API.
Asisten: Anda hanya dapat membuat, melihat, memperbarui, menghapus, dan memanggil Asisten menggunakan Assistant API.

Buat asisten

Membuat asisten.

HTTP

Kode contoh

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

Parameter	Deskripsi	Tipe	Wajib
model	Model yang digunakan oleh asisten.	str	Ya
name	Nama asisten.	str	Tidak
description	Teks yang digunakan untuk mendeskripsikan asisten.	str	Tidak
instructions	Prompt sistem untuk model dalam asisten.	various	Tidak
tools	Daftar tool yang dapat dipanggil oleh asisten. Teruskan informasi autentikasi untuk plug-in kustom. `{ "type": "${plugin_id}", "auth": { # Bidang ini hanya digunakan saat autentikasi tingkat pengguna digunakan "type": "user_http", "user_token": "bearer-token", } }`	Optional[List[Dict]]	Tidak (default ke [])
metadata	Parameter relevan lainnya untuk asisten, digunakan untuk menyimpan informasi 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 contoh

{
    "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 that can call different tools based on user needs and then provide answers. Please use tools as appropriate.",
    "tools": [
        {
            "type": "code_interpreter"
        }
    ],
    "metadata": {},
    "temperature": null,
    "top_p": null,
    "top_k": null,
    "max_tokens": null,
    "request_id": "b1778226-3865-9006-9e95-56329a710322"
}

Parameter respons

Mengembalikan objek assistant.

SDK

Kode contoh

Python

from dashscope import Assistants
import os
import dashscope
dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
assistant = Assistants.create(
        # Kami menyarankan Anda mengonfigurasi variabel lingkungan terlebih dahulu. Jika belum mengonfigurasi variabel lingkungan, ganti baris berikut dengan Kunci API Model Studio Anda: api_key="sk-xxx"
        api_key=os.getenv("DASHSCOPE_API_KEY"),
        # Dalam contoh ini, qwen-max digunakan. 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)

Java

import com.alibaba.dashscope.assistants.Assistant;
import com.alibaba.dashscope.assistants.AssistantParam;
import com.alibaba.dashscope.assistants.Assistants;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.InvalidateParameter;
import com.alibaba.dashscope.exception.NoApiKeyException;
import java.lang.System;
import com.alibaba.dashscope.utils.JsonUtils;
import com.alibaba.dashscope.utils.Constants;

public class Main {
    static {
        Constants.baseHttpApiUrl="https://dashscope-intl.aliyuncs.com/api/v1";
    }
    public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
        Assistants assistants = new Assistants();
        // build assistant parameters
        AssistantParam param = AssistantParam.builder()
                // Dalam contoh ini, qwen-max digunakan. 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("intelligent guide")
                .description("a smart guide")
                .instructions("You are a helpful assistant.")
                // Kami menyarankan Anda mengonfigurasi variabel lingkungan terlebih dahulu. Jika belum mengonfigurasi variabel lingkungan, ganti baris berikut dengan Kunci API Model Studio Anda: api_key="sk-xxx"
                .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                .build();
        Assistant assistant = assistants.create(param);
        System.out.println(JsonUtils.toJson(assistant));
        // use assistant

    }
}

Parameter permintaan

Parameter	Tipe	Nilai default	Deskripsi
model	string	-	Model yang digunakan oleh asisten.
name	string	-	Nama asisten.
description	string	-	Deskripsi asisten.
instructions	string	-	Informasi fungsi asisten.
tools	array	[]	Tool yang digunakan oleh asisten. Catatan Teruskan informasi autentikasi untuk tool kustom. `{` `"type": "plugin_type", "auth": {"type": "user_http","user_token": "bearer-token", }` `}` Saat asisten meminta plug-in, token bearer akan ditempatkan di `{"plugin_type":{"user_token": "bearer-token"}}` dan ditambahkan ke header pemanggilan plug-in.
metadata	object	None	Informasi yang terkait dengan asisten.
workspace	string	None	ID ruang kerja Model Studio. Parameter ini wajib hanya jika api_key adalah kunci API sub-ruang kerja.
api_key	string	None	Kunci API Model Studio. Kami menyarankan Anda mengonfigurasi kunci API sebagai variabel lingkungan.

Respons contoh

{
   "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

Parameter	Tipe	Deskripsi
status_code	integer	Kode status HTTP dari panggilan. Nilai 200 menunjukkan bahwa panggilan berhasil. Nilai lain menunjukkan kegagalan panggilan.
name	string	Nama asisten.
id	string	ID asisten, berupa string UUID.
model	string	Nama model yang digunakan oleh asisten.
description	string	Deskripsi asisten.
instructions	string	Informasi fungsi asisten.
metadata	object	Metadata asisten.
tools	array	Daftar tool yang dapat digunakan oleh asisten.
created_at	integer	Representasi stempel waktu UNIX saat asisten dibuat.
code	string	Menunjukkan bahwa permintaan gagal. Ini adalah kode kesalahan. Diabaikan saat permintaan berhasil. Ditampilkan hanya ketika panggilan melalui Python gagal.
message	string	Gagal. Ini menunjukkan informasi detail tentang kegagalan. Diabaikan saat berhasil. Ditampilkan hanya ketika panggilan melalui Python gagal.

Daftar asisten

Mengembalikan daftar asisten.

HTTP

Kode contoh

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

Parameter	Deskripsi	Tipe	Wajib
limit	Jumlah asisten yang dikembalikan.	int	Tidak
order	Urutkan berdasarkan waktu pembuatan secara ascending atau descending.	str	Tidak (default ke `desc`)

Respons contoh

{
    "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 that can call different tools based on user needs and then provide answers. Please use tools as appropriate.",
            "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 respons

Mengembalikan daftar objek assistant.

SDK

Kode contoh

Python

import dashscope
from dashscope import Assistants
import os

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

Java

import com.alibaba.dashscope.assistants.Assistant;
import com.alibaba.dashscope.assistants.Assistants;
import com.alibaba.dashscope.common.GeneralListParam;
import com.alibaba.dashscope.common.ListResult;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.InvalidateParameter;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.utils.Constants;

public class Main {
    static {
        Constants.baseHttpApiUrl="https://dashscope-intl.aliyuncs.com/api/v1";
    }
    public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
      Assistants assistants = new Assistants();
      GeneralListParam listParam = GeneralListParam.builder()
                // Kami menyarankan Anda mengonfigurasi variabel lingkungan terlebih dahulu. Jika belum mengonfigurasi variabel lingkungan, ganti baris berikut dengan Kunci API Model Studio Anda: api_key="sk-xxx"
                .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                .limit(10l)
                .build();
      ListResult<Assistant> assistant = assistants.list(listParam);
    }
}

Parameter permintaan

Parameter	Tipe	Nilai default	Deskripsi
limit	string	None	Jumlah asisten yang dikembalikan. Jika parameter ini tidak ditentukan, nilai default di server akan digunakan.
order	string	None	Metode pengurutan. Nilai yang valid: desc (descending) dan asc (ascending). Jika parameter ini tidak ditentukan, nilai default di server akan digunakan.
workspace	string	None	ID ruang kerja Model Studio. Parameter ini wajib hanya jika api_key adalah kunci API sub-ruang kerja.
api_key	string	None	Kunci API Model Studio. Kami menyarankan Anda mengonfigurasi kunci API sebagai variabel lingkungan.

Parameter respons

Parameter	Tipe	Deskripsi
has_more	boolean	Menunjukkan apakah masih ada data yang dapat diambil.
last_id	string	ID asisten terakhir dalam data.
first_id	string	ID asisten pertama dalam data.
data	array	Daftar objek asisten.
object	string	Format data dari data, seperti `"list"`.
request_id	string	ID permintaan ini.
status_code	integer	Kode status permintaan.

Ambil asisten

HTTP

Kode contoh

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

Parameter	Deskripsi	Tipe	Wajib
assistant_id	ID asisten yang akan diambil.	str	Ya

Respons contoh

{
    "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 that can call different tools based on user needs and then provide answers. Please use tools as appropriate.",
    "tools": [
        {
            "type": "search"
        },
        {
            "type": "text_to_image"
        },
        {
            "type": "code_interpreter"
        }
    ],
    "metadata": {},
    "request_id": "f0ec05b0-8813-984c-81b5-1166ae3478d1"
}

Parameter respons

Mengembalikan objek assistant yang diambil.

SDK

Kode contoh

Python

from dashscope import Assistants
import dashscope
import os

dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'from dashscope import Assistants
assistant = Assistants.retrieve(
    assistant_id='your_assistant_id',
    # Kami menyarankan Anda untuk mengonfigurasi variabel lingkungan terlebih dahulu. Jika Anda belum mengonfigurasi variabel lingkungan, ganti baris berikut dengan kunci API Model Studio Anda: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY")
)

print(assistant)

Java

import com.alibaba.dashscope.assistants.Assistant;
import com.alibaba.dashscope.assistants.Assistants;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.InvalidateParameter;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.utils.Constants;

public class Main {
    static {
        Constants.baseHttpApiUrl="https://dashscope-intl.aliyuncs.com/api/v1";
    }
    public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
      Assistants assistants = new Assistants();
      // Kami menyarankan Anda mengonfigurasi variabel lingkungan terlebih dahulu. Jika belum mengonfigurasi variabel lingkungan, ganti baris berikut dengan Kunci API Model Studio Anda: api_key="sk-xxx"
      String apiKey = System.getenv("DASHSCOPE_API_KEY");
      Assistant assistant = assistants.retrieve("assistant_id", apiKey);
    }
}

Parameter permintaan

Parameter	Tipe	Nilai default	Deskripsi
assistant_id	string	-	ID asisten yang akan diambil.
workspace	string	None	ID ruang kerja Model Studio. Parameter ini wajib hanya jika api_key adalah kunci API sub-ruang kerja.
api_key	string	None	Kunci API Model Studio. Kami menyarankan Anda mengonfigurasi kunci API sebagai variabel lingkungan.

Parameter respons

Untuk informasi lebih lanjut, lihat Objek Assistant.

Perbarui asisten

HTTP

Kode contoh

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 Applications-AssistantsAPI",
    "description": "",
    "model": "qwen-max",
}'

Parameter permintaan

Parameter	Deskripsi	Tipe	Wajib
assistant_id	ID asisten yang akan diambil.	str	Ya
*	Parameter input opsional lainnya.	various	Tidak
model	ID model yang digunakan oleh asisten.	str	Ya
name	Nama asisten.	str	Tidak
description	Deskripsi asisten.	str	Tidak
instructions	Prompt sistem untuk model dalam asisten.	str	Tidak
tools	Daftar tool yang dapat dipanggil oleh asisten. Tool tersebut harus terdaftar di Model Studio.	Optional[List[Dict]]	Tidak (default ke [])
metadata	Parameter relevan lainnya untuk asisten, digunakan untuk menyimpan informasi terkait lainnya.	Dict	Tidak

Respons contoh

{
    "id": "asst_0678aa33-43e2-4268-95e6-b0010f9f7937",
    "object": "assistant",
    "created_at": 1711435564909,
    "model": "qwen-max",
    "name": "New Applications-AssistantsAPI",
    "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 respons

Mengembalikan objek assistant yang diperbarui.

SDK

Kode contoh

Python

from dashscope import Assistants
import dashscope
import os

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

Java

import com.alibaba.dashscope.assistants.Assistant;
import com.alibaba.dashscope.assistants.AssistantParam;
import com.alibaba.dashscope.assistants.Assistants;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.InvalidateParameter;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.utils.Constants;

public class Main {
    static {
        Constants.baseHttpApiUrl="https://dashscope-intl.aliyuncs.com/api/v1";
    }
    public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
        Assistants assistants = new Assistants();
        AssistantParam param = AssistantParam.builder()
                .model("qwen-max")
                .name("intelligent guide")
                .description("a smart guide")
                .instructions("You are a helpful assistant.  When asked a question, use tools wherever possible.")
                // Kami menyarankan Anda mengonfigurasi variabel lingkungan terlebih dahulu. Jika belum mengonfigurasi variabel lingkungan, ganti baris berikut dengan Kunci API Model Studio Anda: api_key="sk-xxx"
                .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                .build();
        
        Assistant assistant = assistants.update("assistant_id", param);
    }
}

Parameter permintaan

Parameter	Tipe	Nilai default	Deskripsi
assistant_id	string	-	ID asisten yang akan diperbarui.
model	string	-	Model yang digunakan oleh asisten.
name	string	None	Nama asisten.
description	string	None	Deskripsi asisten.
instructions	string	None	Informasi fungsi asisten.
tools	array	[]	Tool yang digunakan oleh asisten.
metadata	object	None	Informasi yang terkait dengan asisten.
workspace	string	None	ID ruang kerja Model Studio. Parameter ini wajib hanya jika api_key adalah kunci API sub-ruang kerja.
api_key	string	None	Kunci API Model Studio. Kami menyarankan Anda mengonfigurasi kunci API sebagai variabel lingkungan.

Parameter respons

Untuk informasi lebih lanjut, lihat Objek Assistant.

Hapus asisten

HTTP

Kode contoh

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

Parameter	Deskripsi	Tipe	Wajib
assistant_id	ID asisten yang akan diambil	str	Ya

Respons contoh

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

Parameter respons

Mengembalikan status penghapusan asisten.

SDK

Kode contoh

Python

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',
    # Kami menyarankan Anda mengonfigurasi variabel lingkungan terlebih dahulu. Jika belum mengonfigurasi variabel lingkungan, ganti baris berikut dengan Kunci API Model Studio Anda: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY")
)

Java

import com.alibaba.dashscope.assistants.Assistants;
import com.alibaba.dashscope.common.DeletionStatus;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.InvalidateParameter;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.utils.Constants;

public class Main {
    static {
        Constants.baseHttpApiUrl="https://dashscope-intl.aliyuncs.com/api/v1";
    }
    public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
        Assistants assistants = new Assistants();     
        // Kami menyarankan Anda mengonfigurasi variabel lingkungan terlebih dahulu. Jika belum mengonfigurasi variabel lingkungan, ganti baris berikut dengan Kunci API Model Studio Anda: api_key="sk-xxx"
        String apiKey = System.getenv("DASHSCOPE_API_KEY");
        DeletionStatus assistant = assistants.delete("assistant_id", apiKey);
    }
}

Parameter permintaan

Parameter	Tipe	Nilai default	Deskripsi
assistant_id	string	-	ID asisten yang akan dihapus.
workspace	string	None	ID ruang kerja Model Studio. Parameter ini wajib hanya jika api_key adalah kunci API sub-ruang kerja.
api_key	string	None	Kunci API Model Studio. Kami menyarankan Anda mengonfigurasi kunci API sebagai variabel lingkungan.
*	various	None	Parameter input opsional lainnya (misalnya, 'tools' sebagai list, 'metadata' sebagai dict)

Parameter respons

Parameter	Tipe	Deskripsi
id	string	ID objek yang dihapus.
object	string	Target permintaan ini. Contoh: `'assistant.deleted'`
deleted	boolean	Apakah objek tersebut dihapus.
request_id	string	ID permintaan ini.
status_code	integer	Kode status permintaan.

Objek Asisten

Objek Assistant dapat memanggil model dan menggunakan tool.

Objek contoh

{
    "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 that can call different tools based on user needs and then provide answers. Please use tools as appropriate.",
    "tools": [
        {
            "type": "code_interpreter"
        }
    ],
    "metadata": {},
    "temperature": null,
    "top_p": null,
    "top_k": null,
    "max_tokens": null,
    "request_id": "b1778226-3865-9006-9e95-56329a710322"
}

Parameter	Tipe data	Deskripsi
id	string	Pengidentifikasi unik asisten, yaitu ID asisten.
object	string	Tipe objek, yang selalu `assistant`.
create_at	integer	Stempel waktu UNIX 13 digit (dalam milidetik) saat asisten dibuat.
model	string	Nama model yang digunakan oleh asisten. Anda dapat melihat semua model yang tersedia di Ikhtisar fitur Assistant API, atau lihat Model untuk detail lebih lanjut.
name	string	Nama asisten.
description	string	Deskripsi asisten.
instructions	string	Instruksi sistem yang digunakan oleh asisten.
tools	array	Daftar tool yang diaktifkan pada asisten. Tool tersebut dapat berupa plug-in resmi (code_interpreter, atau text_to_image), Generasi yang Diperkaya dengan Pengambilan Data (RAG), atau pemanggilan fungsi.
metadata	dict	Informasi tambahan tentang objek asisten 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 untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel inti. Dalam metode pengambilan sampel ini, model mempertimbangkan hasil token dengan massa probabilitas kumulatif top_p. Nilai 0,1 berarti hanya token yang mencakup 10% teratas dari massa probabilitas yang dipertimbangkan. Kami umumnya merekomendasikan Anda menyesuaikan parameter ini atau `temperature`, tetapi tidak keduanya sekaligus.
top_k	integer	Mirip dengan top_p, tetapi sampel dipilih dari k token dengan probabilitas tertinggi, terlepas dari massa probabilitas kumulatifnya. Jangan sesuaikan parameter ini dan `temperature` atau `top_p` secara bersamaan.
max_tokens	integer	Jumlah maksimum token yang dapat dihasilkan asisten dalam satu kali.
request_id	string	Pengidentifikasi unik dari panggilan yang terkait dengan asisten.

Penyelesaian masalah error

Jika panggilan gagal dan mengembalikan pesan error, lihat Pesan error untuk troubleshooting.