Assistants (Deprecated) - Alibaba Cloud Model Studio: Central de Documentação do Alibaba Cloud

A API de assistentes simplifica a criação de assistentes, um tipo de aplicação baseada em Large Language Model (LLM). Este tópico descreve os métodos fornecidos pela API de assistentes para gerenciar esses recursos, incluindo criação, listagem, recuperação, atualização e exclusão.

Importante

A API de Assistentes está sendo descontinuada. Migre para a Responses API como alternativa. A Responses API inclui várias ferramentas integradas e oferece suporte ao gerenciamento de contexto em múltiplas interações.

Recursos : Para obter mais informações sobre os recursos e o uso básico da API de assistentes, consulte Visão geral da API de Assistentes .

Persistência : Todas as instâncias de assistentes são salvas no servidor do Alibaba Cloud Model Studio e não possuem data de expiração. É possível recuperar um assistente utilizando seu assistant.id.

Nota

As Aplicações de agente e os assistentes são dois tipos de aplicações LLM com características e usos distintos.

Aplicações de agente: Crie, visualize, atualize e exclua aplicações de agente exclusivamente no console. Para chamá-las, utilize a API de chamada de aplicação.
Assistentes: Crie, visualize, atualize, exclua e chame assistentes apenas por meio da API de assistentes.

Criar um agente

Cria um novo assistente.

HTTP

Exemplo de código

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": {}
}'

Parâmetros da solicitação

Nome do parâmetro	Descrição	Tipo	Obrigatório
model	O modelo utilizado pelo agente.	str	Sim
name	O nome do agente.	str	Não
description	A descrição do agente.	str	Não
instructions	O prompt do sistema para o LLM no agente.	str	Não
tools	Uma lista de ferramentas que o agente pode chamar. Transmite informações de autenticação para um plugin personalizado. `{ "type": "${plugin_id}", "auth": { # This field is used only for user-level authentication. "type": "user_http", "user_token": "bearer-token", } }`	Optional[List[Dict]]	Não (padrão: [])
metadata	Outros parâmetros relacionados ao agente. Utilize este parâmetro para armazenar informações adicionais pertinentes.	Dict	Não
temperature	Controla o grau de aleatoriedade e diversidade.	float	Não
top_p	O limiar de probabilidade para o método de amostragem de núcleo durante a geração.	float	Não
top_k	O tamanho do conjunto de candidatos para amostragem durante a geração.	integer	Não

Resposta

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

Parâmetros da resposta

Um objeto assistente.

SDK

Exemplo de código

from dashscope import Assistants
import os

assistant = Assistants.create(
        # Set the environment variable. If you have not, replace the following line with your Model Studio API key: api_key="sk-xxx"
        api_key=os.getenv("DASHSCOPE_API_KEY"),
        # This example uses qwen-max. You can replace it with another model name as needed. For a list of models, see 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)

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;

public class Main {
    public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
        Assistants assistants = new Assistants();
        // build assistant parameters
        AssistantParam param = AssistantParam.builder()
                // This example uses qwen-max. You can replace it with another model name as needed. For a list of models, see 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.")
                // Set the environment variable. If you have not, replace the following line with your Model Studio API key: api_key="sk-xxx"
                .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                .build();
        Assistant assistant = assistants.create(param);
        System.out.println(JsonUtils.toJson(assistant));
        // use assistant

    }
}

from dashscope import Assistants
import os
import dashscope
dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
assistant = Assistants.create(
        # Set the environment variable. If you have not, replace the following line with your Model Studio API key: api_key="sk-xxx"
        api_key=os.getenv("DASHSCOPE_API_KEY"),
        # This example uses qwen-max. You can replace it with another model name as needed. For a list of models, see 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)

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()
                // This example uses qwen-max. You can replace it with another model name as needed. For a list of models, see 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.")
                // Set the environment variable. If you have not, replace the following line with your Model Studio API key: api_key="sk-xxx"
                .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                .build();
        Assistant assistant = assistants.create(param);
        System.out.println(JsonUtils.toJson(assistant));
        // use assistant

    }
}

Parâmetros da solicitação

Parâmetro	Tipo	Padrão	Descrição
model	string	-	O modelo utilizado pelo agente.
name	string	-	O nome do agente.
description	string	-	A descrição do agente.
instructions	string	-	Especifique os recursos do agente
tools	array	[]	As ferramentas utilizadas pelo agente. Nota Transmite informações de autenticação para uma ferramenta personalizada. `{` `"type": "plugin_type", "auth": {"type": "user_http","user_token": "bearer-token", }` `}` Quando o assistente solicita um plugin, ele insere o bearer token em `{"plugin_type":{"user_token": "bearer-token"}}` e o adiciona ao cabeçalho da chamada do plugin.
metadata	object	None	As informações associadas ao agente.
workspace	string	None	O ID do workspace do Model Studio. Este parâmetro é necessário apenas quando `api_key` for uma chave de API de sub-workspace.
api_key	string	None	Para a chave de API do Alibaba Cloud Model Studio, recomendamos configurá-la como uma variável de ambiente (Este tópico será despublicado e mesclado em 'Configurar chave de API').

Resposta

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

Parâmetros da resposta

Nome do campo	Tipo	Descrição
status_code	integer	O código de status HTTP da chamada. O valor 200 indica sucesso. Outros valores indicam erro.
name	string	O nome do agente.
id	string	O ID do agente, representado por uma string UUID.
model	string	O nome do modelo utilizado pelo agente.
description	string	A descrição do agente.
instructions	string	Permite especificar as informações de recursos do agente.
metadata	object	Os metadados do agente.
tools	array	Uma lista de ferramentas disponíveis para o agente.
file_ids	array	Os IDs dos arquivos associados ao agente. O upload de arquivos pode ser feito via comando de arquivo ou pela Files API.
created_at	integer	O timestamp UNIX de criação do agente.
code	string	Indica falha na solicitação. Representa o código de erro. Ignorado se a solicitação for bem-sucedida. Retornado apenas em falhas de chamadas via Python.
message	string	Indica falha na solicitação. Fornece detalhes sobre o erro. Ignorado se a solicitação for bem-sucedida. Retornado apenas em falhas de chamadas via Python.

Listar agentes

Retorna uma lista de assistentes.

HTTP

Exemplo de código

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"

Parâmetros da solicitação

Nome do parâmetro de entrada	Descrições do parâmetro de entrada	Tipo	Obrigatório
limit	Quantidade de agentes	int	Não
order	A ordem de classificação por hora de criação.	str	Não (padrão: `desc`)

Resposta

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

Parâmetros da resposta

Uma lista de objetos assistente.

SDK

Exemplo de código

from dashscope import Assistants
import os

assistants = Assistants.list(
    # Set the environment variable. If you have not, replace the following line with your Model Studio API key: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    limit=1,
    order='desc'
)

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;

public class Main {
    public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
      Assistants assistants = new Assistants();
      GeneralListParam listParam = GeneralListParam.builder()
                // Set the environment variable. If you have not, replace the following line with your Model Studio API key: api_key="sk-xxx"
                .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                .limit(10l)
                .build();
      ListResult<Assistant> assistant = assistants.list(listParam);
    }
}

import dashscope
from dashscope import Assistants
import os

dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
assistants = Assistants.list(
    # Set the environment variable. If you have not, replace the following line with your Model Studio API key: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    limit=1,
    order='desc'
)

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()
                // Set the environment variable. If you have not, replace the following line with your Model Studio API key: api_key="sk-xxx"
                .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                .limit(10l)
                .build();
      ListResult<Assistant> assistant = assistants.list(listParam);
    }
}

Parâmetros da solicitação

Parâmetro	Tipo	Padrão	Descrição
limit	string	None	A quantidade de assistentes a listar. Caso não especificado, o valor padrão do servidor será aplicado.
order	string	None	A ordem de classificação. Valores válidos: `desc` (decrescente) e `asc` (crescente). Se omitido, o valor padrão do servidor prevalece.
workspace	string	None	O ID do workspace do Model Studio. Necessário apenas quando `api_key` for uma chave de API de sub-workspace.
api_key	string	None	Para a chave de API do Alibaba Cloud Model Studio, recomendamos configurá-la em uma variável de ambiente.

Parâmetros da resposta

Nome do campo	Tipo	Descrição
has_more	boolean	Indica se há mais dados disponíveis.
last_id	string	O ID do último assistente nos dados retornados.
first_id	string	O ID do primeiro assistente nos dados retornados.
data	array	Uma lista de objetos de agente.
object	string	O formato dos dados, como `"list"`.
request_id	string	O ID da solicitação.
status_code	integer	O código de status da solicitação.

Recuperar Agente

HTTP

Exemplo de código

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"

Parâmetros da solicitação

Nome do parâmetro de entrada	Descrições do parâmetro de entrada	Tipo	Obrigatório
assistant_id	O ID do agente a ser recuperado.	str	Sim

Resposta

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

Parâmetros da resposta

O objeto assistente recuperado.

SDK

Exemplo de código

from dashscope import Assistants
import os

assistant = Assistants.retrieve(
    assistant_id='your_assistant_id',
    # Set the environment variable. If you have not, replace the following line with your Model Studio API key: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY")
)

print(assistant)

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;

public class RetrieveAssistantExample {
    public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
        Assistants assistants = new Assistants();
        // Set the environment variable. If you have not, replace the following line with your Model Studio API key: api_key="sk-xxx"
        String apiKey = System.getenv("DASHSCOPE_API_KEY");
        Assistant assistant = assistants.retrieve("assistant_id", apiKey);
        System.out.println(assistant);
    }
}

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',
    # Set the environment variable. If you have not, replace the following line with your Model Studio API key: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY")
)

print(assistant)

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();
      // Set the environment variable. If you have not, replace the following line with your Model Studio API key: api_key="sk-xxx"
      String apiKey = System.getenv("DASHSCOPE_API_KEY");
      Assistant assistant = assistants.retrieve("assistant_id", apiKey);
    }
}

Parâmetros da solicitação

Parâmetro	Tipo	Padrão	Descrição
assistant_id	string	-	O ID do agente a ser recuperado.
workspace	string	None	O ID do workspace do Model Studio. Necessário apenas quando `api_key` for uma chave de API de sub-workspace.
api_key	string	None	A chave de API do Model Studio. Para mais detalhes, consulte Configurar a chave de API como variável de ambiente.

Parâmetros da resposta

Para mais informações, consulte Objeto Assistente.

Atualizar um agente

HTTP

Exemplo de código

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"
}'

Parâmetros da solicitação

Nome do parâmetro de entrada	Descrições do parâmetro de entrada	Tipo	Obrigatório
assistant_id	O ID do agente a ser recuperado	str	Sim
*	Outros parâmetros de entrada opcionais.	str	Não
model	O ID do modelo utilizado pelo agente.	str	Sim
name	O nome do agente.	str	Não
description	A descrição do agente.	str	Não
instructions	O prompt do sistema para o LLM no agente.	str	Não
tools	Uma lista de ferramentas que o agente pode chamar. As ferramentas devem estar registradas no Alibaba Cloud Model Studio.	Optional[List[Dict]]	Não (padrão: [])
file_ids	O ID de um arquivo que o agente pode utilizar. Faça o upload do arquivo antecipadamente para obter o ID correspondente.	Optional[str]	Não (padrão: [])
metadata	Armazena outros parâmetros relacionados ao agente.	Dict	Não

Resposta

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

Parâmetros da resposta

O objeto assistente atualizado.

SDK

Exemplo de código

from dashscope import Assistants
import os

assistants = Assistants.update(
    'assistant_id', 
    model='new_model_name',
    # Set the environment variable. If you have not, replace the following line with your Model Studio API key: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY")
)

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;

public class Main {
    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.")
                // Set the environment variable. If you have not, replace the following line with your Model Studio API key: api_key="sk-xxx"
                .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                .build();
        
        Assistant assistant = assistants.update("assistant_id", param);
    }
}

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',
    # Set the environment variable. If you have not, replace the following line with your Model Studio API key: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY")
)

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.")
                // Set the environment variable. If you have not, replace the following line with your Model Studio API key: api_key="sk-xxx"
                .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                .build();
        
        Assistant assistant = assistants.update("assistant_id", param);
    }
}

Parâmetros da solicitação

Parâmetro	Tipo	Padrão	Descrição
assistant_id	string	-	O ID do assistente a ser atualizado.
model	string	-	O modelo utilizado pelo agente.
name	string	None	O nome do agente.
description	string	None	A descrição do agente.
instructions	string	None	Permite especificar as informações de recursos do agente.
tools	array	[]	As ferramentas utilizadas pelo agente.
file_ids	array	[]	O ID do arquivo utilizado pelo agente.
metadata	object	None	As informações associadas ao agente.
workspace	string	None	O ID do workspace do Model Studio. Necessário apenas quando `api_key` for uma chave de API de sub-workspace.
api_key	string	None	Para a chave de API do Alibaba Cloud Model Studio, recomendamos definir a chave de API como variável de ambiente.

Parâmetros da resposta

Para mais informações, consulte Objeto Assistente.

Excluir um agente

HTTP

Exemplo de código

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"

Parâmetros da solicitação

Nome do parâmetro de entrada	Descrição	Tipo	Obrigatório
assistant_id	O ID do agente a ser recuperado.	str	Sim

Resposta

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

Parâmetros da resposta

Retorna o status do agente excluído.

SDK

Exemplo de código

from dashscope import Assistants
import os

assistants = Assistants.delete(
    'assistant_id',
    # Set the environment variable. If you have not, replace the following line with your Model Studio API key: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY")
)

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;

public class Main {
    public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
        Assistants assistants = new Assistants();     
        // Set the environment variable. If you have not, replace the following line with your Model Studio API key: api_key="sk-xxx"
        String apiKey = System.getenv("DASHSCOPE_API_KEY");
        DeletionStatus assistant = assistants.delete("assistant_id", apiKey);
    }
}

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',
    # Set the environment variable. If you have not, replace the following line with your Model Studio API key: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY")
)

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();     
        // Set the environment variable. If you have not, replace the following line with your Model Studio API key: api_key="sk-xxx"
        String apiKey = System.getenv("DASHSCOPE_API_KEY");
        DeletionStatus assistant = assistants.delete("assistant_id", apiKey);
    }
}

Parâmetros da solicitação

Parâmetro	Tipo	Padrão	Descrição
assistant_id	string	-	O ID do agente a ser excluído.
workspace	string	None	O ID do workspace do Model Studio. Necessário apenas quando `api_key` for uma chave de API de sub-workspace.
api_key	string	None	Para sua chave de API do Alibaba Cloud Model Studio, recomendamos configurá-la como variável de ambiente (Este tópico será despublicado e mesclado em 'Configurar chave de API').

Parâmetros da resposta

Nome do campo	Tipo	Descrição
id	string	O ID do objeto excluído.
object	string	O alvo da solicitação. Exemplo: `'assistant.deleted'`
deleted	boolean	Confirmação de exclusão
request_id	string	O ID da solicitação.
status_code	integer	O código de status da solicitação.

Objeto Agente

Um objeto Assistant capaz de chamar modelos e utilizar ferramentas.

Exemplo de Objeto Agente

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

Nome do parâmetro	Tipo de dados	Descrição
id	string	O identificador exclusivo do agente, correspondente ao ID do assistente.
object	string	O tipo do objeto. Sempre definido como `assistant`.
created_at	integer	O timestamp Unix de 13 dígitos, em milissegundos, indicando a criação do agente.
model	string	O nome do modelo utilizado pelo agente. Consulte todos os modelos disponíveis na Visão geral da API de Assistentes ou veja a Lista de modelos para mais detalhes.
name	string	O nome do agente.
description	string	A descrição do agente.
instructions	string	As instruções de sistema utilizadas pelo agente.
tools	array	Uma lista de ferramentas habilitadas no agente. Podem ser plugins oficiais (como `code_interpreter`, `quark_search` ou `text_to_image`), geração aumentada por recuperação (RAG) ou chamada de funções.
metadata	dict	Informações adicionais sobre o objeto agente armazenadas em formato estruturado.
temperature	float	A temperatura de amostragem, variando entre 0 e 2. Valores mais altos, como 1, tornam a saída mais aleatória. Valores menores, como 0,2, resultam em saídas mais focadas e determinísticas.
top_p	float	Uma alternativa à amostragem por temperatura, denominada amostragem de núcleo. Neste método, o LLM seleciona resultados de tokens cuja massa cumulativa de probabilidade atinja `top_p`. Um valor de 0,1 considera apenas os tokens que compõem os 10% superiores da massa de probabilidade. Ajuste este parâmetro ou `temperature`, mas nunca ambos simultaneamente.
top_k	integer	Semelhante ao `top_p`, porém a amostra é selecionada entre os k tokens de maior probabilidade, independentemente da massa cumulativa. Não ajuste este parâmetro juntamente com `temperature` ou `top_p` ao mesmo tempo.
max_tokens	integer	O número máximo de tokens que o agente pode gerar em uma única vez.
request_id	string	O identificador exclusivo da chamada associada ao agente.

Códigos de erro

Se uma chamada de modelo falhar e retornar uma mensagem de erro, consulte Códigos de erro para obter informações de solução de problemas.