La gestion manuelle des listes de messages pour des conversations s'étendant sur plusieurs appareils ou comportant de longues interruptions peut entraîner une perte de contexte. Alibaba Cloud Model Studio fournit une API Conversations compatible avec OpenAI, utilisable conjointement avec l'API Responses pour injecter automatiquement le contexte historique. Cette fonctionnalité supprime la nécessité de synchroniser manuellement les messages et garantit la continuité des conversations dans différents scénarios et sur divers appareils.
Créer une conversation
Créez une nouvelle conversation. Vous pouvez inclure des éléments de message initiaux.
Chine du Nord 2 (Pékin) : POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/conversations
Singapour : POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/conversations
itemsarray (Facultatif)Liste pouvant contenir jusqu'à 20 éléments de message initiaux.
Propriétés type string(Obligatoire)Type de message. Seul message est pris en charge.rolestring(Obligatoire)Rôle associé au message. Les instructions provenant des rôles system et developer ont une priorité supérieure à celles du rôle user. Le rôle assistant désigne les messages générés par le modèle lors d'interactions précédentes. Valeurs valides : user, assistant, system et developer.contentstring or array(Obligatoire)Contenu du message. Ce paramètre accepte des chaînes de texte brut ou des listes de contenu structuré, telles que des tableaux d'objets ResponseInputText. Le format de liste peut inclure divers types de contenu, notamment du texte. | Python |
metadataobject (Facultatif)Métadonnées de la conversation. Utilisez ce paramètre pour stocker des informations complémentaires sous forme structurée. Spécifiez jusqu'à 16 paires clé-valeur. La clé peut comporter jusqu'à 64 caractères et la valeur jusqu'à 512 caractères. |
Paramètres de réponse
created_atintegerHorodatage Unix en millisecondes indiquant la date de création de la conversation. | |
idstringID unique de la conversation. | |
metadataobjectMétadonnées de la conversation. Ce paramètre stocke des informations supplémentaires sous forme de paires clé-valeur. Il peut contenir jusqu'à 16 paires. La clé peut comporter jusqu'à 64 caractères et la valeur jusqu'à 512 caractères. | |
objectstringType d'objet. La valeur est fixée à conversation. |
Récupérer une conversation
Récupère les informations relatives à une conversation spécifiée.
Chine du Nord 2 (Pékin) : GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}
Singapour : GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}
conversation_idstring(Obligatoire, Chemin)ID de la conversation. | Python |
Paramètres de réponse
created_atintegerHorodatage Unix en millisecondes indiquant la date de création de la conversation. | |
idstringID unique de la conversation. | |
metadataobjectMétadonnées de la conversation. Ce paramètre stocke des informations supplémentaires sous forme de paires clé-valeur. Il peut contenir jusqu'à 16 paires. La clé peut comporter jusqu'à 64 caractères et la valeur jusqu'à 512 caractères. | |
objectstringType d'objet. La valeur est fixée à conversation. |
Mettre à jour une conversation
Met à jour les métadonnées d'une conversation.
Chine du Nord 2 (Pékin) : POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}
Singapour : POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}
conversation_idstring(Obligatoire, Chemin)ID de la conversation. | Python |
metadataobject(Obligatoire)Métadonnées de la conversation. Ce paramètre remplace intégralement les métadonnées existantes. Spécifiez jusqu'à 16 paires clé-valeur. La clé peut comporter jusqu'à 64 caractères et la valeur jusqu'à 512 caractères. |
Paramètres de réponse
created_atintegerHorodatage Unix en millisecondes indiquant la date de création de la conversation. | |
idstringID unique de la conversation. | |
metadataobjectMétadonnées de la conversation. Ce paramètre stocke des informations supplémentaires sous forme de paires clé-valeur. Il peut contenir jusqu'à 16 paires. La clé peut comporter jusqu'à 64 caractères et la valeur jusqu'à 512 caractères. | |
objectstringType d'objet. La valeur est fixée à conversation. |
Supprimer une conversation
Supprime une conversation spécifiée. Les éléments de message qu'elle contient ne sont pas supprimés.
Chine du Nord 2 (Pékin) : DELETE https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}
Singapour : DELETE https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}
conversation_idstring(Obligatoire, Chemin)ID de la conversation. | Python |
Paramètres de réponse
deletedbooleanIndique si la suppression a réussi. | |
idstringID de la conversation supprimée. | |
objectstringType d'objet. La valeur est fixée à conversation.deleted. |
Créer des éléments
Ajoute des éléments de message à une conversation spécifiée.
Chine du Nord 2 (Pékin) : POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}/items
Singapour : POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}/items
conversation_idstring(Obligatoire, Chemin)ID de la conversation. | Python |
itemsarray(Obligatoire)Liste d'éléments de message. Vous pouvez ajouter jusqu'à 20 éléments à la fois.
Propriétés type string(Obligatoire)Type de message. Seul message est pris en charge.rolestring(Obligatoire)Rôle associé au message. Les instructions provenant des rôles system et developer ont une priorité supérieure à celles du rôle user. Le rôle assistant désigne les messages générés par le modèle lors d'interactions précédentes. Valeurs valides : user, assistant, system et developer.contentstring or array(Obligatoire)Contenu du message. Ce paramètre accepte des chaînes de texte brut ou des listes de contenu structuré, telles que des tableaux d'objets ResponseInputText. Le format de liste peut inclure divers types de contenu, notamment du texte. |
Paramètres de réponse
dataarray[object]Liste des éléments de message créés.
Propriétés id stringID unique de l'élément de message.contentstring or arrayContenu du message. Il peut s'agir d'une chaîne de texte brut ou d'une liste de contenu structuré, telle qu'un tableau d'objets ResponseInputText.rolestringRôle du message. Valeurs valides : user, assistant, system et developer.statusstringÉtat de traitement du message. Valeurs valides : in_progress, completed et incomplete.typestringType de l'élément de message. La valeur est fixée à message. | |
first_idstringID du premier élément de message de la liste. | |
has_morebooleanIndique si des données supplémentaires sont disponibles. | |
last_idstringID du dernier élément de message de la liste. |
Lister les éléments
Liste tous les éléments de message d'une conversation.
Chine du Nord 2 (Pékin) : GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}/items
Singapour : GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}/items
conversation_idstring(Obligatoire, Chemin)ID de la conversation. | Python |
afterstring (Facultatif)Curseur de pagination. Ne retourne que les éléments de message créés après l'ID de message spécifié. | |
orderstring (Facultatif)Ordre de tri. Valeurs valides : asc pour un ordre croissant et desc pour un ordre décroissant. La valeur par défaut est desc. | |
limitinteger (Facultatif)Nombre d'éléments à retourner. La valeur doit être un entier compris entre 1 et 100. La valeur par défaut est 20. |
Paramètres de réponse
dataarray[object]Liste des éléments de message.
Propriétés id stringID unique de l'élément de message.contentstring or arrayContenu du message. Il peut s'agir d'une chaîne de texte brut ou d'une liste de contenu structuré, telle qu'un tableau d'objets ResponseInputText.rolestringRôle du message. Valeurs valides : user, assistant, system et developer.statusstringÉtat de traitement du message. Valeurs valides : in_progress, completed et incomplete.typestringType de l'élément de message. La valeur est fixée à message. | |
first_idstringID du premier élément de message de la liste. | |
has_morebooleanIndique si des données supplémentaires sont disponibles. | |
last_idstringID du dernier élément de message de la liste. | |
objectstringType d'objet. La valeur est fixée à list. |
Récupérer un élément
Récupère les détails d'un élément de message spécifié.
Chine du Nord 2 (Pékin) : GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}/items/{item_id}
Singapour : GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}/items/{item_id}
conversation_idstring(Obligatoire, Chemin)ID de la conversation. | Python |
item_idstring(Obligatoire, Chemin)ID de l'élément de message. |
Paramètres de réponse
contentarray[object]Liste du contenu du message contenant un ou plusieurs objets de contenu.
Propriétés type stringType de contenu, par exemple input_text pour le texte saisi par l'utilisateur ou output_text pour le texte généré par le modèle.textstringContenu textuel. | |
idstringID unique de l'élément de message. | |
rolestringRôle du message. Valeurs valides : user, assistant, system et developer. | |
statusstringÉtat de traitement du message. Valeurs valides : in_progress, completed et incomplete. | |
typestringType de l'élément de message. La valeur est fixée à message. |
Supprimer un élément
Supprime un élément de message spécifié.
Chine du Nord 2 (Pékin) : DELETE https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}/items/{item_id}
Singapour : DELETE https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}/items/{item_id}
conversation_idstring(Obligatoire, Chemin)ID de la conversation. | Python |
item_idstring(Obligatoire, Chemin)ID de l'élément de message. |
Paramètres de réponse
deletedbooleanIndique si l'élément a été supprimé avec succès. | |
idstringID de l'élément de message supprimé. | |
objectstringType d'objet. La valeur est fixée à conversation.item.deleted. |
Utiliser les conversations dans l'API Responses
Utilisez le paramètre conversation de l'API Responses pour maintenir le contexte dans les conversations multi-tours.
Ne transmettez pas simultanémentprevious_response_idetconversation. Dans le cas contraire, l'erreur suivante se produit :[400] INVALID_REQUEST: Mutually exclusive parameters: Ensure you are only providing one of: previous_response_id or conversation.
Python
Limites
- Lors de la création d'une conversation ou de l'ajout d'éléments de message, le tableau
itemspeut contenir jusqu'à 20 entrées. - L'objet
metadatapeut contenir jusqu'à 16 paires clé-valeur. La clé peut comporter jusqu'à 64 caractères et la valeur jusqu'à 512 caractères. - Les données de conversation sont conservées pendant 7 jours maximum et limitées aux 100 entrées les plus récentes. Toute donnée dépassant la limite de temps ou de quantité est automatiquement effacée.