Skip to main content

Assistants (Deprecated)

L'API Assistant simplifie la création d'assistants, un type d'application basée sur les grands modèles de langage (LLM). Cette rubrique décrit les méthodes fournies par l'API Assistant pour gérer ces assistants : création, liste, récupération, mise à jour et suppression.

L'API Assistant est en cours de dépréciation. Migrez vers l'API Responses comme alternative. L'API Responses intègre plusieurs outils natifs et prend en charge la gestion du contexte multi-tours.
Fonctionnalités : Pour plus d'informations sur les fonctionnalités et l'utilisation de base de l'API Assistant, consultez la Présentation de l'API Assistant .
Persistance : Toutes les instances d'assistant sont enregistrées sur le serveur Alibaba Cloud Model Studio sans date d'expiration. Récupérez un assistant à l'aide de son assistant.id.
L'Application Agent (Agent 1.0) et les assistants constituent deux types d'applications LLM aux fonctionnalités et usages distincts.
  • Applications Agent : créez, consultez, mettez à jour et supprimez les applications agent uniquement dans la console. Appelez-les via l'API d'appel d'application.
  • Assistants : créez, consultez, mettez à jour, supprimez et appelez les assistants exclusivement via l'API Assistant.

Créer un agent

Crée un nouvel assistant.
  • HTTP
  • SDK
Exemple de code
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": {}
}'
Paramètres de la requête
Nom du paramètreDescriptionTypeObligatoire
modelModèle utilisé par l'agent.strOui
nameNom de l'agent.strNon
descriptionDescription de l'agent.strNon
instructionsInvite système pour le LLM de l'agent.strNon
toolsListe des outils que l'agent peut appeler.Transmet les informations d'authentification pour un plugin personnalisé.
{
 "type": "${plugin_id}",
     "auth": {  # This field is used only for user-level authentication.
         "type": "user_http",
         "user_token": "bearer-token",
         }
 }
Optional[List[Dict]]Non (par défaut : [])
metadataAutres paramètres liés à l'agent. Ce paramètre permet de stocker des informations complémentaires.DictNon
temperatureContrôle le degré d'aléatoire et de diversité.floatNon
top_pSeuil de probabilité pour la méthode d'échantillonnage par noyau lors de la génération.floatNon
top_kTaille de l'ensemble des candidats pour l'échantillonnage lors de la génération.integerNon
Réponse
{
    "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"
}
Paramètres de la réponseUn objet assistant.

Lister les agents

Retourne une liste d'assistants.
  • HTTP
  • SDK
Exemple de code
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"
Paramètres de la requête

Nom du paramètre d'entrée

Description du paramètre d'entrée

Type

Obligatoire

limit

Nombre d'agents

int

Non

order

Ordre de tri par date de création.

str

Non (par défaut : desc)

Réponse
{
    "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"
}
Paramètres de la réponseUne liste d'objets assistant.

Récupérer un agent

  • HTTP
  • SDK
Exemple de code
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"
Paramètres de la requête

Nom du paramètre d'entrée

Description du paramètre d'entrée

Type

Obligatoire

assistant_id

ID de l'agent à récupérer.

str

Oui

Réponse
{
    "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"
}
Paramètres de la réponseL'objet assistant récupéré.

Mettre à jour un agent

  • HTTP
  • SDK
Exemple de code
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"
}'
Paramètres de la requête

Nom du paramètre d'entrée

Description du paramètre d'entrée

Type

Obligatoire

assistant_id

ID de l'agent à récupérer

str

Oui

*

Autres paramètres d'entrée facultatifs.

str

Non

model

ID du modèle utilisé par l'agent.

str

Oui

name

Nom de l'agent.

str

Non

description

Description de l'agent.

str

Non

instructions

Invite système pour le LLM de l'agent.

str

Non

tools

Liste des outils que l'agent peut appeler. Ces outils doivent être enregistrés dans Alibaba Cloud Model Studio.

Optional[List[Dict]]

Non (par défaut : [])

metadata

Stocke d'autres paramètres connexes pour l'agent.

Dict

Non

Réponse
{
    "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"
}
Paramètres de la réponseL'objet assistant mis à jour.

Supprimer un agent

  • HTTP
  • SDK
Exemple de code
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"
Paramètres de la requête

Nom du paramètre d'entrée

Description

Type

Obligatoire

assistant_id

ID de l'agent à supprimer.

str

Oui

Réponse
{
    "id": "asst_0678aa33-43e2-4268-95e6-b0010f9f7937",
    "object": "assistant.deleted",
    "deleted": true,
    "request_id": "6af9320f-0430-9d01-b92f-d1beb6424dc5"
}
Paramètres de la réponseRetourne l'état de l'agent supprimé.

Objet Agent

Un objet Assistant capable d'appeler des modèles et d'utiliser des outils. Exemple d'objet Agent
{
    "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"
}

Nom du paramètre

Type de données

Description

id

string

Identifiant unique de l'agent, correspondant à l'ID de l'assistant.

object

string

Type d'objet. Toujours assistant.

created_at

integer

Horodatage Unix à 13 chiffres, en millisecondes, indiquant la date de création de l'agent.

model

string

Nom du modèle utilisé par l'agent. Consultez la Présentation de l'API Assistant pour voir tous les modèles disponibles, ou référez-vous à la Liste des modèles pour plus de détails.

name

string

Nom de l'agent.

description

string

Description de l'agent.

instructions

string

Instructions système utilisées par l'agent.

tools

array

Liste des outils activés sur l'agent. L'outil peut être un plugin officiel (tel que code_interpreter, quark_search ou text_to_image), une génération augmentée par récupération (RAG) ou un appel de fonction.

metadata

dict

Informations supplémentaires sur l'objet agent, stockées dans un format structuré.

temperature

float

Température d'échantillonnage, comprise entre 0 et 2. Une valeur élevée, comme 1, rend la sortie plus aléatoire. Une valeur faible, comme 0,2, rend la sortie plus ciblée et déterministe.

top_p

float

Alternative à l'échantillonnage par température, appelée échantillonnage par noyau. Dans cette méthode, le LLM sélectionne les résultats de tokens dont la masse de probabilité cumulative atteint top_p. Une valeur de 0,1 signifie que seuls les tokens constituant les 10 % supérieurs de la masse de probabilité sont pris en compte.

Ajustez ce paramètre ou temperature, mais pas les deux simultanément.

top_k

integer

Similaire à top_p, mais l'échantillon est sélectionné parmi les k tokens ayant la probabilité la plus élevée, indépendamment de leur masse de probabilité cumulative.

N'ajustez pas ce paramètre en même temps que temperature ou top_p.

max_tokens

integer

Nombre maximal de tokens que l'agent peut générer en une seule fois.

request_id

string

Identifiant unique de l'appel associé à l'agent.

Codes d'erreur

Si un appel de modèle échoue et renvoie un message d'erreur, consultez les Codes d'erreur pour obtenir des informations de dépannage.