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 Key ページにアクセスし、Create API key をクリックします。その後、API キーを使用してモデルを呼び出します。
API キーを作成する際にモデルを選択する必要はありません。リクエストボディの
modelパラメーターを使用して呼び出すモデルを指定します (例:model="qwen-plus")。サポートされているモデルについては、「モデルリスト」をご参照ください。API キーが呼び出せるモデルを制限するには、キー作成時に [Custom] 権限を選択し、[モデルアクセススコープ] スイッチをオンにします。これにより、キーは選択したモデルのみを呼び出せるようになります。 -
ワークスペース ID を取得:中国 (北京)、シンガポール、日本 (東京)、ドイツ (フランクフルト)、または中国 (香港)リージョンでモデルを呼び出す場合、ベース URL にワークスペース ID (WorkspaceId) を含める必要があります。ワークスペース ID は、ワークスペース管理ページで確認できます。米国 (バージニア) リージョンでは、API エンドポイントとして
{WorkspaceId}.us-east-1.maas.aliyuncs.comを直接使用してください。他のリージョンとは異なり、ベース URL にワークスペース ID (WorkspaceId) を含める必要はありません。
API キーの環境変数設定
API キーを環境変数に保存することで、認証情報のハードコーディングを回避し、セキュリティリスクを低減します。
手順
Linux
永続的
現在のユーザーのすべての新しいセッションで API キーを利用できるようにするには、永続的な環境変数に設定します。
- 次のコマンドを実行して、環境変数の設定を
~/.bashrcファイルに追記します。
# YOUR_DASHSCOPE_API_KEY をお使いの Model Studio API キーに置き換えます
echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.bashrc
別の方法として、~/.bashrc ファイルを手動で編集することもできます。
次のコマンドを実行して、~/.bashrc ファイルを開きます。
nano ~/.bashrc 次の内容を設定ファイルに追加します。
# YOUR_DASHSCOPE_API_KEY をお使いの Model Studio API キーに置き換えます
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
nano エディターで、Ctrl+X、Y、Enter の順にキーを押して、ファイルを保存して閉じます。 2. 次のコマンドを実行して変更を適用します。
source ~/.bashrc
3. 新しいターミナルウィンドウを開き、次のコマンドを実行して、環境変数が設定されていることを確認します。
echo $DASHSCOPE_API_KEY
一時的
現在のセッションでのみ環境変数を使用するには、一時的な環境変数に設定します。
- 次のコマンドを実行します。
# YOUR_DASHSCOPE_API_KEY をお使いの Model Studio API キーに置き換えます
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
-
次のコマンドを実行して、環境変数が設定されていることを確認します。
echo $DASHSCOPE_API_KEY
macOS
永続的
現在のユーザーのすべての新しいセッションで API キーを利用できるようにするには、永続的な環境変数に設定します。
-
ターミナルで次のコマンドを実行して、デフォルトのシェルの種類を確認します。
echo $SHELL -
デフォルトのシェルの種類に基づいて続行します。
Zsh- 環境変数の設定を
~/.zshrcファイルに追記するには、次のコマンドを実行します。
- 環境変数の設定を
# YOUR_DASHSCOPE_API_KEY をお使いの Model Studio API キーに置き換えます
echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.zshrc
別の方法として、~/.zshrcファイルを手動で編集することもできます。
次のコマンドを実行してシェル設定ファイルを開きます。
nano ~/.zshrc 次の内容を設定ファイルに追加します。
# YOUR_DASHSCOPE_API_KEY をお使いの Model Studio API キーに置き換えます
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
nano エディターで、Ctrl+X、Y、Enter の順にキーを押して、ファイルを保存して閉じます。 2. 次のコマンドを実行して変更を適用します。
source ~/.zshrc
3. 新しいターミナルウィンドウを開き、次のコマンドを実行して、環境変数が設定されていることを確認します。
echo $DASHSCOPE_API_KEY
- 次のコマンドを実行して、環境変数の設定を
~/.bash_profileファイルに追記します。
# YOUR_DASHSCOPE_API_KEY をお使いの Model Studio API キーに置き換えます
echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.bash_profile
または、~/.bash_profile ファイルを手動で編集することもできます。
次のコマンドを実行してシェル設定ファイルを開きます。
nano ~/.bash_profile 次の内容を設定ファイルに追加します。
# YOUR_DASHSCOPE_API_KEY をお使いの Model Studio API キーに置き換えます
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
nano エディターで、Ctrl+X、Y、Enter の順にキーを押して、ファイルを保存して閉じます。 2. 次のコマンドを実行して変更を適用します。
source ~/.bash_profile
3. 新しいターミナルウィンドウを開き、次のコマンドを実行して、環境変数が設定されていることを確認します。
echo $DASHSCOPE_API_KEY
一時的
現在のセッションでのみ環境変数を使用するには、一時的な環境変数に設定します。
次のコマンドは Zsh と Bash の両方で使用できます。
- 次のコマンドを実行します。
# YOUR_DASHSCOPE_API_KEY をお使いの Model Studio API キーに置き換えます
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
-
次のコマンドを実行して、環境変数が設定されていることを確認します。
echo $DASHSCOPE_API_KEY
Windows
Windows では、システムのプロパティ、コマンドプロンプト、または Windows PowerShell を使用して環境変数を設定できます。
システムのプロパティ
- この方法で設定した環境変数は永続的です。
- システム環境変数を変更するには、管理者権限が必要です。
- 環境変数への変更は、コマンドプロンプトウィンドウや IDE を含む実行中のアプリケーションには影響しません。変更を適用するには、これらのアプリケーションを再起動するか、新しいコマンドラインセッションを開く必要があります。
-
Windows デスクトップで
Win+Qを押し、検索ボックスで[システム環境変数の編集]を検索し、検索結果をクリックして[システムのプロパティ]ウィンドウを開きます。 -
システムのプロパティ ウィンドウで 環境変数 をクリックし、次に システム環境変数 セクションで 作成 をクリックします。Variable Name に
DASHSCOPE_API_KEYを入力し、変数値 にご自身の DashScope API キーを入力します。 -
開いている 3 つすべてのウィンドウでOKをクリックして変更を保存し、ウィンドウを閉じます。
-
新しいコマンドプロンプトまたは Windows PowerShell ウィンドウを開き、適切なコマンドを実行して、環境変数が設定されていることを確認します。
-
コマンドプロンプトの場合:
echo %DASHSCOPE_API_KEY%
-
Microsoft Windows [Version 10.0.19045.5371]
(c) Microsoft Corporation. All rights reserved.
C:\Windows\system32>echo %DASHSCOPE_API_KEY%
sk-ee166797fe40xxx
C:\Windows\system32>
-
Windows PowerShell の場合:
echo $env:DASHSCOPE_API_KEY
Windows PowerShell
Copyright (C) Microsoft Corporation. All rights reserved.
Try the new cross-platform PowerShell https://aka.ms/pscore6
PS C:\Windows\system32> echo $env:DASHSCOPE_API_KEY
sk-ee166797fe40xxx
PS C:\Windows\system32>
コマンドプロンプト
永続的現在のユーザーのすべての新しいセッションで API キーの環境変数を利用できるようにするには、次の手順に従ってください。
- コマンドプロンプトで次のコマンドを実行します。
REM YOUR_DASHSCOPE_API_KEY をお使いの Model Studio API キーに置き換えます
setx DASHSCOPE_API_KEY "YOUR_DASHSCOPE_API_KEY"
-
変更を有効にするには、新しいコマンドプロンプトウィンドウを開きます。
-
新しいコマンドプロンプトウィンドウで、次のコマンドを実行して、環境変数が設定されていることを確認します。
echo %DASHSCOPE_API_KEY%
現在のセッションでのみ環境変数を使用するには、コマンドプロンプトで次のコマンドを実行します。
REM YOUR_DASHSCOPE_API_KEY をお使いの Model Studio API キーに置き換えます
set DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
同じセッションで次のコマンドを実行して、環境変数が設定されていることを確認できます。
echo %DASHSCOPE_API_KEY%
Windows PowerShell
永続的現在のユーザーのすべての新しいセッションで API キーの環境変数を利用できるようにするには、次の手順に従ってください。
- Windows PowerShell で次のコマンドを実行します。
# YOUR_DASHSCOPE_API_KEY をお使いの Model Studio API キーに置き換えます
[Environment]::SetEnvironmentVariable("DASHSCOPE_API_KEY", "YOUR_DASHSCOPE_API_KEY", [EnvironmentVariableTarget]::User)
-
変更を有効にするには、新しい Windows PowerShell ウィンドウを開きます。
-
新しい Windows PowerShell ウィンドウで、次のコマンドを実行して、環境変数が設定されていることを確認します。
echo $env:DASHSCOPE_API_KEY
一時的
現在のセッションでのみ環境変数を使用したい場合は、PowerShell で次のコマンドを実行します。
# YOUR_DASHSCOPE_API_KEY をお使いの Model Studio API キーに置き換えます
$env:DASHSCOPE_API_KEY = "YOUR_DASHSCOPE_API_KEY"
同じセッションで次のコマンドを実行して、環境変数が設定されていることを確認できます。
echo $env:DASHSCOPE_API_KEY
開発言語の選択
モデル API 群を呼び出すための言語またはツールを選択してください。
Python
ステップ 1:Python のセットアップ
Python のバージョンを確認
Python 3.9 以降が必要です。インストール手順については、「Pythonのインストール」をご参照ください。
次のコマンドを実行して、Python と pip がインストールされているかどうかを確認します。
python -V
pip --version
例えば、Windows のコマンド プロンプトでは次のようになります。
C:\Users\Administrator>python -V
Python 3.13.2
C:\Users\Administrator>pip --version
pip 24.3.1 from C:\Users\Administrator\AppData\Local\Programs\Python\Python313\Lib\site-packages\pip (python 3.13)
よくある質問
Q:python -V および pip --version コマンドを実行すると、エラーが返されます。
'python' is not recognized as an internal or external command, operable program or batch file.'pip' is not recognized as an internal or external command, operable program or batch file.-bash: python: command not found-bash: pip: command not found
次の解決策をお試しください。
Windows
-
「Pythonのインストール」に従って Python をインストールし、python.exe を PATH 環境変数に追加したことを確認してください。
Python 3.13.2 をインストールする際、インストーラーの下部にある [Add python.exe to PATH] を選択して Python をシステム環境変数に追加し、次に [Install Now] をクリックしてインストールを完了します。
-
Python と PATH が正しく設定されているにもかかわらずエラーが続く場合は、現在のターミナルを閉じて新しいターミナルを開いてください。
Linux と macOS
-
「Pythonのインストール」に従って Python をインストールしたことを確認してください。
-
Python がインストールされているにもかかわらずエラーが続く場合は、
which python pipを実行して、pythonとpipがシステムに存在するかどうかを確認してください。- 次の結果が表示された場合は、現在のターミナルウィンドウを閉じて新しいターミナルウィンドウを開き、再度お試しください。
/usr/bin/python
/usr/bin/pip
- 次の結果が返された場合は、
which python3 pip3クエリを再度実行してください。
/usr/bin/which: no python in (/root/.local/bin:/root/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin)
/usr/bin/which: no pip in (/root/.local/bin:/root/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin)
次の結果が返された場合は、python3 -V と pip3 --version を使用してバージョンを確認してください。
/usr/bin/python3
/usr/bin/pip3
仮想環境のセットアップ (オプション)
Python が既にインストールされている場合は、仮想環境を作成して OpenAI Python SDK または DashScope Python SDK をインストールし、依存関係の競合を回避できます。
-
仮想環境を作成
.venv という名前の仮想環境を作成してください。
# これが失敗する場合は、python を python3 に置き換えてください
python -m venv .venv
-
仮想環境をアクティベート
Windows では、次のコマンドで仮想環境をアクティベートしてください。
.venv\Scripts\activate
macOS または Linux では、次のコマンドを実行してください。
source .venv/bin/activate
DashScope Python SDK または OpenAI Python SDK のインストール
DashScope Python SDK (推奨) または OpenAI Python SDK を使用して、Model Studio でモデルを呼び出すことができます。
DashScope Python SDK のインストール
DashScope Python SDK をインストールまたはアップグレードしてください。
# これが失敗する場合は、pip を pip3 に置き換えてください
pip install -U dashscope
Successfully installed ... dashscope-x.x.x が表示されれば、インストールは完了です。
OpenAI Python SDK のインストール
OpenAI Python SDK をインストールまたはアップグレードしてください。
# これが失敗する場合は、pip を pip3 に置き換えてください
pip install -U openai
Successfully installed ... openai-x.x.x が表示されれば、インストールは完了です。
ステップ 2:API の呼び出し
DashScope Python SDK
Python と DashScope Python SDK をインストールしたら、最初の API リクエストを送信してみましょう。
hello_qwen.pyという名前のファイルを作成してください。- 次のコードを
hello_qwen.pyにコピーして保存してください。
import os
from dashscope import MultiModalConversation
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': [{'text': 'You are a helpful assistant.'}]},
{'role': 'user', 'content': [{'text': 'Who are you?'}]}
]
response = MultiModalConversation.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="qwen3.8-max",
messages=messages
)
if response.status_code == 200:
print(response.output.choices[0].message.content[0]["text"])
else:
print(f"HTTP status code: {response.status_code}")
print(f"Error code: {response.code}")
print(f"Error message: {response.message}")
print("See: 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 from Alibaba Cloud. My name is Qwen.
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="qwen3.8-max",
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"Error message: {e}")
print("See: https://www.alibabacloud.com/help/model-studio/developer-reference/error-code")
US (Virginia) リージョンの場合、エンドポイントドメインは {WorkspaceId}.us-east-1.maas.aliyuncs.com となり、ベース URL にはワークスペース ID (WorkspaceId) プレフィックスが含まれません。これは China (Beijing)、Singapore、およびその他のリージョンとは異なる形式です。
import os
from openai import OpenAI
try:
client = OpenAI(
# 環境変数が設定されていない場合は、api_key = "sk-xxx" に置き換えてください
api_key=os.getenv("DASHSCOPE_API_KEY"),
# 以下のベース URL は US (Virginia) リージョン用です。このリージョンではワークスペース固有のドメインを使用しないため、WorkspaceId を含めないでください。
base_url="https://us-east-1.maas.aliyuncs.com/compatible-mode/v1",
)
completion = client.chat.completions.create(
model="qwen3.8-max",
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"Error message: {e}")
print("See: 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.
Node.js
ステップ 1: Node.js 環境のセットアップ
Node.js のインストールの確認
Node.js と npm がインストールされているか確認します:
node -v
npm -v
例: Windows のコマンドプロンプトの場合:
C:\Users\Administrator>node -v
v22.14.0
C:\Users\Administrator>npm -v
10.9.2
これにより、現在の Node.js バージョンが出力されます。Node.js がインストールされていない場合は、Node.js の公式サイトからダウンロードしてください。
モデル呼び出し SDK のインストール
ターミナルで次のコマンドを実行します:
npm install --save openai
# または
yarn add openai
注記インストールに失敗した場合は、レジストリミラーを設定してください:
npm config set registry https://registry.npmmirror.com/
ミラーを設定した後、SDK のインストールコマンドを再実行してください。
added xx package in xxs が表示されることを確認して、インストールを確認します。バージョンを確認するには npm list openai を実行します。
ステップ 2: モデル API の呼び出し
hello_qwen.mjsという名前のファイルを作成します。- このコードをファイルにコピーします。
import OpenAI from "openai";
try {
const openai = new OpenAI(
{
// 環境変数が設定されていない場合は、apiKey: "sk-xxx" に置き換えます
apiKey: process.env.DASHSCOPE_API_KEY,
// 次の URL はシンガポールリージョン用です。 呼び出し時に、{WorkspaceId} を実際のワークスペース ID に置き換えてください。 URL はリージョンによって異なります。
baseURL: "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1"
}
);
const completion = await openai.chat.completions.create({
model: "qwen3.8-max",
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 message: ${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 language model from Alibaba Cloud. My name is Qwen.
Java
ステップ 1:Java 環境のセットアップ
Java バージョンの確認
ターミナルで次のコマンドを実行します:
java -version
# (任意) Maven を使用して Java プロジェクトを管理およびビルドする場合は、Maven がインストールされていることを確認してください
mvn --version
例:Windows コマンド プロンプトの場合:
C:\Users\Administrator>java --version
java 23.0.2 2025-01-21
Java(TM) SE Runtime Environment (build 23.0.2+7-58)
Java HotSpot(TM) 64-Bit Server VM (build 23.0.2+7-58, mixed mode, sharing)
C:\Users\Administrator>mvn --version
Apache Maven 3.9.9 (8e8579a9e76f7d015ee5ec7bfcdc97d260186937)
Maven home: C:\Program Files\apache-maven-3.9.9
Java version: 23.0.2
DashScope Java SDK には Java 8 以降が必要です。例えば、openjdk version "16.0.1" 2021-04-20 は Java 16 を意味します。Java がインストールされていない場合、またはバージョンが Java 8 未満の場合は、Java downloads からダウンロードしてインストールしてください。
モデル呼び出し SDK のインストール
DashScope Java SDK をインストールします。最新バージョンについては、「DashScope Java SDK」をご参照ください。この依存関係を追加し、the-latest-version を最新のバージョン番号に置き換えてください。
XML
- Maven プロジェクトの
pom.xmlファイルを開きます。 - この依存関係を
<dependencies>タグに追加します:
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>dashscope-sdk-java</artifactId>
<!-- 'the-latest-version' を最新のバージョン番号に置き換えてください:https://mvnrepository.com/artifact/com.alibaba/dashscope-sdk-java -->
<version>the-latest-version</version>
</dependency>
pom.xmlファイルを保存します。mvn compileやmvn clean installなどの Maven コマンドを実行して、依存関係を更新します。Maven は自動的に DashScope Java SDK をダウンロードし、プロジェクトに追加します。
例:Windows 上の IntelliJ IDEA の場合:
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<url>http://maven.apache.org</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>dashscope-sdk-java</artifactId>
<!-- 'the-latest-version' を最新のバージョン番号に置き換えてください:https://mvnrepository.com/artifact/com.alibaba/dashscope-sdk-java -->
<version>2.18.2</version>
</dependency>
</dependencies>
</project>
~\Desktop\test_project
mvn compile
[INFO] Scanning for projects...
[INFO]
[INFO] ----------------------< org.example:test_project >----------------------
[INFO] Building test_project 1.0-SNAPSHOT
[INFO] from pom.xml
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- resources:3.3.1:resources (default-resources) @ test_project ---
[INFO] skip non existing resourceDirectory C:\Users\Administrator\Desktop\test_project\src\main\resources
[INFO]
[INFO] --- compiler:3.13.0:compile (default-compile) @ test_project ---
[INFO] Nothing to compile - all classes are up to date.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 0.627 s
[INFO] Finished at: 2025-02-17T13:15:30+08:00
[INFO] ------------------------------------------------------------------------
Gradle
- Gradle プロジェクトの
build.gradleファイルを開きます。 - この依存関係を
dependenciesブロックに追加します:
dependencies {
// 'the-latest-version' を最新のバージョン番号に置き換えてください:https://mvnrepository.com/artifact/com.alibaba/dashscope-sdk-java
implementation group: 'com.alibaba', name: 'dashscope-sdk-java', version: 'the-latest-version'
}
build.gradleファイルを保存します。- ターミナルで、プロジェクトルートディレクトリに移動し、この Gradle コマンドを実行して依存関係を更新します。これにより、DashScope Java SDK が自動的にダウンロードされ、プロジェクトに追加されます。
./gradlew build --refresh-dependencies
例:Windows 上の IntelliJ IDEA の場合:
完全な build.gradle ファイルの例:
group = 'org.example'
version = '1.0-SNAPSHOT'
repositories {
mavenCentral()
}
dependencies {
implementation 'org.apache.groovy:groovy:4.0.14'
testImplementation platform('org.junit:junit-bom:5.10.0')
testImplementation 'org.junit.jupiter:junit-jupiter'
implementation group: 'com.alibaba', name: 'dashscope-sdk-java', version: '2.18.2'
}
test {
useJUnitPlatform()
}
ビルドコマンドを実行すると、ターミナル出力は次のようになります:
~/Desktop/test_project
./gradlew build --refresh-dependencies
Welcome to Gradle 8.10!
Here are the highlights of this release:
- Support for Java 23
- Faster configuration cache
- Better configuration cache reports
For more details see https://docs.gradle.org/8.10/release-notes.html
BUILD SUCCESSFUL in 7m 51s
2 actionable tasks: 2 executed
ステップ 2:API の呼び出し
このコードを実行して、モデル API を呼び出します。
import java.util.Arrays;
import java.util.Collections;
import java.lang.System;
import com.alibaba.dashscope.aigc.multimodalconversation.MultiModalConversation;
import com.alibaba.dashscope.aigc.multimodalconversation.MultiModalConversationParam;
import com.alibaba.dashscope.aigc.multimodalconversation.MultiModalConversationResult;
import com.alibaba.dashscope.common.MultiModalMessage;
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 MultiModalConversationResult callWithMessage() throws ApiException, NoApiKeyException, InputRequiredException {
// 次の URL はシンガポールリージョン用です。呼び出し時に、{WorkspaceId} をお使いのワークスペース ID に置き換えてください。URL はリージョンによって異なります。
MultiModalConversation conv = new MultiModalConversation(Protocol.HTTP.getValue(), "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1");
MultiModalMessage systemMsg = MultiModalMessage.builder()
.role(Role.SYSTEM.getValue())
.content(Arrays.asList(Collections.singletonMap("text", "You are a helpful assistant.")))
.build();
MultiModalMessage userMsg = MultiModalMessage.builder()
.role(Role.USER.getValue())
.content(Arrays.asList(Collections.singletonMap("text", "Who are you?")))
.build();
MultiModalConversationParam param = MultiModalConversationParam.builder()
// シンガポール、米国 (バージニア)、および中国 (北京) の 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-max")
.messages(Arrays.asList(systemMsg, userMsg))
.build();
return conv.call(param);
}
public static void main(String[] args) {
try {
MultiModalConversationResult result = callWithMessage();
System.out.println(result.getOutput().getChoices().get(0).getMessage().getContent().get(0).get("text"));
} catch (ApiException | NoApiKeyException | InputRequiredException e) {
System.err.println("Error message: "+e.getMessage());
System.out.println("For details, see: 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 は Singapore リージョンのものです。{WorkspaceId} を実際のワークスペース ID に置き換えてください。URL はリージョンによって異なります。China (Beijing) リージョンを使用する場合は、URL を https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/chat/completions に置き換えてください。
API リクエストを送信します:
Windows
コマンド プロンプトで次のコマンドを実行します:
curl -X POST "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/chat/completions" ^
-H "Authorization: Bearer %DASHSCOPE_API_KEY%" ^
-H "Content-Type: application/json" ^
-d "{
\"model\": \"qwen3.8-max\",
\"messages\": [
{
\"role\": \"system\",
\"content\": \"You are a helpful assistant.\"
},
{
\"role\": \"user\",
\"content\": \"Who are you?\"
}
]
}"
Linux および macOS
ターミナルで次のコマンドを実行します:
curl -X POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/chat/completions \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "qwen3.8-max",
"messages": [
{
"role": "system",
"content": "You are a helpful assistant."
},
{
"role": "user",
"content": "Who are you?"
}
]
}'
API リクエストを送信すると、次のレスポンスが返されます:
{
"choices": [
{
"message": {
"role": "assistant",
"content": "I am a large-scale language model from 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": "qwen3.8-max",
"id": "chatcmpl-39799876-eda8-9527-9e14-2214d641cf9a"
}
DashScope HTTP
この例の URL は Singapore リージョンのものです。{WorkspaceId} を実際のワークスペース ID に置き換えてください。URL はリージョンによって異なります。
- US (Virginia) リージョンを使用する場合は、URL を
https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generationに置き換えてください。 - China (Beijing) リージョンを使用する場合は、URL を
https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generationに置き換えてください。{WorkspaceId} をお使いのワークスペース ID に置き換えてください。
API リクエストを送信します:
Windows
コマンド プロンプトで次のコマンドを実行します:
curl -X POST "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation" ^
-H "Authorization: Bearer %DASHSCOPE_API_KEY%" ^
-H "Content-Type: application/json" ^
-d "{
\"model\": \"qwen3.8-max\",
\"input\": {
\"messages\": [
{
\"role\": \"system\",
\"content\": [{\"text\": \"You are a helpful assistant.\"}]
},
{
\"role\": \"user\",
\"content\": [{\"text\": \"Who are you?\"}]
}
]
},
\"parameters\": {
\"result_format\": \"message\"
}
}"
Linux および macOS
ターミナルで次のコマンドを実行します:
curl -X POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "qwen3.8-max",
"input":{
"messages":[
{
"role": "system",
"content": [{"text": "You are a helpful assistant."}]
},
{
"role": "user",
"content": [{"text": "Who are you?"}]
}
]
},
"parameters": {
"result_format":"message"
}
}'
API リクエストを送信すると、次のレスポンスが返されます:
{
"output": {
"choices": [
{
"finish_reason": "stop",
"message": {
"role": "assistant",
"content": [{"text": "I am a large-scale language model from 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-1.8-long",
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-1.8-long",
"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 Key not set. Make sure the 'DASHSCOPE_API_KEY' environment variable is set.");
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-1.8-long"",
""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 $"Request failed: {response.StatusCode}";
}
}
}
}
API リファレンス
- 入力、出力パラメーターについては、Qwen API リファレンスをご参照ください。
- その他のモデルについては、モデルリストをご参照ください。
よくある質問
モデル API 呼び出し後のModel.AccessDeniedエラーの修正方法
A: このエラーは、サブワークスペースの API キーを使用していることが原因で発生します。サブワークスペースは、デフォルトワークスペース内のアプリケーションやモデルにアクセスできません。サブワークスペースの API キーを使用するには、ルートアカウントの管理者が対応するサブワークスペースにモデルの権限を付与する必要があります (例えば、このトピックでは qwen3.8-max モデルを使用します)。詳細な手順については、「モデルの呼び出し権限の設定」をご参照ください。
次のステップ
さまざまなモデルの探索 | サンプルコードでは |
高度な機能の学習 | サンプルコードは基本的な Q&A のみをカバーしています。ストリーミング出力、構造化出力、関数呼び出しなど、Qwen API の詳細については、「テキスト生成モデルの概要」をご参照ください。 |
ブラウザでのモデル試用 | Qwen Chat のように、ダイアログボックスを通じてモデルと対話したい場合は、プレイグラウンドにアクセスしてください。 |
カスタムトレーニングされたモデルの呼び出し | Model Studio でカスタムトレーニングされたモデルをデプロイしている場合は、API 呼び出しを行う際に、モデルデプロイページのモデルコード (モデル ID ではなく) を |