Alibaba Cloud Model Studio は、OpenAI 互換インターフェイスと DashScope SDK を通じて、モデルへの API コールに対応しています。
Qwen API を呼び出すには、次の手順に従います。
API キーの取得
ローカル開発環境のセットアップ
Qwen API の呼び出し
アカウントのセットアップ
アカウントを作成:Alibaba Cloud アカウントがない場合は、作成します。
問題が発生した場合は、「Alibaba Cloud アカウントの登録」をご参照ください。
Model Studio の有効化:Alibaba Cloud アカウントを使用して、Alibaba Cloud Model Studio に移動します。利用規約を読んで同意し、サービスを有効化します。利用規約のダイアログが表示されない場合は、サービスはすでに有効化されています。
API キーの取得:API キー ページに移動し、Create API key をクリックします。その後、API キーを使用してモデルを呼び出します。
ワークスペース ID の取得: 中国 (北京)、シンガポール、日本 (東京)、ドイツ (フランクフルト)、または 中国 (香港) リージョンでモデルを呼び出す場合は、ベース URL にワークスペース ID (WorkspaceId) を含める必要があります。ワークスペース ID は、[ワークスペース管理] ページで確認できます。
API キーの環境変数としての設定
認証情報のハードコーディングを避け、セキュリティリスクを低減するため、API キーを環境変数に保存します。
開発言語の選択
モデル API を呼び出すための言語またはツールを選択します。
Python
ステップ 1: Python のセットアップ
Python バージョンの確認
仮想環境のセットアップ (オプション)
OpenAI Python SDK または DashScope Python SDK のインストール
ステップ 2: API の呼び出し
OpenAI Python SDK
Python と OpenAI Python SDK がインストールされた状態で、最初の API リクエストを送信します。
hello_qwen.pyという名前のファイルを作成します。このコードを
hello_qwen.pyにコピーして保存します。import os from openai import OpenAI try: client = OpenAI( # 環境変数が設定されていない場合は、api_key="sk-xxx" に置き換えてください api_key=os.getenv("DASHSCOPE_API_KEY"), # 次の URL は Singapore リージョン用です。呼び出し時に、WorkspaceId を実際のワークスペース ID に置き換えてください。URL はリージョンによって異なります。 base_url="https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1", ) completion = client.chat.completions.create( model="qwen-plus", messages=[ {'role': 'system', 'content': 'You are a helpful assistant.'}, {'role': 'user', 'content': 'Who are you?'} ] ) print(completion.choices[0].message.content) except Exception as e: print(f"エラーメッセージ: {e}") print("詳細はこちらをご参照ください: https://www.alibabacloud.com/help/model-studio/developer-reference/error-code")コマンドラインから
python hello_qwen.pyまたはpython3 hello_qwen.pyを実行します。No such file or directoryが表示された場合は、ファイルのフルパスを指定してください。出力は次のとおりです:
I am a large-scale language model developed by Alibaba Cloud. My name is Qwen.
DashScope Python SDK
Python と DashScope Python SDK がインストールされた状態で、最初の API リクエストを送信します。
hello_qwen.pyという名前のファイルを作成します。このコードを
hello_qwen.pyにコピーして保存します。import os from dashscope import Generation import dashscope # 次の URL は Singapore リージョン用です。呼び出し時に、WorkspaceId を実際のワークスペース ID に置き換えてください。URL はリージョンによって異なります。 dashscope.base_http_api_url = 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1' messages = [ {'role': 'system', 'content': 'You are a helpful assistant.'}, {'role': 'user', 'content': 'Who are you?'} ] response = Generation.call( # Singapore、US (Virginia)、および China (Beijing) の API キーは相互に交換できません。API キーの取得: https://www.alibabacloud.com/help/model-studio/get-api-key # 環境変数が設定されていない場合は、api_key = "sk-xxx" に置き換えてください api_key=os.getenv("DASHSCOPE_API_KEY"), model="qwen-plus", messages=messages, result_format="message" ) if response.status_code == 200: print(response.output.choices[0].message.content) else: print(f"HTTP ステータスコード: {response.status_code}") print(f"エラーコード: {response.code}") print(f"エラーメッセージ: {response.message}") print("詳細はこちらをご参照ください: https://www.alibabacloud.com/help/model-studio/developer-reference/error-code")コマンドラインから
python hello_qwen.pyまたはpython3 hello_qwen.pyを実行します。説明この例のコマンドは、Python ファイルを含むディレクトリから実行する必要があります。他の場所から実行するには、完全なパスを指定してください。
出力は次のとおりです:
I am a large-scale language model developed by Alibaba Cloud. My name is Qwen.
Node.js
ステップ 1: Node.js 環境のセットアップ
Node.js のインストールの確認
モデル呼び出し SDK のインストール
ステップ 2: モデル API の呼び出し
hello_qwen.mjsという名前のファイルを作成します。このコードをファイルにコピーしてください。
import OpenAI from "openai"; try { const openai = new OpenAI( { // 環境変数が設定されていない場合は、apiKey: "sk-xxx" に置き換えてください apiKey: process.env.DASHSCOPE_API_KEY, // 次の URL は Singapore リージョン用です。呼び出し時に、WorkspaceId を実際のワークスペース ID に置き換えてください。URL はリージョンによって異なります。 baseURL: "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1" } ); const completion = await openai.chat.completions.create({ model: "qwen-plus", messages: [ { role: "system", content: "You are a helpful assistant." }, { role: "user", content: "Who are you?" } ], }); console.log(completion.choices[0].message.content); } catch (error) { console.log(`エラーメッセージ: ${error}`); console.log("詳細はこちらをご参照ください: https://www.alibabacloud.com/help/model-studio/developer-reference/error-code"); }このコマンドを実行して API リクエストを送信してください。
node hello_qwen.mjs説明このコマンドは
hello_qwen.mjsを含むディレクトリから実行してください。任意の場所から実行するには、ファイルのフルパスを指定してください。SDK が
hello_qwen.mjsと同じディレクトリにインストールされていることを確認してください。異なるディレクトリにある場合、Cannot find package 'openai' imported from xxxが表示されます。
正常に実行されると、出力は次のようになります:
I am a large-scale language model developed by Alibaba Cloud. My name is Qwen.
Java
ステップ 1: Java 環境のセットアップ
Java バージョンの確認
モデル呼び出し SDK のインストール
ステップ 2: API の呼び出し
このコードを実行して、モデル API を呼び出してください。
import java.util.Arrays;
import java.lang.System;
import com.alibaba.dashscope.aigc.generation.Generation;
import com.alibaba.dashscope.aigc.generation.GenerationParam;
import com.alibaba.dashscope.aigc.generation.GenerationResult;
import com.alibaba.dashscope.common.Message;
import com.alibaba.dashscope.common.Role;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.protocol.Protocol;
public class Main {
public static GenerationResult callWithMessage() throws ApiException, NoApiKeyException, InputRequiredException {
// 次の URL は Singapore リージョン用です。呼び出し時に、WorkspaceId を実際のワークスペース ID に置き換えてください。URL はリージョンによって異なります。
Generation gen = new Generation(Protocol.HTTP.getValue(), "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1");
Message systemMsg = Message.builder()
.role(Role.SYSTEM.getValue())
.content("You are a helpful assistant.")
.build();
Message userMsg = Message.builder()
.role(Role.USER.getValue())
.content("Who are you?")
.build();
GenerationParam param = GenerationParam.builder()
// Singapore、US (Virginia)、および China (Beijing) の API キーは相互に交換できません。API キーの取得: https://www.alibabacloud.com/help/model-studio/get-api-key
// 環境変数が設定されていない場合は、.apiKey("sk-xxx") に置き換えてください
.apiKey(System.getenv("DASHSCOPE_API_KEY"))
// モデルリスト: https://www.alibabacloud.com/help/model-studio/getting-started/models
.model("qwen-plus")
.messages(Arrays.asList(systemMsg, userMsg))
.resultFormat(GenerationParam.ResultFormat.MESSAGE)
.build();
return gen.call(param);
}
public static void main(String[] args) {
try {
GenerationResult result = callWithMessage();
System.out.println(result.getOutput().getChoices().get(0).getMessage().getContent());
} catch (ApiException | NoApiKeyException | InputRequiredException e) {
System.err.println("エラーメッセージ: "+e.getMessage());
System.out.println("詳細はこちらをご参照ください: https://www.alibabacloud.com/help/model-studio/developer-reference/error-code");
}
System.exit(0);
}
}出力は次のとおりです:
I am a large-scale language model developed by Alibaba Cloud. My name is Qwen.curl
OpenAI 互換または DashScope HTTP エンドポイントを使用して、Model Studio 上のモデルを呼び出してください。サポートされているモデルについては、「モデルリスト」をご参照ください。
DASHSCOPE_API_KEY が設定されていない場合は、-H "Authorization: Bearer $DASHSCOPE_API_KEY" を -H "Authorization: Bearer sk-xxx" に置き換えてください。
OpenAI 互換 HTTP
この例の URL は シンガポール リージョンを使用しています。WorkspaceId を実際のワークスペース ID に置き換えてください。URL はリージョンによって異なります。中国 (北京) リージョンを使用する場合は、URL を https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/chat/completions に置き換えてください。
API リクエストを送信してください:
API リクエストを送信すると、次のレスポンスが返されます:
{
"choices": [
{
"message": {
"role": "assistant",
"content": "I am a large-scale language model developed by Alibaba Cloud. My name is Qwen."
},
"finish_reason": "stop",
"index": 0,
"logprobs": null
}
],
"object": "chat.completion",
"usage": {
"prompt_tokens": 22,
"completion_tokens": 16,
"total_tokens": 38
},
"created": 1728353155,
"system_fingerprint": null,
"model": "qwen-plus",
"id": "chatcmpl-39799876-eda8-9527-9e14-2214d641cf9a"
}DashScope HTTP
この例の URL は Singapore リージョンを使用しています。WorkspaceId を実際のワークスペース ID に置き換えてください。URL はリージョンによって異なります。
米国 (バージニア) リージョンを使用する場合、URL を
https://dashscope-us.aliyuncs.com/api/v1/services/aigc/text-generation/generationに置き換えてください。中国 (北京) リージョンを使用する場合、URL を
https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/text-generation/generationに置き換えます。{WorkspaceId} は、お使いのワークスペース ID に置き換えてください。
API リクエストを送信してください:
API リクエストを送信すると、次のレスポンスが返されます:
{
"output": {
"choices": [
{
"finish_reason": "stop",
"message": {
"role": "assistant",
"content": "I am a large-scale language model developed by Alibaba Cloud. My name is Qwen."
}
}
]
},
"usage": {
"total_tokens": 38,
"output_tokens": 16,
"input_tokens": 22
},
"request_id": "87f776d7-3c82-9d39-b238-d1ad38c9b6a9"
}その他の言語
モデル API の呼び出し
package main
import (
"bytes"
"encoding/json"
"fmt"
"io"
"log"
"net/http"
"os"
)
type Message struct {
Role string `json:"role"`
Content string `json:"content"`
}
type RequestBody struct {
Model string `json:"model"`
Messages []Message `json:"messages"`
}
func main() {
// HTTP クライアントを作成します
client := &http.Client{}
// リクエストボディを構築します
requestBody := RequestBody{
// モデルリスト: https://www.alibabacloud.com/help/model-studio/getting-started/models
Model: "qwen-plus",
Messages: []Message{
{
Role: "system",
Content: "You are a helpful assistant.",
},
{
Role: "user",
Content: "Who are you?",
},
},
}
jsonData, err := json.Marshal(requestBody)
if err != nil {
log.Fatal(err)
}
// 次の URL は Singapore リージョン用です。呼び出し時に、WorkspaceId を実際のワークスペース ID に置き換えてください。URL はリージョンによって異なります。
req, err := http.NewRequest("POST", "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/chat/completions", bytes.NewBuffer(jsonData))
if err != nil {
log.Fatal(err)
}
// リクエストヘッダーを設定します
// Singapore、US (Virginia)、および China (Beijing) の API キーは相互に交換できません。API キーの取得: https://www.alibabacloud.com/help/model-studio/get-api-key
// 環境変数が設定されていない場合は、apiKey := "sk-xxx" に置き換えてください
apiKey := os.Getenv("DASHSCOPE_API_KEY")
req.Header.Set("Authorization", "Bearer "+apiKey)
req.Header.Set("Content-Type", "application/json")
// リクエストを送信します
resp, err := client.Do(req)
if err != nil {
log.Fatal(err)
}
defer resp.Body.Close()
// レスポンスボディを読み取ります
bodyText, err := io.ReadAll(resp.Body)
if err != nil {
log.Fatal(err)
}
// レスポンスを出力します
fmt.Printf("%s\n", bodyText)
}
<?php
// 次の URL は Singapore リージョン用です。呼び出し時に、WorkspaceId を実際のワークスペース ID に置き換えてください。URL はリージョンによって異なります。
$url = 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/chat/completions';
// Singapore、US (Virginia)、および China (Beijing) の API キーは相互に交換できません。API キーの取得: https://www.alibabacloud.com/help/model-studio/get-api-key
// 環境変数が設定されていない場合は、$apiKey = "sk-xxx" に置き換えてください
$apiKey = getenv('DASHSCOPE_API_KEY');
// リクエストヘッダーを設定します
$headers = [
'Authorization: Bearer '.$apiKey,
'Content-Type: application/json'
];
// リクエストボディを設定します
$data = [
"model" => "qwen-plus",
"messages" => [
[
"role" => "system",
"content" => "You are a helpful assistant."
],
[
"role" => "user",
"content" => "Who are you?"
]
]
];
// cURL セッションを初期化します
$ch = curl_init();
// cURL オプションを設定します
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
// cURL セッションを実行します
$response = curl_exec($ch);
// エラーを確認します
if (curl_errno($ch)) {
echo 'Curl error: ' . curl_error($ch);
}
// cURL リソースを閉じます
curl_close($ch);
// レスポンスを出力します
echo $response;
?>using System.Net.Http.Headers;
using System.Text;
class Program
{
private static readonly HttpClient httpClient = new HttpClient();
static async Task Main(string[] args)
{
// Singapore、US (Virginia)、および China (Beijing) の API キーは相互に交換できません。API キーの取得: https://www.alibabacloud.com/help/model-studio/get-api-key
// 環境変数が設定されていない場合は、string? apiKey = "sk-xxx" に置き換えてください
string? apiKey = Environment.GetEnvironmentVariable("DASHSCOPE_API_KEY");
if (string.IsNullOrEmpty(apiKey))
{
Console.WriteLine("API キーが設定されていません。'DASHSCOPE_API_KEY' 環境変数が設定されていることを確認してください。");
return;
}
// 次の URL は Singapore リージョン用です。呼び出し時に、WorkspaceId を実際のワークスペース ID に置き換えてください。URL はリージョンによって異なります。
string url = "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/chat/completions";
// モデルリスト: https://www.alibabacloud.com/help/model-studio/getting-started/models
string jsonContent = @"{
""model"": ""qwen-plus"",
""messages"": [
{
""role"": ""system"",
""content"": ""You are a helpful assistant.""
},
{
""role"": ""user"",
""content"": ""Who are you?""
}
]
}";
// リクエストを送信してレスポンスを取得します
string result = await SendPostRequestAsync(url, jsonContent, apiKey);
// 結果を出力します
Console.WriteLine(result);
}
private static async Task<string> SendPostRequestAsync(string url, string jsonContent, string apiKey)
{
using (var content = new StringContent(jsonContent, Encoding.UTF8, "application/json"))
{
// リクエストヘッダーを設定します
httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", apiKey);
httpClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
// リクエストを送信してレスポンスを取得します
HttpResponseMessage response = await httpClient.PostAsync(url, content);
// レスポンスを処理します
if (response.IsSuccessStatusCode)
{
return await response.Content.ReadAsStringAsync();
}
else
{
return $"リクエスト失敗: {response.StatusCode}";
}
}
}
}API リファレンス
入力および出力パラメーターについては、Qwen API リファレンスをご参照ください。
その他のモデルについては、モデルリストをご参照ください。
よくある質問
モデル API の呼び出し後に Model.AccessDenied エラーを解決するにはどうすればよいですか?
A:このエラーは、サブワークスペースの API キーを使用していることが原因で発生します。サブワークスペースは、デフォルトワークスペース内のアプリケーションまたはモデルにアクセスできません。サブワークスペースの API キーを使用するには、ルートアカウントの管理者が、該当するサブワークスペースに対してモデルの認可を付与する必要があります(たとえば、このトピックでは Qwen-Plus モデルを使用しています)。手順の詳細については、モデル呼び出し権限の設定をご参照ください。
次のステップ
その他のモデルの探索 | サンプルコードでは |
高度な機能の学習 | サンプルコードでは基本的な Q&A のみを扱っています。ストリーミング出力、構造化出力、関数呼び出しなどの Qwen API の詳細については、「テキスト生成モデルの概要」をご参照ください。 |
ブラウザでのモデルの試用 | Qwen チャットのように ダイアログボックス を通じてモデルと対話したい場合は、プレイグラウンドにアクセスしてください。 |











