Skip to main content

Qwen-Deep-Research API reference

Paramètres de requête et de réponse pour appeler le modèle Qwen-Deep-Research via l'API DashScope.

Documentation associée : Recherche approfondie (Qwen-Deep-Research)
Qwen-Deep-Research est disponible uniquement dans la région Chine (Pékin). Utilisez une clé API de la région Chine (Pékin).
Ce modèle prend actuellement en charge uniquement le SDK Python DashScope. Le SDK Java et l'interface compatible OpenAI ne sont pas pris en charge.

DashScope

Avant de commencer, obtenez une clé API et définissez-la comme variable d'environnement . Pour utiliser le SDK DashScope, installez également le SDK .

Corps de la requête

Python
import os
import dashscope
# The following is the base_url for the Beijing region. Replace WorkspaceId with your actual workspace ID. Configurations vary by region.
dashscope.base_http_api_url = "https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1"

# Step 1: Get the clarifying question from the model.
messages = [{'role': 'user', 'content': 'Research the applications of artificial intelligence in education'}]

responses = dashscope.Generation.call(
    api_key=os.getenv('DASHSCOPE_API_KEY'),
    model="qwen-deep-research",
    messages=messages,
    stream=True
)

# Collect the model's clarifying question.
step1_content = ""
for response in responses:
    if hasattr(response, 'output') and response.output:
        message = response.output.get('message', {})
        content = message.get('content', '')
        if content:
            step1_content += content
            print(content, end='', flush=True)

# Step 2: Start the deep research.
messages = [
    {'role': 'user', 'content': 'Research the applications of artificial intelligence in education'},
    {'role': 'assistant', 'content': step1_content},
    {'role': 'user', 'content': 'I want to focus on personalized learning and intelligent assessment.'}
]

responses = dashscope.Generation.call(
    api_key=os.getenv('DASHSCOPE_API_KEY'),
    model="qwen-deep-research",
    messages=messages
)

# Stream the research results.
for response in responses:
    if hasattr(response, 'output') and response.output:
        message = response.output.get('message', {})
        content = message.get('content', '')
        if content:
            print(content, end='', flush=True)
modelstring(Obligatoire)Valeur prise en charge : qwen-deep-research.
messagesarray(Obligatoire)Historique de la conversation, par ordre chronologique.

Types de messages

Message utilisateurobject(Obligatoire)Un message utilisateur transmet des questions, des instructions ou du contexte au modèle. Dans le flux d'appel en deux étapes de Qwen-Deep-Research, les messages utilisateur ont des fonctions distinctes :
  • Étape 1 (Question de clarification) : Ce message initie la demande de recherche avec un sujet large.
  • Étape 2 (Recherche approfondie) : Ce message répond à la question de clarification du modèle afin de préciser le périmètre de recherche pour une analyse plus ciblée.
contentstring(Obligatoire)Contenu du message.rolestring(Obligatoire)Doit être user.
Message assistant object(Facultatif)Réponse du modèle à un message utilisateur. Pour l'étape 2 (Recherche approfondie), transmettez la question de clarification générée à l'étape 1 afin d'obtenir une analyse plus ciblée.contentstring(Facultatif)Contenu du message.rolestring(Obligatoire)Doit être assistant.
output_formatstring(Facultatif)Format et niveau de détail du rapport de recherche. Valeurs valides :
  • model_detailed_report (Par défaut) Rapport complet (~6 000 tokens) pour une analyse approfondie.
  • model_summary_report Résumé concis (~1 500–2 000 tokens) présentant les conclusions clés.

Objet de réponse

{
  "status_code": 200,
  "request_id": "2a6187f0-7e7b-40bb-a87e-xxx",
  "code": "",
  "message": "",
  "output": {
        "text": null,
        "finish_reason": null,
        "choices": null,
        "message": {
            "phase": "ResearchPlanning",
            "role": "assistant",
            "content": "",
            "extra": {
                "deep_research": {}
            },
            "status": "typing"
        },
        "fininshed": false,
        "fininshed_reason": "null"
    },
    "usage": {
        "input_tokens": 694,
        "output_tokens": 0
    },
    "request_id": "2a6187f0-7e7b-40bb-xxx"
}
status_codestringCode de statut HTTP de la requête. La valeur 200 indique un succès ; toute autre valeur signale une erreur.
En cas d'échec, l'exception levée contient status_code et message.
request_idstringIdentifiant unique de la requête.
codestringCode d'erreur. Ce champ est vide en cas de succès.
Le SDK Python retourne ce paramètre uniquement.
message stringMessage d'erreur. Ce champ est vide en cas de succès.
outputobjectRésultat de l'appel.
textstringCe paramètre est toujours null.finish_reasonstringRaison de l'arrêt de la génération de contenu par le modèle. Valeurs possibles :
  • null : Génération en cours.
  • stop : Génération terminée naturellement.
  • length : Longueur maximale du contenu atteinte.
choicesarrayListe des choix de sortie produits par le modèle.
finish_reasonstringValeurs possibles :
  • null : Génération en cours.
  • stop : Génération terminée naturellement.
  • length : Longueur maximale du contenu atteinte.
messageobjectObjet message provenant du modèle.
PropriétésphasestringPhase actuelle. Valeurs possibles :
  • answer
  • ResearchPlanning
  • WebResearch
  • KeepAlive
rolestringDoit être assistant.contentstringContenu de sortie généré par le modèle.extra arrayRésultats de recherche web et références collectés par le modèle.deep_researchobjectLes informations de recherche web et de référence récupérées apparaissent uniquement aux étapes answer et WebResearch. Elles sont null à toutes les autres étapes.researchobjectDétails du processus de recherche.
researchGoalstringObjectif de la recherche.querystringRequête utilisée lors de la recherche.idintegerNuméro du cycle de recherche, compris dans l'intervalle [1, 15].learningMapobjectContenu résumé à partir des appels d'outils, associé à l'utilisation de ces outils.referencesobjectCitations pour la réponse générée. Ce champ apparaît uniquement durant la phase de réponse.
icon stringURL du favicon pour le contenu référencé.index_number integerIndex du contenu référencé.descriptionstringBrève description du contenu référencé.titlestringTitre de la page web référencée.url stringURL du contenu référencé.
webSitesobjectContenu référencé pendant la recherche. Inclus uniquement durant la phase de recherche web.
icon stringURL du favicon pour le contenu référencé.index_number integerIndex du contenu référencé.descriptionstringBrève description du contenu référencé.titlestringTitre de la page web du contenu référencé.url stringURL du contenu référencé.
statusstringStatut d'une phase spécifique lors du streaming :
  • typing : Le modèle génère du contenu pour la phase en cours.
  • finished : La phase actuelle est terminée.
  • streamingQueries : Le modèle génère des objectifs de recherche et des requêtes.
  • streamingWebResult : Recherche web, lecture de pages et exécution de code en cours.
  • WebResultFinished : La phase de recherche web est terminée.
fininshedbooleanIndique si le flux est terminé. Valeurs possibles :
  • false : Streaming en cours.
  • true : Message final.
fininshed_reason stringRaison de la fin du flux de sortie. Valeurs possibles :
  • null : Génération en cours.
  • stop : Flux terminé normalement.
usageobjectNombre de tokens utilisés pour cette requête.
input_tokens integerNombre de tokens en entrée.output_tokens integerNombre de tokens en sortie.