Skip to main content

Messages (Deprecated)

Cette rubrique explique comment utiliser la classe Message de l'API Assistant pour créer, lister, récupérer et modifier des messages.

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.

Nom de la fonction

Type

create

Créer une classe de message

retrieve

Récupérer une classe de message

modify

Modifier une classe de message

list

Lister les classes de messages

Créer un message

  • HTTP
  • SDK
Exemple de code
curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/threads/thread_e99a9fe7-0433-426f-98ad-a5139c36579c/messages' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
--data '{
    "role": "user",
    "content": "Who are you",
    "metadata": {}
}'
Paramètres de la requête

Nom du paramètre

Paramètres d'entrée

Type de paramètre

Obligatoire

thread id

ID du thread auquel transmettre le message.

string

Oui

content

Contenu du message.

string

Oui

role

Rôle de l'entité émettrice du message. Seule la valeur user est prise en charge.

string

Non

metadata

Autres informations associées.

object

Non

Réponse
{
    "id": "message_f1933671-19e1-4162-ad25-7326165123e1",
    "object": "thread.message",
    "created_at": 1711508433283,
    "thread_id": "thread_e99a9fe7-0433-426f-98ad-a5139c36579c",
    "incomplete_details": {},
    "completed_at": null,
    "incomplete_at": null,
    "assistant_id": "",
    "run_id": "",
    "file_ids": [],
    "role": "user",
    "content": [
        {
            "type": "text",
            "text": {
                "value": "Who are you",
                "annotations": []
            }
        }
    ],
    "metadata": {},
    "name": "",
    "plugin_call": {},
    "tool_calls": [],
    "status": "",
    "request_id": "b3ad40b9-f052-9665-a064-dab11c34625f"
}
Paramètres de la réponseLa classe de message est retournée. Outre les paramètres de la requête, la réponse contient les champs suivants :
  • id : ID du message.
  • request_id : ID de la requête.

Lister les messages

  • HTTP
  • SDK
Exemple de code
curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/threads/thread_e99a9fe7-0433-426f-98ad-a5139c36579c/messages?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

Description

Type de paramètre

Obligatoire

thread id

ID du thread auquel transmettre le message.

string

Oui

limit

Nombre de messages.

integer

Non

order

Ordre de tri par date de création : asc ou desc.

string

Non (Par défaut : desc)

Réponse
{
    "object": "list",
    "data": [
        {
            "id": "message_f1933671-19e1-4162-ad25-7326165123e1",
            "object": "thread.message",
            "created_at": 1711508433283,
            "thread_id": "thread_e99a9fe7-0433-426f-98ad-a5139c36579c",
            "assistant_id": "",
            "run_id": "",
            "role": "user",
            "content": [
                {
                    "type": "text",
                    "text": {
                        "value": "Who are you",
                        "annotations": []
                    }
                }
            ],
            "metadata": {},
            "name": "",
            "plugin_call": {},
            "tool_calls": [],
            "status": ""
        }
    ],
    "first_id": "message_f1933671-19e1-4162-ad25-7326165123e1",
    "last_id": "message_f1933671-19e1-4162-ad25-7326165123e1",
    "has_more": false,
    "request_id": "78f7d607-4a9a-90c6-8040-d3f81c84d60a"
}
Paramètres de la réponseUne liste de classes de messages est retournée. La réponse inclut également les paramètres de la requête d'origine ainsi que les champs supplémentaires suivants :
  • Liste contenant plusieurs messages.

Récupérer un message

  • HTTP
  • SDK
Exemple de code
curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/threads/thread_e99a9fe7-0433-426f-98ad-a5139c36579c/messages/message_ea26d29d-4509-490e-98e9-9f6238bd821b' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"
Paramètres de la requête

Nom du paramètre

Description

Type de paramètre

Obligatoire

thread id

ID du thread contenant le message à récupérer.

string

Oui

message_id

ID du message à récupérer.

string

Oui

Réponse
{
    "id": "message_ea26d29d-4509-490e-98e9-9f6238bd821b",
    "object": "thread.message",
    "created_at": 1711508622598,
    "thread_id": "thread_e99a9fe7-0433-426f-98ad-a5139c36579c",
    "assistant_id": "",
    "run_id": "",
    "role": "user",
    "content": [
        {
            "type": "text",
            "text": {
                "value": "Hello",
                "annotations": []
            }
        }
    ],
    "metadata": {},
    "name": "",
    "plugin_call": {},
    "tool_calls": [],
    "status": "",
    "request_id": "4d5ce962-91c3-9edb-87f7-00bbf985135e"
}
Paramètres de la réponseLa classe de message récupérée est retournée. Outre les paramètres de la requête, la réponse contient les champs suivants :
  • id : ID du message.
  • request_id : ID de la requête.

Modifier un message

  • HTTP
  • SDK
Exemple de code
curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/threads/thread_e99a9fe7-0433-426f-98ad-a5139c36579c/messages/message_ea26d29d-4509-490e-98e9-9f6238bd821b' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
--data '{
    "metadata": {
        "modified": "true",
        "user": "abc123"
    }
}'
Paramètres de la requête

Nom du paramètre

Paramètres d'entrée

Type de paramètre

Obligatoire

thread_id

ID du thread à modifier.

string

Oui

message_id

ID du message à modifier.

string

Oui

metadata

Métadonnées.

dict

Réponse
{
    "id": "message_ea26d29d-4509-490e-98e9-9f6238bd821b",
    "object": "thread.message",
    "created_at": 1711508622598,
    "thread_id": "thread_e99a9fe7-0433-426f-98ad-a5139c36579c",
    "incomplete_details": {},
    "completed_at": null,
    "incomplete_at": null,
    "assistant_id": "",
    "run_id": "",
    "file_ids": [],
    "role": "user",
    "content": [
        {
            "type": "text",
            "text": {
                "value": "Hello",
                "annotations": []
            }
        }
    ],
    "metadata": {
        "modified": "true",
        "user": "abc123"
    },
    "name": "",
    "plugin_call": {},
    "tool_calls": [],
    "status": "",
    "request_id": "7877b011-cb94-9df1-9add-dc42b7d611f6"
}
Paramètres de sortieLa classe de message modifiée est retournée. Outre les paramètres de la requête, la réponse contient les champs suivants :
  • id : ID du message.
  • request_id : ID de la requête.

Codes d'erreur

Si un appel à l'API Assistant échoue et renvoie un message d'erreur, consultez la rubrique Messages d'erreur pour résoudre le problème.