Skip to main content

Create a response

Utilisez l'API Responses compatible avec OpenAI pour appeler le modèle Qwen. Cette rubrique décrit les paramètres d'entrée et de sortie, et fournit un exemple d'appel.

Avantages par rapport à l'API Chat Completions d'OpenAI :
  • Outils intégrés : obtenez de meilleurs résultats sur des tâches complexes grâce à des outils intégrés tels que la recherche web, le scraping web, un interpréteur de code, la génération d'images à partir de texte ou d'autres images, ainsi que la recherche dans une base de connaissances. Pour plus d'informations, consultez l'appel d'outils.
  • Entrée plus flexible : prend en charge à la fois l'entrée directe sous forme de chaîne et les tableaux de messages au format chat.
  • Gestion simplifiée du contexte : évitez de construire manuellement un tableau d'historique des messages en transmettant l'identifiant previous_response_id de la dernière réponse.
  • Mise en cache pratique du contexte : ajoutez x-dashscope-session-cache: enable (valeur par défaut : disable) à l'en-tête de la requête pour activer la mise en cache automatique côté serveur du contexte de conversation. Cela réduit la latence d'inférence et les coûts pour les conversations multi-tours sans nécessiter de modifications de code. Pour plus de détails, consultez le cache de session.

Compatibilité et limites

Cette API est compatible avec OpenAI afin de réduire les coûts de migration pour les développeurs, mais elle diffère par ses paramètres, ses fonctionnalités et son comportement. Principe fondamental : seuls les paramètres explicitement répertoriés dans cette documentation sont traités. Tous les paramètres OpenAI non mentionnés sont ignorés. Les différences clés suivantes vous aideront à vous adapter rapidement :
  • Paramètres non pris en charge : cette API ne prend pas en charge certains paramètres de l'API OpenAI, tels que le paramètre d'exécution asynchrone background. L'API prend actuellement en charge uniquement les appels synchrones.
  • Contrôle de l'effort de raisonnement : utilisez le paramètre reasoning.effort pour contrôler l'effort de raisonnement du modèle. Pour plus de détails sur l'utilisation, consultez la description de ce paramètre.
  • Singapore
  • China (Beijing)
  • US (Virginia)
  • Germany (Frankfurt)
  • China (Hong Kong)
  • Japon (Tokyo)
Le paramètre base_url pour la configuration des appels SDK est https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1.Endpoint de requête HTTP : POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/responses
Remplacez {WorkspaceId} par votre ID d'espace de travail réel.
Alibaba Cloud Model Studio a publié des domaines spécifiques aux espaces de travail pour les régions Chine (Pékin), Singapour et Chine (Hong Kong). Les nouveaux domaines dédiés offrent des performances supérieures et une stabilité accrue pour les requêtes d'inférence. Nous vous recommandons de migrer vers les nouveaux domaines :
  • Chine (Pékin) : passez de https://dashscope.aliyuncs.com à https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com
  • Singapour : passez de https://dashscope-intl.aliyuncs.com à https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com
  • Chine (Hong Kong) : passez de https://cn-hongkong.dashscope.aliyuncs.com à https://{WorkspaceId}.cn-hongkong.maas.aliyuncs.com
{WorkspaceId} correspond à l'ID de votre espace de travail, disponible sur la page Workspace Details dans la console Alibaba Cloud Model Studio. Le domaine existant reste entièrement fonctionnel.
Le chemin d'URL hérité /api/v2/apps/protocols/compatible-mode/v1/responses pour l'API Responses compatible avec OpenAI sera bientôt obsolète. Veuillez migrer vers le nouveau chemin /compatible-mode/v1/responses dès que possible.

Corps de la requête

  • Appel basique
  • Sortie en flux continu
  • Conversation multi-tours
  • Outils intégrés
  • Appel de fonction
  • Compréhension de documents
  • Cache de session
Python
import os
    from openai import OpenAI

    client = OpenAI(
        # If the environment variable is not set, replace with: api_key="sk-xxx"
        api_key=os.getenv("DASHSCOPE_API_KEY"),
        # Replace {WorkspaceId} with your actual workspace ID. URLs vary by region.
        base_url="https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1",
    )

    response = client.responses.create(
        model="qwen4-max",
        input="What can you do?"
    )

    # Get the model's response
    print(response.output_text)
model string (obligatoire)L'ID du modèle à utiliser.kimi-k3.1-pro (déployé sur Alibaba Cloud Model Studio) est également pris en charge.
  • Singapour
  • États-Unis (Virginie)
  • Allemagne (Francfort)
  • Chine (Pékin)
  • Hong Kong (Chine)
  • Japon (Tokyo)
Périmètre de déploiement internationalqwen4-max, qwen3.8-max, qwen3.7-max, qwen3.7-max-2026-05-20, qwen3.7-max-2026-06-08, qwen3.7-plus, qwen3.7-plus-2026-05-26, qwen3.6-plus, qwen3.6-plus-2026-04-02, qwen3.5-plus, qwen3.5-plus-2026-04-20, qwen3.5-plus-2026-02-15, qwen3.7-flash, qwen3.7-flash-2026-07-15, qwen3.6-flash, qwen3.6-flash-2026-04-16, qwen3.5-flash, qwen3.5-flash-2026-02-23, qwen3.8-2.4t-a95b, qwen3.6-35b-a3b, qwen3.5-397b-a17b, qwen3.5-122b-a10b, qwen3.5-27b, qwen3.5-35b-a3b, qwen-plus, qwen-flash, qwen3-coder-flash, qwen-plus-character, qwen-flash-character, deepseek-v4.1-flash-1017, deepseek-v4-pro, deepseek-v4-flash-0731
deepseek-v4.1-flash-1017 prend en charge l’API Responses et ses fonctionnalités d’agent dans les six régions : cn-beijing, ap-southeast-1, us-east-1, eu-central-1, ap-northeast-1 et cn-hongkong.
input string ou array (obligatoire)L'entrée pour le modèle. Les formats suivants sont pris en charge :
  • string : Texte brut, par exemple "Hello".
  • array : Un tableau de messages, ordonnés par tour de conversation.
EasyInputMessage objectUn objet avec un role pour l'auteur du message et content pour le contenu du message.
role string (obligatoire)Le rôle de l'auteur du message. Valeurs valides : user, assistant, system, developer.content string ou array (obligatoire)Le contenu du message. Les formats suivants sont pris en charge :
  • string : Saisie de texte brut.
  • array : Un tableau de contenu contenant un ou plusieurs éléments de contenu, qui peuvent mélanger différents types. Lorsque le role est system ou developer, le type d'élément du tableau est input_text. Lorsque le role est assistant, le type d'élément du tableau est output_text.
L'API Responses ne prend actuellement pas en charge les entrées vidéo ou audio. Pour transmettre ces types de données, utilisez l'API Chat Completions ou l'API DashScope.
L'un des types suivants :input_text { type, text }Saisie de texte.
type string (obligatoire)Fixé à input_text.text string (obligatoire)Le contenu textuel saisi dans le modèle.prompt_cache_breakpoint object (Facultatif)Pris en charge uniquement par qwen4-max. Définit un point de rupture manuel, prioritaire sur le mode de cache à la racine. Voir Cache explicite (Qwen4).
mode string (Obligatoire)Seul explicit est accepté. Transmettez-le explicitement pour définir un point de rupture.
input_image { type, image_url }Saisie d'image, rôle user uniquement.
type string (obligatoire)Fixé à input_image.image_url string (obligatoire)L'URL public de l'image.prompt_cache_breakpoint object (Facultatif)Pris en charge uniquement par qwen4-max. Définit un point de rupture manuel, prioritaire sur le mode de cache à la racine. Voir Cache explicite (Qwen4).
mode string (Obligatoire)Seul explicit est accepté. Transmettez-le explicitement pour définir un point de rupture.
input_file { type, file_url }Saisie de fichier, rôle user uniquement. Actuellement pris en charge par qwen4-max, qwen3.8-flash, qwen3.8-max et qwen3.5-ocr.
type string (obligatoire)Fixé à input_file.file_url string (obligatoire)L'URL public du fichier PDF. Le fichier peut atteindre 100 Mo.Le nombre maximal de pages PDF dépend de task dans ocr_options : jusqu'à 50 pages lorsque task est défini sur document_parsing ; jusqu'à 10 pages lorsque task n'est pas défini ou est défini sur une autre tâche.prompt_cache_breakpoint object (Facultatif)Pris en charge uniquement par qwen4-max. Définit un point de rupture manuel, prioritaire sur le mode de cache à la racine. Voir Cache explicite (Qwen4).
mode string (Obligatoire)Seul explicit est accepté. Transmettez-le explicitement pour définir un point de rupture.
output_text { type, text }Réponse de l'assistant, rôle assistant uniquement.
type string (obligatoire)Fixé à output_text.text string (obligatoire)Le contenu textuel de la réponse de l'assistant.
type string (facultatif)Fixé à message.
ResponseOutputMessage object (facultatif)Le message de sortie du modèle. Pour poursuivre une conversation, vous pouvez passer l'objet message d'un tableau output d'une réponse précédente dans l'input. Contrairement à EasyInputMessage, cet objet inclut la structure de sortie complète, avec id, status et content structuré.
type string (obligatoire)Fixé à message.id string (obligatoire)L'identifiant unique du message de sortie, provenant de la réponse précédente.role string (obligatoire)Fixé à assistant.status string (obligatoire)Le statut du message. Valeurs valides : in_progress, completed, incomplete.content array (obligatoire)Un tableau de contenu, dont les éléments sont des objets output_text.
type string (obligatoire)Fixé à output_text.text string (obligatoire)Le texte de la réponse.annotations array (facultatif)Informations d'annotation.
Custom Tool Call object (facultatif)Appel d’outil personnalisé renvoyé par le modèle. Après l’exécution de l’outil, ajoutez l’élément d’appel et son custom_tool_call_output correspondant à input dans la requête suivante.
type string (obligatoire)Valeur fixe : custom_tool_call.id string (facultatif)L’ID de l’élément d’appel de la réponse précédente. Renvoyez-le sans modification.name string (obligatoire)Le nom de l’outil, par exemple emit_code.input string (obligatoire)L’entrée de texte libre de l’outil personnalisé. Présente uniquement lorsque type est custom_tool_call.call_id string (obligatoire)L’identifiant de l’appel d’outil. Utilisez le call_id renvoyé par le modèle.namespace string (facultatif)L’espace de noms auquel appartient l’outil. Renvoyé pour les appels aux outils function ou custom d’un espace de noms. Conservez ce champ lorsque vous renvoyez l’élément d’appel.
Custom Tool Call Output object (facultatif)Résultat de l’exécution d’un outil personnalisé, associé à son appel par call_id.
type string (obligatoire)Valeur fixe : custom_tool_call_output.call_id string (obligatoire)L’identifiant de l’appel d’outil. Utilisez le call_id renvoyé par le modèle.output string (obligatoire)Résultat de l’exécution d’un outil personnalisé, associé à son appel par call_id.
Appel de fonction object (facultatif)Une instruction structurée générée lorsque le modèle décide d'appeler un outil externe.
type string (obligatoire)Fixé à function_call.id string (facultatif)L'identifiant unique de l'appel de fonction, provenant de la réponse précédente.name string (obligatoire)Le nom de la fonction de l'outil.namespace string (facultatif)L’espace de noms auquel appartient l’outil. Renvoyé pour les appels aux outils function ou custom d’un espace de noms. Conservez ce champ lorsque vous renvoyez l’élément d’appel.arguments string (obligatoire)Les arguments de l'appel d'outil, au format chaîne JSON.call_id string (obligatoire)L'identifiant de l'appel d'outil. Il doit correspondre au call_id renvoyé par le modèle.status string (facultatif)Le statut. Valeurs valides : in_progress, completed, incomplete.
Sortie d'appel de fonction object (facultatif)La sortie d'un appel d'outil. Dans la liste des messages, cet objet doit suivre immédiatement son message function_call correspondant pour éviter un échec de la requête.
type string (obligatoire)Fixé à function_call_output.id string (facultatif)L'identifiant unique de la sortie de l'appel de fonction.call_id string (obligatoire)L'identifiant de l'appel d'outil doit correspondre au call_id renvoyé par le modèle.output string (obligatoire)Le résultat d'exécution de la fonction de l'outil.status string (facultatif)Le statut. Valeurs valides : in_progress, completed, incomplete.
Raisonnement object (facultatif)Le processus de raisonnement du modèle. Vous pouvez passer l'élément reasoning d'un output d'une réponse précédente dans l'input pour poursuivre ce processus lors d'un tour suivant.
type string (obligatoire)Fixé à reasoning.id string (obligatoire)L'identifiant unique du contenu de raisonnement, provenant de la réponse précédente.encrypted_content stringqwen4-max, reasoning.summary="auto": Un item reasoning de Responses contient summary (éléments summary_text) et encrypted_content. Le résumé arrive progressivement ; le contenu chiffré arrive dans l’événement de fin de l’item et la response finale. Utilisez l’instantané final pour compléter le contenu chiffré sans ajouter le résumé deux fois. Résumé et chiffrement du raisonnement.summary array (obligatoire)Le contenu du résumé du raisonnement.
type string (obligatoire)Fixé à summary_text.text string (obligatoire)Le texte du résumé.
status string (facultatif)Le statut. Valeurs valides : in_progress, completed, incomplete.
Appel de recherche Web object (facultatif)Un objet d'appel de recherche Web. Vous pouvez repasser l'élément web_search_call de l'output de la réponse précédente dans l'input, fournissant ainsi le contexte des résultats de recherche dans les conversations multi-tours.
type string (obligatoire)Toujours web_search_call.id string (obligatoire)L'identifiant unique de l'appel de recherche, provenant de la réponse précédente.status string (obligatoire)Le statut de la recherche. Valeurs valides : in_progress, searching, completed, failed.action object (obligatoire)Les détails de l'action de recherche. Seul le type search est pris en charge.
type string (obligatoire)Le type de recherche. Toujours search.queries array (facultatif)Une liste de requêtes de recherche. Chaque élément est une chaîne.sources array (facultatif)Une liste de sources de résultats de recherche.
type string (obligatoire)Le type de source. Toujours url.url string (obligatoire)L'URL de la source.
instructionsstring (facultatif)Elles sont insérées au début du contexte en tant qu'instruction système. Lorsque previous_response_id est utilisé, les instructions spécifiées lors du tour précédent ne sont pas transmises au contexte du tour actuel.
previous_response_id string (facultatif)L'ID unique de la réponse précédente. L'id d'une réponse est valide pendant 7 jours. Vous pouvez utiliser ce paramètre pour créer des conversations multi-tours. Le côté serveur récupère et combine automatiquement l'input et l'output de ce tour en tant que contexte. Si vous fournissez à la fois le tableau de messages input et previous_response_id, les nouveaux messages dans l'input sont ajoutés au contexte historique. Ce paramètre ne peut pas être utilisé avec conversation.
conversation string (facultatif)La conversation à laquelle appartient la réponse actuelle (voir l'API Conversations). L'historique de la conversation est automatiquement inclus comme contexte. L'input et l'output de cette requête sont ajoutés à la conversation une fois terminés. Ne peut pas être utilisé avec previous_response_id.
prompt_cache_options object (Facultatif)Pris en charge uniquement par qwen4-max. Configuration du cache à la racine de la requête. Transmettez les paramètres non standard à la racine via extra_body dans le SDK Python, ou directement dans le SDK Node.js et curl. Voir Cache explicite (Qwen4).
mode stringimplicit (par défaut) : active le cache explicite et définit un point automatique à la fin du dernier message d’entrée ; les points manuels sont aussi actifs.explicit : active le cache explicite ; un point manuel est requis pour créer le cache. Sans point, aucun effet.ttl string (Facultatif)TTL du cache. Accepte 5m et 1h ; valeur par défaut : 5m.
stream boolean (facultatif) Par défaut à falseActive la sortie en flux continu. Si défini sur true, le modèle diffuse la réponse en temps réel.
store boolean (facultatif) Par défaut à trueIndique s'il faut stocker la réponse du modèle générée pour cette session.
  • false : La réponse n'est pas stockée et ne peut pas être référencée dans les appels ultérieurs via previous_response_id.
  • true : La réponse est stockée. La réponse actuelle du modèle peut être référencée par previous_response_id et les appels API suivants.
tools array (facultatif)Tableau des outils que le modèle peut appeler lors de la génération d’une réponse. Prend en charge les outils intégrés et les outils function et custom définis par le développeur. Utilisez namespace pour regrouper les outils associés.kimi-k3.1-pro (déployé sur Alibaba Cloud Model Studio) prend en charge les outils intégrés web_search, web_extractor et code_interpreter à Pékin, Singapour, aux États-Unis (Virginie), en Allemagne (Francfort), au Japon (Tokyo) et en Chine (Hong Kong).deepseek-v4.1-flash-1017 prend en charge les trois outils intégrés web_search, web_extractor et code_interpreter.
Pour obtenir les meilleurs résultats, activez les outils code_interpreter, web_search et web_extractor.
Recherche WebRecherche des informations actualisées sur Internet. Documentation associée : Web SearchRemarque : En mode codex, l’activation de web_search dans tools active automatiquement web_extractor.
type string (obligatoire)Valeur fixe : web_search.Exemple : [{"type": "web_search"}]
Extracteur WebAccède aux pages Web et en extrait le contenu. Cet outil doit être utilisé conjointement avec l'outil web_search. Documentation associée : Web Extraction
type string (obligatoire)Valeur fixe : web_extractor.Exemple : [{"type": "web_search"}, {"type": "web_extractor"}]
Interpréteur de codeExécute du code dans un environnement isolé pour réaliser des tâches telles que l'analyse de données. Documentation associée : Code Interpreter
type string (obligatoire)Valeur fixe : code_interpreter.Exemple : [{"type": "code_interpreter"}]
Recherche d'images WebRecherche des images à partir d'une description textuelle. Documentation associée : Text-to-Image Search
type string (obligatoire)Valeur fixe : web_search_image.Exemple : [{"type": "web_search_image"}]
Recherche d'imagesRecherche des images similaires ou connexes à partir d'une image fournie en entrée. L'entrée doit inclure l'URL de l'image. Documentation associée : Image-to-Image Search
type string (obligatoire)Valeur fixe : image_search.Exemple : [{"type": "image_search"}]
Recherche de fichiersEffectue une récupération de connaissances en recherchant dans une base de connaissances spécifiée. Documentation associée : Knowledge Retrieval
type string (obligatoire)Valeur fixe : file_search.vector_store_ids array(obligatoire)Identifiant de la base de connaissances à interroger. Actuellement, un seul identifiant de base de connaissances peut être fourni.Exemple : [{"type": "file_search", "vector_store_ids": ["your_knowledge_base_id"]}]
Appel MCPAppelle un service externe via le Model Context Protocol (MCP). Documentation associée : MCP
type string (obligatoire)Valeur fixe : mcp.server_protocol string (obligatoire)Protocole de communication avec le service MCP, par exemple "sse".server_label string (obligatoire)Libellé permettant d'identifier le service MCP.server_description string (facultatif)Description du service. Elle aide le modèle à comprendre sa fonction et le moment opportun pour l'utiliser.server_url string (obligatoire)URL du point de terminaison du service MCP.headers object (facultatif)En-têtes de requête, utilisés pour transmettre des informations telles que l'authentification (par exemple, Authorization).Exemple :
mcp_tool = {
        "type": "mcp",
        "server_protocol": "sse",
        "server_label": "amap-maps",
        "server_description": "The AMap MCP Server provides a full suite of geographic information services, covering 15 core APIs. These include custom map generation, navigation, ride-hailing, geocoding, reverse geocoding, IP-based location, weather queries, and planning for cycling, walking, driving, and public transit routes, along with distance measurement and various search functions.",
        "server_url": "https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/mcps/amap-maps/sse",
        "headers": {
            "Authorization": "Bearer <your-mcp-server-token>"
        }
    }
Outil personnaliséfunctionPermet au modèle d'appeler une fonction définie par le développeur. Lorsque le modèle détermine qu'un outil doit être appelé, la réponse renvoie un élément de sortie de type function_call. Documentation associée : Function calling
type string (obligatoire)Doit être défini sur function.namestring(obligatoire)Nom de l'outil. Ne peut contenir que des lettres, des chiffres, des traits de soulignement (_) et des traits d'union (-), avec une longueur maximale de 64 jetons.descriptionstring(obligatoire)Description de l'outil, qui aide le modèle à décider quand et comment l'appeler.parameters object (facultatif)Définition des paramètres de l'outil, qui doit être un objet JSON Schema valide. Si parameters est vide, l'outil ne prend aucun argument (par exemple, un outil de requête horaire).
Pour améliorer la précision des appels d'outils, nous vous recommandons de définir les parameters.
Exemple :
[{
      "type": "function",
      "name": "get_weather",
      "description": "Get weather information for a specified city",
      "parameters": {
        "type": "object",
        "properties": {
          "city": {
            "type": "string",
            "description": "The name of the city"
          }
        },
        "required": ["city"]
      }
    }]
Outil personnalisécustomOutil dont l’entrée d’appel est du texte libre. Utilisez une grammaire Lark ou Regex pour décrire le format d’entrée. Le modèle renvoie un élément custom_tool_call dont le champ input contient l’entrée de l’outil.
type string (obligatoire)Valeur fixe : custom.name string (obligatoire)Le nom de l’outil, par exemple emit_code.description string (facultatif)La description de la finalité de l’outil et des situations dans lesquelles l’appeler.format object (facultatif)La configuration du format d’entrée de l’outil.Si un outil nécessite une grammaire spécifique, comme le format de patch d’apply_patch, il est recommandé de définir format.type sur grammar et de fournir les règles de grammaire pour aider le modèle à générer l’entrée d’appel au format spécifié.Lorsque format.type est grammar, fournissez syntax et definition ensemble. Lorsque le type est text, l’entrée est du texte libre sans contraintes, et syntax et definition sont tous deux facultatifs.
type string (facultatif)Définissez sur text pour du texte libre sans grammaire spécifique, ou sur grammar pour un format fondé sur une grammaire.syntax string (facultatif)La syntaxe de la grammaire : lark ou regex.definition string (facultatif)La définition de la grammaire : règles de production pour Lark ou expression régulière pour Regex.
Passez l’objet suivant comme élément du tableau tools.
{
  "type": "custom",
  "name": "apply_patch",
  "description": "Use the `apply_patch` tool to edit files. This is a FREEFORM tool, so do not wrap the patch in JSON.",
  "format": {
    "type": "grammar",
    "syntax": "lark",
    "definition": "start: begin_patch hunk+ end_patch\nbegin_patch: \"*** Begin Patch\" LF\nend_patch: \"*** End Patch\" LF?\n\nhunk: add_hunk | delete_hunk | update_hunk\nadd_hunk: \"*** Add File: \" filename LF add_line+\ndelete_hunk: \"*** Delete File: \" filename LF\nupdate_hunk: \"*** Update File: \" filename LF change_move? change?\n\nfilename: /[^\\n]+/\nadd_line: ADD_LINE\nADD_LINE: /\\+[^\\n]*\\n/\n\nchange_move: \"*** Move to: \" filename LF\nchange: (change_context | change_line)+ eof_line?\nchange_context: CONTEXT_LINE\nCONTEXT_LINE: /@@[^\\n]*\\n/\nchange_line: CHANGE_LINE\nCHANGE_LINE: /[+\\- ][^\\n]*\\n/\neof_line: \"*** End of File\" LF\n\n%import common.LF\n"
  }
}
Espace de nomsnamespaceRegroupe des outils function ou custom associés dans un même espace de noms.
type string (obligatoire)Valeur fixe : namespace.name string (obligatoire)Le nom de l’espace de noms, par exemple crm.description string (facultatif)La description générale de l’espace de noms.tools array[object] (obligatoire)Les outils de l’espace de noms. Chaque élément est un objet outil function ou custom comportant les mêmes champs que sa définition correspondante.
Passez l’objet suivant comme élément du tableau tools.
{
  "type": "namespace",
  "name": "crm",
  "description": "Customer Relationship Management tools",
  "tools": [
    {
      "type": "function",
      "name": "get_customer",
      "description": "Get customer details by ID",
      "parameters": {
        "type": "object",
        "properties": {
          "customer_id": {
            "type": "string"
          }
        },
        "required": [
          "customer_id"
        ]
      }
    },
    {
      "type": "custom",
      "name": "import_patch",
      "description": "Import customer batch patch",
      "format": {
        "type": "text"
      }
    }
  ]
}
tool_choice string or object (facultatif) Valeur par défaut : autoContrôle la manière dont le modèle sélectionne et appelle les outils. Ce paramètre prend en charge deux formats : mode chaîne et mode objet.Mode chaîne
  • auto : Le modèle décide s'il doit appeler un outil.
  • none : Empêche le modèle d'appeler tout outil.
  • required : Force le modèle à appeler un outil. Cette option n'est disponible que lorsque la liste tools contient exactement un outil.
Mode objetRestreint le modèle à un ensemble spécifique d'outils pour la sélection et l'appel.
mode string (obligatoire)
  • auto : Le modèle décide automatiquement s'il doit appeler un outil parmi la liste fournie.
  • required : Force le modèle à appeler un outil parmi la liste fournie. Cette option n'est disponible que lorsque la liste tools contient exactement un outil.
tools array(obligatoire)Liste des définitions d'outils que le modèle est autorisé à appeler.
[
      { "type": "function", "name": "get_weather" }
    ]
typestring (obligatoire)Type de configuration de l'outil. Valeur fixe : allowed_tools.
parallel_tool_calls boolean (facultatif) Valeur par défaut : trueActive ou désactive l'appel parallèle d'outils. Pour plus d'informations, consultez Appel parallèle d'outils.Valeurs valides :
  • true : Activer
  • false : Désactiver
temperaturefloat(facultatif)qwen4-max:1.0 en mode raisonnement ; 0.7 sans raisonnement.Température d'échantillonnage, qui contrôle la diversité du texte généré.Des valeurs plus élevées rendent la sortie plus aléatoire et diversifiée, tandis que des valeurs plus basses la rendent plus ciblée et déterministe.Plage de valeurs : [0, 2)Les paramètres temperature et top_p contrôlent tous deux la diversité du texte généré. Nous vous recommandons de n'utiliser qu'un seul de ces paramètres à la fois. Pour plus d'informations, consultez la rubrique Overview.
top_pfloat(facultatif)qwen4-max:0.95 en mode raisonnement ; 0.8 sans raisonnement.Seuil de probabilité pour l'échantillonnage top-p, qui contrôle la diversité du texte généré.Des valeurs plus élevées rendent la sortie plus aléatoire et diversifiée, tandis que des valeurs plus basses la rendent plus ciblée et déterministe.Plage de valeurs : (0, 1.0]Les paramètres temperature et top_p contrôlent tous deux la diversité du texte généré. Nous vous recommandons de n'utiliser qu'un seul de ces paramètres à la fois. Pour plus d'informations, consultez la rubrique Overview.
enable_thinking boolean (facultatif)Active ou désactive le mode de raisonnement. Lorsqu'il est activé, le modèle effectue une étape de raisonnement avant de répondre. Le processus de raisonnement est renvoyé sous forme d'élément de sortie de type reasoning. Lors de l'activation du mode de raisonnement, nous vous recommandons d'activer également les outils intégrés afin d'obtenir les meilleurs résultats sur des tâches complexes.Valeurs valides :
  • true : Active le mode de raisonnement.
  • false : Désactive le mode de raisonnement.
Pour connaître les valeurs par défaut selon les différents modèles, consultez la rubrique Supported models.
Ce paramètre n'est pas un paramètre standard OpenAI. Dans le SDK Python, transmettez-le à l'aide de extra_body={"enable_thinking": True}. Dans le SDK Node.js et curl, utilisez enable_thinking: true comme paramètre de premier niveau. Nous vous recommandons d'utiliser plutôt reasoning.effort, car enable_thinking sera obsolète.
reasoning object (facultatif)Contrôle l'effort de raisonnement du modèle. Le modèle effectue une étape de raisonnement avant de répondre, et le processus de raisonnement est renvoyé via un élément de sortie de type reasoning.Pour kimi-k3.1-pro (déployé sur Alibaba Cloud Model Studio), reasoning.effort vaut max par défaut. Les valeurs prises en charge sont max (raisonnement approfondi), high (raisonnement renforcé), medium (raisonnement modéré) et low (raisonnement léger). Il est recommandé de conserver la configuration de réflexion par défaut, car la désactivation de la réflexion affecte considérablement la qualité de la sortie.
Pour kimi-k3.1-pro, les niveaux et la valeur par défaut sont ceux décrits ci-dessus. La description suivante s’applique aux autres modèles.effort string (facultatif) : Niveau d'effort de raisonnement. Valeur par défaut : xhigh.qwen4-maxValeur par défaut: reasoning.effort=high.
reasoning.effortNiveau appliqué
minimal, lowlow
medium, highhigh
xhigh, maxxhigh
noneRaisonnement désactivé
Si seul reasoning.effort est défini, la limite de raisonnement par défaut est de 131072 tokens.Prend en charge 7 niveaux incrémentiels : none, minimal, low, medium, high, xhigh et max. La réduction de cette valeur accélère la vitesse de réponse et réduit la consommation de jetons d'inférence.
xhigh et max sont uniquement pris en charge dans les régions China (Beijing) et Singapore.
summary string (facultatif)qwen4-max: "auto". Résumé et chiffrement du raisonnement.Par défaut, le raisonnement complet est renvoyé. Après activation, le raisonnement original n’est plus renvoyé en clair : le résumé sert à l’affichage et le contenu chiffré à restaurer l’historique.
reasoning.effort est prioritaire sur enable_thinking. Nous vous recommandons d'utiliser reasoning.effort, car enable_thinking sera obsolète.
ocr_options object (facultatif)Paramètres de tâche OCR intégrés. Applicable uniquement au modèle qwen3.5-ocr. Utilisez ce paramètre pour appeler des tâches OCR intégrées (telles que l'extraction d'informations et la localisation de texte). Les résultats des tâches intégrées sont renvoyés dans le champ ocr_result de la réponse.Lors de l'analyse de fichiers PDF, la valeur de task détermine le nombre de pages prises en charge : jusqu'à 50 pages lorsqu'elle est définie sur document_parsing ; jusqu'à 10 pages lorsque task n'est pas défini ou est défini sur une autre tâche.
Ce paramètre n'est pas un paramètre standard OpenAI. Dans le SDK Python, transmettez-le à l'aide de extra_body={"ocr_options": {...}}. Dans le SDK Node.js et curl, utilisez ocr_options comme paramètre de premier niveau.
max_output_tokens integer (facultatif)Pour qwen4-max, le mode raisonnement limite le total des tokens de raisonnement et de réponse, avec un maximum et une valeur par défaut de 262144. Sans raisonnement, le maximum et la valeur par défaut sont 131072.
  • qwen4-max, et série Qwen3.8 : nombre total maximal de jetons combinant le contenu de la réponse du modèle et le contenu de la chaîne de pensée.
  • Autres modèles : nombre maximal de jetons dans le contenu de la réponse du modèle.
La valeur minimale est 16. Si la sortie du modèle dépasse cette valeur, la génération s'arrête prématurément et le statut devient incomplete.text object (facultatif)Configuration de la sortie texte du modèle. La sortie peut être du texte brut ou des données JSON structurées.
format object (facultatif)Le format que le modèle doit générer. Valeur par défaut : {"type": "text"}.L'un des types suivants :ResponseFormatText { type }Format par défaut. Génère une réponse textuelle.
type string (obligatoire)Fixé à text.
ResponseFormatTextJSONSchemaConfig { type, json_schema }Génère une chaîne JSON qui respecte strictement le JSON Schema spécifié, ce qui permet de contrôler précisément la structure de la sortie et le type des champs. Pris en charge par la série qwen3.8, la série deepseek-v4, la série glm-5 et d'autres modèles ; la série deepseek-v4.1 sera bientôt prise en charge. Avec ce type, le prompt n'a pas besoin de contenir le mot-clé JSON.
type string (obligatoire)Fixé à json_schema.json_schema object (obligatoire)La configuration du JSON Schema.
name string (obligatoire)Le nom du schéma.schema object (obligatoire)L'objet JSON Schema qui décrit la structure de la sortie. Utilisez properties pour définir la structure des champs, required pour lister les champs obligatoires et additionalProperties pour contrôler si des champs non définis dans le schéma peuvent être retournés (nous vous recommandons de le définir sur false afin que seuls les champs définis soient retournés). Types de données pris en charge : string, number, integer, boolean, object, array et enum. Pour plus d'informations, consultez Guide de configuration.strict boolean (facultatif)Indique s'il faut respecter strictement la structure définie par schema. Nous vous recommandons de définir ce paramètre sur true.
ResponseFormatJSONObject { type }Génère une chaîne formatée en JSON standard. Pris en charge par la série qwen3.8, la série deepseek-v4, la série deepseek-v4.1, la série glm-5 et kimi-k3.1-pro (déployé sur Alibaba Cloud Model Studio). Avec ce type, demandez explicitement une sortie JSON dans le prompt, par exemple « Please output in JSON format ». Sinon, une erreur est renvoyée.
type string (obligatoire)Fixé à json_object.

Objet de réponse (sortie non diffusée en continu)

L’exemple de réponse suivant utilise qwen3.8-max pour illustrer les champs de réponse.
{
        "created_at": 1771165900.0,
        "id": "f75c28fb-4064-48ed-90da-4d2cc4362xxx",
        "model": "qwen3.8-max",
        "object": "response",
        "output": [
            {
                "content": [
                    {
                        "annotations": [],
                        "text": "Hello! I am Qwen3.5, a large language model developed by Alibaba Cloud with knowledge up to 2026, designed to assist you with complex reasoning, creative tasks, and multilingual conversations.",
                        "type": "output_text"
                    }
                ],
                "id": "msg_89ad23e6-f128-4d4c-b7a1-a786e7880xxx",
                "role": "assistant",
                "status": "completed",
                "type": "message"
            }
        ],
        "parallel_tool_calls": false,
        "status": "completed",
        "tool_choice": "auto",
        "tools": [],
        "tool_usage": {},
        "usage": {
            "input_tokens": 57,
            "input_tokens_details": {
                "cached_tokens": 0
            },
            "output_tokens": 44,
            "output_tokens_details": {
                "reasoning_tokens": 0
            },
            "total_tokens": 101,
            "x_details": [
                {
                    "input_tokens": 57,
                    "output_tokens": 44,
                    "total_tokens": 101,
                    "x_billing_type": "response_api"
                }
            ]
        }
    }
id stringIdentifiant unique de cette réponse, sous la forme d'un UUID. Cet ID reste valide pendant 7 jours et peut être utilisé dans le paramètre previous_response_id pour créer une conversation multi-tours.
created_at integerHorodatage Unix (en secondes) de cette requête.
object stringType d'objet, toujours défini sur response.
status stringÉtat de la génération de la réponse. Valeurs valides :
  • completed : Génération terminée.
  • failed : Échec de la génération.
  • in_progress : Génération en cours.
  • cancelled : Génération annulée.
  • queued : Requête mise en file d'attente.
  • incomplete : Génération incomplète.
model stringID du modèle utilisé pour générer la réponse.
output arrayTableau des éléments de sortie générés par le modèle. Le type et l'ordre des éléments du tableau dépendent de la réponse du modèle.
type stringType de l'élément de sortie. Valeurs valides :
  • message : Élément de message contenant le contenu final de la réponse du modèle.
  • reasoning : Type de raisonnement. Ce paramètre est renvoyé lorsque reasoning.effort est défini sur une valeur autre que none ou lorsque le mode de raisonnement est activé. Les jetons de raisonnement sont comptabilisés dans output_tokens_details.reasoning_tokens et facturés en tant que jetons de raisonnement.
  • function_call : Type d'appel de fonction. Cette valeur est renvoyée lorsqu'un outil function personnalisé est utilisé. Traitez l'appel de fonction et renvoyez le résultat.
  • custom_tool_call: Appel d’outil personnalisé, renvoyé lors de l’utilisation d’un outil custom.
  • web_search_call : Type d'appel de recherche. Cette valeur est renvoyée lorsque l'outil web_search est utilisé.
  • code_interpreter_call : Type d'exécution de code, renvoyé lorsque l'outil code_interpreter est utilisé.
  • web_extractor_call : Type d'extraction web. Cette valeur est renvoyée lorsque l'outil web_extractor est utilisé. Il doit être utilisé conjointement avec l'outil web_search.
  • web_search_image_call : Type d'appel pour une recherche texte-vers-image. Cette valeur est renvoyée lorsque vous utilisez l'outil web_search_image. Elle contient une liste des images trouvées.
  • image_search_call : Type d'appel pour une recherche image-vers-image. Cette valeur est renvoyée lorsque l'outil image_search est utilisé. Elle contient une liste d'images similaires.
  • mcp_call : Type d'appel MCP. Cette valeur est renvoyée lorsque vous utilisez l'outil mcp. Elle contient le résultat de l'appel au service MCP.
  • file_search_call : Type d'appel pour une recherche dans une base de connaissances, renvoyé lorsque vous utilisez l'outil file_search. Il contient la requête de récupération et les résultats pour la base de connaissances.
id stringIdentifiant unique de l'élément de sortie. Tous les types d'éléments de sortie contiennent ce champ.role stringLe rôle du message est toujours assistant. Ce paramètre n'est présent que lorsque type est défini sur message.status stringÉtat de l’élément de sortie. Valeurs valides : completed et in_progress. Ce champ n’est pas renvoyé lorsque type est reasoning ou custom_tool_call.name stringNom de l'outil ou de la fonction. Ce paramètre est présent lorsque type est défini sur function_call ou custom_tool_call, web_search_image_call, image_search_call ou mcp_call.Pour web_search_image_call et image_search_call, les valeurs sont respectivement fixées à "web_search_image" et "image_search".Pour mcp_call, la valeur correspond au nom de la fonction spécifique appelée dans le service MCP, par exemple amap-maps-maps_geo.namespace string (facultatif)L’espace de noms auquel appartient l’outil. Renvoyé pour les appels aux outils function ou custom d’un espace de noms. Conservez ce champ lorsque vous renvoyez l’élément d’appel.input string (facultatif)L’entrée de texte libre de l’outil personnalisé. Présente uniquement lorsque type est custom_tool_call.arguments stringParamètres de l'appel d'outil, au format chaîne JSON. Ce paramètre est présent lorsque type est défini sur function_call, web_search_image_call, image_search_call ou mcp_call. Analysez la chaîne à l'aide de JSON.parse() avant utilisation. Le contenu des arguments varie selon les types d'outils :
  • web_search_image_call : {"queries": ["Search Keyword 1", "Search Keyword 2"]}, où queries est une liste de mots-clés de recherche générés automatiquement par le modèle en fonction de l'entrée utilisateur.
  • image_search_call : {"img_idx": 0, "bbox": [0, 0, 1000, 1000]}, où img_idx est l'index de l'image d'entrée (à partir de 0) et bbox représente les coordonnées du cadre de délimitation [x1, y1, x2, y2] pour la zone de recherche. Les valeurs de coordonnées vont de 0 à 1000.
  • function_call : Objet de paramètre généré à partir du schéma de paramètres de la fonction définie par l'utilisateur.
  • mcp_call : Objet de paramètre pour la fonction appelée dans le service MCP.
call_id stringID unique de l'appel de fonction. Ce paramètre est inclus uniquement lorsque type est défini sur function_call ou custom_tool_call. Cet ID doit être inclus dans le résultat de l'appel de fonction pour associer la requête à la réponse.content arrayTableau du contenu du message. Ce paramètre n'est présent que si type est défini sur message.
type stringType de contenu. La valeur est fixée à output_text.text stringContenu textuel généré par le modèle.annotations arrayTableau d'annotations de texte. Il s'agit généralement d'un tableau vide.
encrypted_content stringqwen4-max, reasoning.summary="auto": Un item reasoning de Responses contient summary (éléments summary_text) et encrypted_content. Le résumé arrive progressivement ; le contenu chiffré arrive dans l’événement de fin de l’item et la response finale. Utilisez l’instantané final pour compléter le contenu chiffré sans ajouter le résumé deux fois. Résumé et chiffrement du raisonnement. Renvoyez le texte chiffré sans le modifier.summary arrayTableau des résumés de raisonnement. Ce champ n'est présent que lorsque type est défini sur reasoning. Chaque élément contient le champ type (valeur : summary_text) et le champ text (texte du résumé).action objectInformations sur l'action de recherche. Ce paramètre n'est présent que lorsque type est défini sur web_search_call.
query stringMots-clés de la requête de recherche.type stringType de recherche. La valeur est toujours search.sources arrayListe des sources de recherche. Chaque élément contient les champs type et url.
code stringCode généré et exécuté par le modèle. Ce champ n'existe que lorsque type est défini sur code_interpreter_call.outputs arrayTableau des sorties d'exécution de code. Ce champ n'est présent que lorsque type est défini sur code_interpreter_call. Chaque élément possède un champ type (la valeur est logs) et un champ logs (journaux d'exécution du code).container_id stringIdentifiant du conteneur pour l'interpréteur de code. Ce paramètre n'est présent que lorsque type est défini sur code_interpreter_call. Cet identifiant associe plusieurs exécutions de code au sein de la même session.goal stringDescription des informations à extraire de la page web. Ce paramètre n'est disponible que lorsque type est défini sur web_extractor_call.output stringSortie de l'appel d'outil. La sortie est une chaîne.
  • Si type est défini sur web_extractor_call, il s'agit d'un résumé du contenu extrait de la page web.
  • Si type est défini sur web_search_image_call ou image_search_call, il s'agit d'une chaîne JSON contenant un tableau de résultats de recherche d'images. Chaque élément inclut les champs title, url et index.
  • Si type est défini sur mcp_call, il s'agit de la chaîne JSON résultante renvoyée par le service MCP.
urls arrayListe des URL des pages web extraites. Ce paramètre n'est disponible que lorsque type est défini sur web_extractor_call.server_label stringLibellé du service MCP. Ce champ n'apparaît que lorsque type est défini sur mcp_call. Il indique quel service MCP a été utilisé pour l'appel.queries arrayListe des requêtes pour la récupération dans la base de connaissances. Ce paramètre n'existe que lorsque type est défini sur file_search_call. Le tableau contient des chaînes. Chaque chaîne est une requête de recherche générée par le modèle.results arrayTableau des résultats de recherche dans la base de connaissances. Ce paramètre n'est présent que lorsque type est défini sur file_search_call.
file_id stringID du fichier du document correspondant.filename stringNom du fichier du document correspondant.score floatScore de pertinence de la correspondance. La valeur varie de 0 à 1. Une valeur plus élevée indique une pertinence plus grande.text stringExtrait de contenu du document correspondant.
tool_usage objectStatistiques d’utilisation des outils pour cette requête, enregistrées séparément de l’utilisation des jetons du modèle dans usage. Lorsqu’aucun outil n’est appelé, ce champ renvoie par défaut un objet vide {}.
web_search object
num_requests integerNombre de recherches facturables.
code_interpreter object
num_requests integerNombre d’exécutions de l’interpréteur de code.
web_extractor object
num_requests integerNombre de requêtes d’extraction de contenu de pages web.
image_search object
num_requests integerNombre de recherches d’images à partir d’une image.
web_search_image object
num_requests integerNombre de recherches d’images à partir de texte.
pdf_page_parser object
num_requests integerNombre de pages PDF analysées.
prompt_cache_options object (Facultatif)Pris en charge uniquement par qwen4-max. Mode de cache et TTL de cette requête.
mode stringimplicit / explicitttl string5m / 1h
usage objectInformations sur la consommation de jetons pour cette requête.Les séries Qwen4, Kimi-K3.1 et les nouveaux modèles ultérieurs utilisent la nouvelle structure de réponse ci-dessous.
input_tokens integerNombre de jetons en entrée. Notes supplémentairesoutput_tokens integerNombre de jetons dans la sortie du modèle.total_tokens integerLe nombre total de jetons consommés correspond à la somme de input_tokens et de output_tokens.input_tokens_details objectClassification détaillée des jetons d'entrée.
cached_tokens integerNombre de jetons ayant atteint le cache. Pour plus d'informations, consultez la section mise en cache du contexte.
output_tokens_details objectVentilation détaillée des jetons de sortie.
reasoning_tokens integerNombre de jetons de raisonnement.
x_details arrayTableau des détails de facturation pour la requête. Cela fournit une ventilation plus granulaire des jetons multimodaux que le champ usage de niveau supérieur.
input_tokens integerNombre de jetons en entrée. Notes supplémentairesoutput_tokens integerNombre de jetons dans la sortie du modèle.total_tokens integerLe nombre total de jetons consommés correspond à la somme de input_tokens et de output_tokens.x_billing_type stringLa valeur est fixée à response_api.image_tokens integerNombre de jetons pour l'entrée d'image. Ce champ est renvoyé lorsque l'entrée inclut une image et équivaut à input_tokens_details.image_tokens.input_tokens_details objectVentilation granulaire des jetons d'entrée. Ce champ est renvoyé pour les entrées multimodales. Il distingue actuellement uniquement les text_tokens et les image_tokens. Il ne fournit pas de ventilation pour les jetons vidéo ou audio.
text_tokens integerNombre de jetons pour l'entrée textuelle.image_tokens integerNombre de jetons pour l'entrée d'image.
output_tokens_details objectVentilation granulaire des jetons de sortie. Ce champ comporte un champ supplémentaire text_tokens par rapport au champ output_tokens_details de niveau supérieur. Le champ text_tokens est renvoyé pour les entrées multimodales.
reasoning_tokens integerNombre de jetons pour le processus de raisonnement.text_tokens integerNombre de jetons pour la sortie textuelle. Ce champ est renvoyé pour les entrées multimodales.
plugins objectStatistiques pour les appels d'outils intégrés. Ce champ est renvoyé lorsqu'un outil intégré tel que web_search est utilisé. Son contenu est identique à celui du champ x_tools de niveau supérieur.
web_search objectStatistiques pour les appels de recherche web.
count integerNombre d'appels de recherche web effectués dans cette réponse.
prompt_tokens_details objectDétails du cache pour les jetons d'entrée. Ce champ est renvoyé lorsque la mise en cache de session est activée. Il peut renvoyer un objet vide si l'entrée inclut une image mais entraîne un échec du cache.
cached_tokens integerNombre de jetons ayant atteint le cache.cache_creation_input_tokens integerNombre de jetons utilisés pour créer un nouveau cache dans cette requête.cache_creation objectDétails sur la création du cache.
ephemeral_5m_input_tokens integerNombre de jetons utilisés pour créer un nouveau cache éphémère de 5 minutes.
cache_type stringType de cache. La valeur est fixée à ephemeral.
x_tools objectStatistiques sur l'utilisation des outils. Cela contient le nombre d'appels pour chaque outil intégré.Exemple : {"web_search": {"count": 1}}
input_tokens integerTotal des tokens d’entrée, y compris lectures, créations de cache et entrée non mise en cache.input_tokens_details objectDétails des tokens d’entrée.
cache_write_tokens integerTokens écrits dans le cache.cache_write_tokens_details objectDétails de création du cache par TTL.
ttl_1h_tokens integerTokens écrits dans un cache d’une heure.ttl_5m_tokens integerTokens écrits dans un cache de 5 minutes.
cached_tokens integerTokens lus depuis le cache.
output_tokens integerTotal des tokens de sortie.output_tokens_details objectDétails des tokens de sortie.
reasoning_tokens integerTokens de raisonnement.
total_tokens integerSomme des tokens d’entrée et de sortie.La nouvelle structure de réponse ne renvoie ni x_details ni x_tools.
{
  "usage": {
    "input_tokens": 1053,
    "input_tokens_details": {
      "cache_write_tokens": 0,
      "cache_write_tokens_details": {
        "ttl_1h_tokens": 0,
        "ttl_5m_tokens": 0
      },
      "cached_tokens": 0
    },
    "output_tokens": 23,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 1076
  }
}
error objectUn objet d'erreur est renvoyé lorsque le modèle échoue à générer une réponse. Sinon, la valeur est null.
tools arrayRenvoie le contenu complet du paramètre tools de la requête, avec la même structure que le paramètre tools dans le corps de la requête.
tool_choice stringRenvoie la valeur du paramètre tool_choice de la requête. Les valeurs valides sont auto, none et required.

Objet de fragment de réponse (sortie en streaming)

Exemples de streaming pour la structure de réponse initiale.
// response.created: The response is created and queued.
{"response":{"id":"428c90e9-9cd6-90a6-9726-c02b08ebexxx","created_at":1769082930,"object":"response","status":"queued",...},"sequence_number":0,"type":"response.created"}

// response.in_progress: Processing begins.
{"response":{"id":"428c90e9-9cd6-90a6-9726-c02b08ebexxx","status":"in_progress",...},"sequence_number":1,"type":"response.in_progress"}

// response.output_item.added: A new output item is added.
{"item":{"id":"msg_bcb45d66-fc34-46a2-bb56-714a51e8exxx","content":[],"role":"assistant","status":"in_progress","type":"message"},"output_index":0,"sequence_number":2,"type":"response.output_item.added"}

// response.content_part.added: A new content part is added.
{"content_index":0,"item_id":"msg_bcb45d66-fc34-46a2-bb56-714a51e8exxx","output_index":0,"part":{"annotations":[],"text":"","type":"output_text","logprobs":null},"sequence_number":3,"type":"response.content_part.added"}

// response.output_text.delta: Incremental text (can be triggered multiple times).
{"content_index":0,"delta":"Artificial Intelligence","item_id":"msg_bcb45d66-fc34-46a2-bb56-714a51e8exxx","logprobs":[],"output_index":0,"sequence_number":4,"type":"response.output_text.delta"}
{"content_index":0,"delta":" (AI) refers to the technology","item_id":"msg_bcb45d66-fc34-46a2-bb56-714a51e8exxx","logprobs":[],"output_index":0,"sequence_number":6,"type":"response.output_text.delta"}

// response.output_text.done: Text generation for a content part is complete.
{"content_index":0,"item_id":"msg_bcb45d66-fc34-46a2-bb56-714a51e8exxx","logprobs":[],"output_index":0,"sequence_number":53,"text":"Artificial Intelligence (AI) refers to the technology and science that enables computer systems to simulate human intelligent behaviors...","type":"response.output_text.done"}

// response.content_part.done: The content part is complete.
{"content_index":0,"item_id":"msg_bcb45d66-fc34-46a2-bb56-714a51e8exxx","output_index":0,"part":{"annotations":[],"text":"...full text...","type":"output_text","logprobs":null},"sequence_number":54,"type":"response.content_part.done"}

// response.output_item.done: The output item is complete.
{"item":{"id":"msg_bcb45d66-fc34-46a2-bb56-714a51e8exxx","content":[{"annotations":[],"text":"...full text...","type":"output_text","logprobs":null}],"role":"assistant","status":"completed","type":"message"},"output_index":0,"sequence_number":55,"type":"response.output_item.done"}

// response.completed: The response is complete (includes full response and usage).
{"response":{"id":"428c90e9-9cd6-90a6-9726-c02b08ebexxx","created_at":1769082930,"model":"qwen3.7-max","object":"response","output":[...],"status":"completed","usage":{"input_tokens":37,"output_tokens":243,"total_tokens":280,...}},"sequence_number":56,"type":"response.completed"}
La sortie en streaming renvoie une série d’objets JSON. Chaque objet inclut un champ type pour spécifier le type d’événement et un champ sequence_number pour indiquer l’ordre des événements. L’événement response.completed marque la fin du flux.
type stringL’identifiant du type d’événement. Les valeurs possibles sont les suivantes :
  • response.created : La réponse est créée, avec un statut queued.
  • response.in_progress : Le traitement de la réponse commence et le statut passe à in_progress.
  • response.output_item.added : Un nouvel élément de sortie (par exemple, un message ou un appel web_extractor_call) est ajouté au tableau de sortie. Lorsque item.type est web_extractor_call, cela indique le début d’un appel à l’outil d’extraction web.
  • response.content_part.added : Une nouvelle partie de contenu est ajoutée au tableau content d’un élément de sortie.
  • response.output_text.delta : Un segment de texte incrémentiel est généré. Cet événement est déclenché plusieurs fois et le champ delta contient le nouveau segment de texte.
  • response.output_text.done : La génération de texte pour une partie de contenu est terminée. Le champ text contient le texte intégral.
  • response.content_part.done : Une partie de contenu est terminée. L’objet part contient la partie de contenu complète.
  • response.output_item.done : Un élément de sortie est terminé. L’objet item contient l’élément de sortie complet. Lorsque item.type est web_extractor_call, cela indique la fin d’un appel à l’outil d’extraction web.
  • response.reasoning_text.delta : (En mode raisonnement) Fournit une mise à jour incrémentielle du résumé du raisonnement. Le champ delta contient le nouveau segment.
  • response.reasoning_text.done : (En mode raisonnement) Le résumé du raisonnement est terminé. Le champ text contient le résumé intégral.
  • response.custom_tool_call_input.delta : Fournit une mise à jour incrémentielle de l’entrée d’appel d’outil personnalisé. Le champ delta contient le segment nouvellement généré.
  • response.custom_tool_call_input.done : L’entrée d’appel d’outil personnalisé est terminée. Le champ input contient l’entrée intégrale.
  • response.web_search_call.in_progress / searching / completed : Événement indiquant un changement d’état de la recherche lors de l’utilisation de l’outil web_search.
  • response.code_interpreter_call.in_progress / interpreting / completed : Événement indiquant un changement d’état d’exécution du code (lors de l’utilisation de l’outil code_interpreter).
  • Remarque : L’outil web_extractor ne possède pas d’identifiant de type d’événement dédié. Ses appels d’outil transitent par les événements généraux response.output_item.added et response.output_item.done et sont identifiés par le champ item.type ayant la valeur web_extractor_call.
  • response.mcp_call_arguments.delta / response.mcp_call_arguments.done : Ces événements fournissent le delta et l’état d’achèvement des arguments d’appel MCP.
  • response.mcp_call.in_progress : L’appel au service MCP est en cours.
  • response.mcp_call.completed : L’appel au service MCP est terminé.
  • response.file_search_call.in_progress / searching / completed : Événements de changement d’état pour une recherche dans la base de connaissances (lorsque vous utilisez l’outil file_search).
  • Remarque : Lors de l’utilisation des outils web_search_image et image_search, il n’existe pas d’événements d’état intermédiaire dédiés. Les appels d’outil sont communiqués via les événements response.output_item.added (début de l’appel) et response.output_item.done (fin de l’appel).
  • response.completed : La génération de la réponse est terminée. L’objet response contient la réponse complète, y compris l’utilisation. Cet événement marque la fin du flux.
  • response.incomplete : La réponse s’est interrompue prématurément en raison de limites telles que max_output_tokens.
sequence_number integerLe numéro de séquence de l’événement, commençant à 0 et s’incrémentant à chaque événement. Utilisez ce numéro pour traiter les événements dans le bon ordre.
response objectL’objet de réponse. Apparaît dans les événements response.created, response.in_progress et response.completed. Dans l’événement response.completed, il contient les données de réponse complètes (y compris output et usage), et sa structure est identique à celle de l’objet Response non diffusé en streaming.
item objectUn objet d’élément de sortie. Il apparaît dans les événements response.output_item.added et response.output_item.done. Dans l’événement added, il s’agit d’un squelette initial où le content est un tableau vide. Dans l’événement done, il s’agit d’un objet complet.
id stringUn identifiant unique pour l’élément de sortie (par exemple, msg_xxx).type stringLe type de l’élément de sortie. Valeurs possibles : message, reasoning, web_search_call, web_search_image_call (recherche d’images par texte), image_search_call (recherche d’images par image), mcp_call (appel MCP), file_search_call (recherche dans la base de connaissances).role stringLe rôle du message, qui est toujours assistant. Présent uniquement lorsque type est message.status stringStatut de génération. Dans un événement added, le statut est in_progress, et dans un événement done, il est completed.content arrayUn tableau de contenu de message. Dans l’événement added, le tableau est vide []. Dans l’événement done, il contient des objets de partie de contenu complets dont la structure est identique à celle de l’objet part.
part objectL’objet de partie de contenu. Apparaît dans les événements response.content_part.added et response.content_part.done.
type stringLe type de la partie de contenu, qui est toujours output_text.text stringContenu textuel. Il s’agit d’une chaîne vide dans l’événement added et du texte complet dans l’événement done.annotations arrayUn tableau d’annotations de texte. Généralement un tableau vide.logprobs object | nullProbabilités logarithmiques des jetons. Ce champ renvoie actuellement toujours null.
delta stringLe segment de texte incrémentiel. Ce champ apparaît dans l’événement response.output_text.delta et contient le segment de texte nouvellement ajouté. Concaténez toutes les valeurs delta pour reconstruire le texte intégral.
text stringLe contenu textuel complet. Ce champ apparaît dans l’événement response.output_text.done. Vous pouvez l’utiliser pour valider le texte reconstruit à partir des fragments delta.
item_id stringL’identifiant unique de l’élément de sortie. Utilisez cet ID pour corréler les événements appartenant au même élément.
output_index integerL’index de l’élément de sortie dans le tableau output.
content_index integerL’index de la partie de contenu dans le tableau content.

FAQ

Q : Comment transmettre le contexte pour une conversation multi-tours ? R : Lors d'une nouvelle demande de conversation, transmettez l'id de la réponse précédente réussie du modèle en tant que paramètre previous_response_id. Q : Pourquoi certains champs de l'exemple de réponse ne sont-ils pas décrits dans cette rubrique ? R : Le SDK OpenAI officiel peut générer des champs supplémentaires définis par le protocole OpenAI. Notre service ne prend pas en charge ces champs ; ils sont donc généralement null. Concentrez-vous uniquement sur les champs décrits dans cette rubrique.