Asistentes (Descontinuado)

La API de Asistentes está siendo descontinuada. Migre a la API de Responses como alternativa. La API de Responses incluye múltiples herramientas integradas y admite la gestión de contexto de múltiples turnos.

Características: Para más información sobre las características y el uso básico de la API de asistentes, consulte Descripción general de la API de Asistentes.

Persistencia: Todas las instancias de asistente se guardan en el servidor de Alibaba Cloud Model Studio y no tienen fecha de caducidad. Puede recuperar un asistente utilizando su assistant.id.

Aplicación de Agente (Agente 1.0) y los asistentes son dos tipos de aplicaciones LLM con diferentes características y usos.

Aplicaciones de agente: Puede crear, ver, actualizar y eliminar aplicaciones de agente únicamente en la consola. Puede invocarlas mediante la API de llamada de aplicaciones.
Asistentes: Puede crear, ver, actualizar, eliminar e invocar asistentes únicamente mediante la API de asistentes.

Crear un agente

Crea un nuevo asistente.

HTTP
SDK

Ejemplo 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 de solicitud

Nombre del parámetro	Descripción	Tipo	Obligatorio
model	El modelo que utiliza el agente.	str	Sí
name	El nombre del agente.	str	No
description	La descripción del agente.	str	No
instructions	El prompt del sistema para el LLM en el agente.	str	No
tools	Una lista de herramientas que el agente puede llamar.Transmite información de autenticación para un 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]]	No (predeterminado: [])
metadata	Otros parámetros relacionados con el agente. Este parámetro se utiliza para almacenar otros parámetros relacionados.	Dict	No
temperature	Controla el grado de aleatoriedad y diversidad.	float	No
top_p	El umbral de probabilidad para el método de muestreo de núcleo durante la generación.	float	No
top_k	El tamaño del conjunto de candidatos para el muestreo durante la generación.	integer	No

Respuesta

{
    "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 de respuestaUn objeto assistant.

Ejemplo de código

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/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)

Parámetros de solicitud

Parámetro	Tipo	Predeterminado	Descripción
model	string	-	El modelo que utiliza el agente.
name	string	-	El nombre del agente.
description	string	-	La descripción del agente.
instructions	string	-	Especificar características del agente
tools	array	[]	Las herramientas que utiliza el agente. Transmite información de autenticación para una herramienta personalizada. `{` `"type": "plugin_type", "auth": {"type": "user_http","user_token": "bearer-token", }` `}` Cuando el asistente solicita un plugin, coloca el token portador en `{"plugin_type":{"user_token": "bearer-token"}}` y lo añade al encabezado de la llamada del plugin.
metadata	object	None	La información asociada con el agente.
workspace	string	None	El ID del espacio de trabajo de Model Studio. Este parámetro es obligatorio solo cuando `api_key` es una clave de API de subespacio de trabajo.
api_key	string	None	Para la clave de API de Alibaba Cloud Model Studio, le recomendamos que la establezca como variable de entorno (Este tema se dejará de publicar y se fusionará en 'Configurar clave de API').

Respuesta

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

Nombre del campo	Tipo	Descripción
status_code	integer	El código de estado HTTP de la llamada. Un valor de 200 indica éxito. Otros valores indican un error.
name	string	El nombre del agente.
id	string	El ID del agente, que es una cadena UUID.
model	string	El nombre del modelo que utiliza el agente.
description	string	La descripción del agente.
instructions	string	Puede especificar la información de características del agente.
metadata	object	Los metadatos del agente.
tools	array	Una lista de herramientas que el agente puede usar.
created_at	integer	La marca de tiempo UNIX cuando se creó el agente.
code	string	Indica que la solicitud falló. Este es el código de error. Este parámetro se ignora si la solicitud tiene éxito. Este parámetro solo se devuelve cuando falla una llamada desde Python.
message	string	Indica que la solicitud falló. Este parámetro proporciona detalles sobre el fallo. Este parámetro se ignora si la solicitud tiene éxito. Este parámetro solo se devuelve cuando falla una llamada desde Python.

Listar agentes

Devuelve una lista de asistentes.

HTTP
SDK

Ejemplo 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 de solicitud

Nombre del parámetro de entrada	Descripciones de los parámetros de entrada	Tipo	Obligatorio
limit	Número de agentes	int	No
order	El orden de clasificación por hora de creación.	str	No (predeterminado: `desc`)

Respuesta

{
    "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 de respuestaUna lista de objetos assistant.

Ejemplo de código

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'
)

Parámetros de solicitud

Parámetro	Tipo	Predeterminado	Descripción
limit	string	None	El número de asistentes a listar. Si no se especifica este parámetro, se utiliza el valor predeterminado del servidor.
order	string	None	El orden de clasificación. Valores válidos: `desc` (descendente) y `asc` (ascendente). Si no se especifica este parámetro, se utiliza el valor predeterminado del servidor.
workspace	string	None	El ID del espacio de trabajo de Model Studio. Este parámetro es obligatorio solo cuando `api_key` es una clave de API de subespacio de trabajo.
api_key	string	None	Para la clave de API de Alibaba Cloud Model Studio, le recomendamos que la configure en una variable de entorno.

Parámetros de respuesta

Nombre del campo	Tipo	Descripción
has_more	boolean	Indica si hay más datos disponibles.
last_id	string	El ID del último asistente en los datos.
first_id	string	El ID del primer asistente en los datos.
data	array	Una lista de objetos de agente.
object	string	El formato de los datos, como `"list"`.
request_id	string	El ID de la solicitud.
status_code	integer	El código de estado de la solicitud.

Agente de recuperación

HTTP
SDK

Ejemplo 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 de solicitud

Nombre del parámetro de entrada	Descripciones de los parámetros de entrada	Tipo	Obligatorio
assistant_id	El ID del agente que se va a recuperar.	str	Sí

Respuesta

{
    "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 de respuestaEl objeto assistant recuperado.

Ejemplo de código

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)

Parámetros de solicitud

Parámetro	Tipo	Predeterminado	Descripción
assistant_id	string	-	El ID del agente que se va a recuperar.
workspace	string	None	El ID del espacio de trabajo de Model Studio. Este parámetro es obligatorio solo cuando `api_key` es una clave de API de subespacio de trabajo.
api_key	string	None	La clave de API de Model Studio. Para más información, consulte Configurar la clave de API como variable de entorno.

Parámetros de respuestaPara más información, consulte Objeto Assistant.

Actualizar un agente

HTTP
SDK

Ejemplo 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 de solicitud

Nombre del parámetro de entrada	Descripciones de los parámetros de entrada	Tipo	Obligatorio
assistant_id	El ID del agente que se va a recuperar	str	Sí
*	Otros parámetros de entrada opcionales.	str	No
model	El ID del modelo que utiliza el agente.	str	Sí
nombre	El nombre del agente.	str	No
description	La descripción del agente.	str	No
instructions	El prompt del sistema para el LLM en el agente.	str	No
tools	Una lista de herramientas que el agente puede invocar. Las herramientas deben estar registradas en Alibaba Cloud Model Studio.	Optional[List[Dict]]	No (predeterminado: [])
metadata	Almacena otros parámetros relacionados para el agente.	Dict	No

Respuesta

{
    "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 de respuestaEl objeto assistant actualizado.

Ejemplo de código

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

Parámetros de solicitud

Parámetro	Tipo	Predeterminado	Descripción
assistant_id	string	-	El ID del asistente que se va a actualizar.
model	string	-	El modelo que utiliza el agente.
name	string	None	El nombre del agente.
description	string	None	La descripción del agente.
instructions	string	None	Puede especificar la información de características del agente.
tools	array	[]	Las herramientas que utiliza el agente.
metadata	object	None	La información asociada con el agente.
workspace	string	None	El ID del espacio de trabajo de Model Studio. Este parámetro es obligatorio solo cuando `api_key` es una clave de API de subespacio de trabajo.
api_key	string	None	Para la clave de API de Alibaba Cloud Model Studio, le recomendamos que la establezca como variable de entorno.

Parámetros de respuestaPara más información, consulte Objeto Assistant.

Eliminar un agente

HTTP
SDK

Ejemplo 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 de solicitud

Nombre del parámetro de entrada	Descripción	Tipo	Obligatorio
assistant_id	El ID del agente que se va a recuperar.	str	Sí

Respuesta

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

Parámetros de respuestaMuestra el estado del agente eliminado.

Ejemplo de código

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

Parámetros de solicitud

Parámetro	Tipo	Predeterminado	Descripción
assistant_id	string	-	El ID del agente que se va a eliminar.
workspace	string	None	El ID del espacio de trabajo de Model Studio. Este parámetro es obligatorio solo cuando `api_key` es una clave de API de subespacio de trabajo.
api_key	string	None	Para su clave de API de Alibaba Cloud Model Studio, le recomendamos que la establezca como variable de entorno (Este tema se dejará de publicar y se fusionará en 'Configurar clave de API').

Parámetros de respuesta

Nombre del campo	Tipo	Descripción
id	string	El ID del objeto eliminado.
object	string	El objetivo de la solicitud. Ejemplo: `'assistant.deleted'`
deleted	boolean	Confirmar eliminación
request_id	string	El ID de la solicitud.
status_code	integer	El código de estado de la solicitud.

Objeto del agente

Un objeto Assistant que puede invocar modelos y utilizar herramientas. Ejemplo de objeto de 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"
}

Nombre del parámetro	Tipo de datos	Descripción
id	string	El identificador único del agente, que corresponde al ID del asistente.
object	string	El tipo de objeto. Siempre es `assistant`.
created_at	integer	La marca de tiempo Unix de 13 dígitos, en milisegundos, cuando se creó el agente.
model	string	El nombre del modelo que utiliza el agente. Puede ver todos los modelos disponibles en la Descripción general de la API de Asistentes o consultar la Lista de modelos para más detalles.
name	string	El nombre del agente.
description	string	La descripción del agente.
instructions	string	Las instrucciones del sistema que utiliza el agente.
tools	array	Una lista de herramientas habilitadas en el agente. La herramienta puede ser un plugin oficial (como `code_interpreter`, `quark_search` o `text_to_image`), generación aumentada por recuperación (RAG) o llamada de funciones.
metadata	dict	Información adicional sobre el objeto del agente almacenada en un formato estructurado.
temperature	float	La temperatura de muestreo, que está entre 0 y 2. Un valor más alto, como 1, hace que la salida sea más aleatoria. Un valor más bajo, como 0.2, hace que la salida sea más enfocada y determinista.
top_p	float	Una alternativa al muestreo por temperatura, llamada muestreo de núcleo. En este método de muestreo, el LLM selecciona los resultados de tokens que tienen una masa de probabilidad acumulada de `top_p`. Un valor de 0.1 significa que solo se consideran los tokens que componen el 10% superior de la masa de probabilidad. Ajuste este parámetro o `temperature`, pero no ambos.
top_k	integer	Similar a `top_p`, pero la muestra se selecciona de los k tokens con mayor probabilidad, independientemente de su masa de probabilidad acumulada. No ajuste este parámetro junto con `temperature` o `top_p` al mismo tiempo.
max_tokens	integer	El número máximo de tokens que el agente puede generar a la vez.
request_id	string	El identificador único de la llamada asociada al agente.

Códigos de error

Si una llamada al modelo falla y devuelve un mensaje de error, consulte Códigos de error para obtener información sobre solución de problemas.

​Crear un agente

​Listar agentes

​Agente de recuperación

​Actualizar un agente

​Eliminar un agente

​Objeto del agente

​Códigos de error

Crear un agente

Listar agentes

Agente de recuperación

Actualizar un agente

Eliminar un agente

Objeto del agente

Códigos de error