Les modèles Qwen disponibles sur Model Studio prennent en charge les interfaces compatibles avec OpenAI. Vous pouvez migrer votre code OpenAI existant vers Model Studio en modifiant uniquement la clé API, l'URL de base et le nom du modèle.
Informations sur la compatibilité
BASE_URL
Le paramètre BASE_URL correspond au point de terminaison réseau permettant d'accéder au service de modèle. Lorsque vous utilisez l'interface compatible OpenAI avec Model Studio, configurez le paramètre BASE_URL comme suit.
Lorsque vous effectuez des appels via le SDK OpenAI ou d'autres SDK compatibles OpenAI, utilisez le paramètre BASE_URL suivant :
Dépannage des échecs d'appel : Si un appel via l'interface compatible OpenAI échoue avec une erreur 404, 401, 403 ou une erreur de connexion, vérifiez les configurations suivantes :
Appels interrégionaux
Une clé API Model Studio est liée à la région dans laquelle elle a été créée. Lorsque vous appelez l'URL de base d'une région, vous devez utiliser une clé API créée dans cette même région. Une clé API provenant d'une autre région sera rejetée avec une erreur d'authentification.
Cette règle s'applique à toutes les régions disposant d'un point de terminaison, notamment Chine (Pékin), États-Unis (Virginie), Singapour et Japon (Tokyo), ainsi que Chine (Hong Kong). Créez la clé API dans la console de la région dont vous utilisez le point de terminaison.
Par exemple, si vous utilisez une clé API créée dans la région Chine (Pékin) pour appeler le point de terminaison États-Unis (Virginie), la requête renvoie un code HTTP 401 avec le message d'erreur Incorrect API key provided et le code d'erreur invalid_api_key. Cette erreur indique que la clé API et le point de terminaison appartiennent à des régions différentes, et non que la clé API est invalide ou manque d'autorisations.
Modèles pris en charge
Modèles pris en charge : modèles de langage large Qwen (éditions commerciales et open source), Qwen-VL, Qwen-Coder, Qwen-Omni, Qwen-Math, DeepSeek , Kimi , GLM , MiniMax .
Qwen-Audio ne prend pas en charge le protocole compatible OpenAI. Utilisez plutôt le protocole DashScope.
Appel via le SDK OpenAI
Prérequis
- Python est installé sur votre machine.
- La dernière version du SDK OpenAI est installée.
- Vous avez activé Model Studio et obtenu une clé API. Pour plus d'instructions, consultez la section Obtenir une clé API.
- (Recommandé) Configurez la clé API en tant que variable d'environnement afin de réduire le risque d'exposition de la clé. Vous pouvez également la configurer directement dans le code, mais cela augmente le risque d'exposition.
- Sélectionnez le modèle que vous souhaitez utiliser dans la liste des modèles pris en charge.
Utilisation
Les exemples suivants montrent comment utiliser le SDK OpenAI pour accéder aux modèles Qwen sur Model Studio.
Exemple sans streaming
qwen3.8-max ci-dessous illustre les champs de réponse.
Exemple avec streaming
qwen3.8-max ci-dessous illustre les champs de réponse.
Exemple d'appel d'outil
L'exemple suivant illustre l'appel d'outil (appel de fonction) via l'interface compatible OpenAI, en utilisant un outil de requête météo et un outil de requête horaire. Le code exemple prend en charge les appels d'outils multi-tours.
Paramètres de requête
Les paramètres de requête sont alignés sur l'interface OpenAI. Le tableau suivant décrit les paramètres actuellement pris en charge :
Parameter | Type | Default | Description |
|---|---|---|---|
model | string | - | The model to use. For available models, see Supported models. |
messages | array | - | The conversation history between the user and the model. Each array element has the format |
top_p (optional) | float | - | The nucleus sampling probability threshold. For example, a value of 0,8 keeps only the smallest set of tokens whose cumulative probability is at least 0.8. Valid values: (0, 1.0). Higher values increase randomness; lower values increase determinism. |
temperature (optional) | float | - | Controls the randomness and diversity of model responses. Higher values flatten the probability distribution, selecting more low-probability tokens for more diverse output. Lower values sharpen the distribution, favoring high-probability tokens for more deterministic output. Valid values: [0, 2). A value of 0 is not recommended. |
presence_penalty (optional) | float | - | Controls repetition across the entire generated sequence. Higher values reduce repetition. Valid values: [-2.0, 2.0]. Supported only on Qwen commercial models and open-source models qwen1,5 and later. |
n (optional) | integer | 1 | The number of responses to generate. Valid values: |
max_tokens (optional) | integer | - | The maximum number of tokens the model can generate. For example, if the model supports up to 2k output tokens, you can set this to 1k to prevent overly long responses. Different models have different output limits. See the model list for details. |
seed (optional) | integer | - | The random seed for generation, used to control randomness of model output. Supports unsigned 64-bit integers. |
stream (optional) | boolean | False | Controls whether to use streaming output. When streaming is enabled, the interface returns a generator. Iterate over it to get results, where each output is the incremental sequence generated. |
stop (optional) | string or array | None | Controls precise stopping of content generation. Generation stops automatically when the model is about to produce the specified string or token_id. Can be a string or array type. When string type: generation stops when the model is about to produce the specified stop word. When array type: array elements can be token_ids, strings, or arrays of token_ids. Generation stops when the generated token or its token_id matches an element in stop. When stop is array type, you cannot mix token_ids and strings as elements. |
tools (optional) | array | None | The tool library available for the model to call. During a function call flow, the model selects one tool from this library. Each tool has the following structure: The tools parameter cannot be used with stream=True simultaneously. |
stream_options (optional) | object | None | Configures whether to display token usage in streaming output. Only takes effect when stream is True. To count tokens in streaming mode, set |
Paramètres de réponse
Parameter | Type | Description | Notes |
|---|---|---|---|
id | string | L'ID généré par le système pour cette requête. | - |
model | string | Le nom du modèle utilisé pour cette requête. | - |
system_fingerprint | string | La version de configuration utilisée par l'environnement d'exécution du modèle. Actuellement non pris en charge ; renvoie une chaîne vide. | - |
choices | array | Les détails du contenu généré par le modèle. | - |
choices[i].finish_reason | string | La raison de l'arrêt de la génération. Valeurs : null (génération en cours), stop (arrêt dû à une condition d'arrêt), length (arrêt dû au dépassement de la longueur maximale). | - |
choices[i].message | object | Le message produit par le modèle. | - |
choices[i].message.role | string | Le rôle du modèle. Valeur fixe : assistant. | - |
choices[i].message.content | string | Le texte généré par le modèle. | - |
choices[i].index | integer | Le numéro de séquence du résultat généré. Par défaut : 0. | - |
created | integer | L'horodatage (en secondes) du résultat généré. | - |
usage | object | Informations de facturation indiquant la consommation de jetons pour cette requête. | - |
usage.prompt_tokens | integer | Le nombre de jetons du texte saisi par l'utilisateur. | - |
usage.completion_tokens | integer | Le nombre de jetons de la réponse générée par le modèle. | - |
usage.total_tokens | integer | La somme de usage.prompt_tokens et usage.completion_tokens. | - |
Appel via le SDK langchain_openai
Prérequis
- Python est installé sur votre machine.
- Le SDK langchain_openai est installé.
- Vous avez activé Model Studio et obtenu une clé API. Pour obtenir des instructions, consultez la rubrique Obtenir une clé API.
- (Recommandé) Configurez la clé API en tant que variable d'environnement afin de réduire les risques d'exposition de la clé. Vous pouvez également la configurer directement dans le code, mais cela augmente les risques d'exposition.
- Sélectionnez le modèle que vous souhaitez utiliser dans la liste des modèles pris en charge.
Utilisation
Les exemples suivants montrent comment utiliser le SDK langchain_openai pour accéder aux modèles Qwen sur Model Studio.
Sortie non diffusée (non-streaming)
La sortie non diffusée utilise la méthode invoke :
Sortie en flux continu (streaming)
La sortie en flux continu utilise la méthode stream . Vous n'avez pas besoin de configurer séparément un paramètre de flux.
Appel via HTTP
Vous pouvez appeler Model Studio via des requêtes HTTP et recevoir des réponses structurées de la même manière que les réponses HTTP OpenAI.
Prérequis
- Vous avez activé Model Studio et obtenu une clé API. Pour obtenir des instructions, consultez la rubrique Obtenir une clé API.
- (Recommandé) Configurez la clé API en tant que variable d'environnement afin de réduire les risques d'exposition de la clé. Vous pouvez également la configurer directement dans le code, mais cela augmente les risques d'exposition.
Endpoint
Exemples de requêtes
Les exemples suivants utilisent des commandes cURL pour appeler l'API.
$DASHSCOPE_API_KEY par votre clé API réelle.Sortie non diffusée (non-streaming)
qwen3.8-max ci-dessous illustre les champs de réponse.
Sortie en flux continu (streaming)
Pour utiliser la sortie en flux continu, définissez le paramètre stream sur true dans le corps de la requête.
qwen3.8-max ci-dessous illustre les champs de réponse.
Réponse d'erreur
Lorsqu'une requête échoue, la réponse inclut les champs code et message indiquant la cause :
Configuration d'un client tiers
Vous pouvez appeler les modèles Model Studio depuis n'importe quel client tiers prenant en charge le protocole compatible OpenAI. Les étapes suivantes utilisent le client Zhipu à titre d'exemple :
- Dans les paramètres du fournisseur du client, sélectionnez Custom provider.
-
Base URL : Saisissez l'URL de base utilisée par le SDK OpenAI pour votre région. Pour connaître l'URL de base de chaque région, consultez la section BASE_URL . L'URL de base se termine par
/compatible-mode/v1et n'inclut pas/chat/completions. Étant donné que les URL de base diffèrent selon les régions, utilisez celle correspondant à la région de votre clé API. Par exemple, pour la région Singapour, saisissezhttps://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1. Remplacez{WorkspaceId}par votre ID d'espace de travail, que vous trouverez sur la page des détails de l'espace de travail dans la console Model Studio. Le domaine héritéhttps://dashscope.aliyuncs.comreste disponible, mais utilisez autant que possible le domaine spécifique à l'espace de travail. - API Key : Saisissez la clé API Model Studio pour la région pointée par l'URL de base. Vous pouvez créer et obtenir une clé API sur la page de gestion des clés API de la console Model Studio.
-
Model name : Saisissez le nom d'un grand modèle de langage prenant en charge le protocole compatible OpenAI. Pour consulter les modèles disponibles, reportez-vous à la section Modèles pris en charge . Par exemple,
qwen3.7-plus. Ce nom de modèle est fourni à titre d'exemple uniquement et n'indique pas que le modèle offre un quota gratuit. - Enregistrez la configuration et démarrez une conversation pour vérifier que le client tiers peut appeler le modèle.
error.message défini sur current user api does not support http call et error.type défini sur invalid_request_error . Cette erreur signifie que le modèle que vous avez saisi ne prend pas en charge les appels HTTP via l'interface compatible OpenAI. Remplacez-le par un modèle issu de la section Modèles pris en charge et réessayez.
Codes d'erreur
Error code | Description |
|---|---|
400 - Invalid Request Error | La requête n'est pas valide. Consultez le message d'erreur pour plus de détails. |
401 - Incorrect API key provided | La clé API est incorrecte. |
429 - Rate limit reached for requests | Limite QPS ou QPM dépassée. |
429 - You exceeded your current quota, please check your plan and billing details | Quota dépassé ou compte impayé. |
500 - The server had an error while processing your request | Erreur serveur. |
503 - The engine is currently overloaded, please try again later | Serveur surchargé. Réessayez ultérieurement. |