Alibaba Cloud Model Studio mendukung panggilan API ke model melalui antarmuka yang kompatibel dengan OpenAI dan SDK DashScope.
Untuk memanggil API Qwen:
- Dapatkan kunci API
- Siapkan lingkungan pengembangan lokal Anda
- Panggil API Qwen
Persiapan akun
-
Buat akun: Jika Anda belum memiliki Akun Alibaba Cloud, buat satu.
Jika mengalami kendala, lihat Daftar Akun Alibaba Cloud.
-
Aktifkan Model Studio: Gunakan Akun Alibaba Cloud Anda untuk membuka Alibaba Cloud Model Studio. Baca dan terima Ketentuan Layanan untuk mengaktifkan layanan. Jika jendela Ketentuan Layanan tidak muncul, berarti layanan telah diaktifkan.
-
Dapatkan kunci API: Buka halaman API Key dan klik Create API key. Lalu gunakan kunci API tersebut untuk memanggil model.
Anda tidak perlu memilih model saat membuat kunci API. Tentukan model yang akan dipanggil melalui parameter
modeldalam badan permintaan, misalnyamodel="qwen-plus". Untuk daftar model yang didukung, lihat Daftar model. Untuk membatasi model yang dapat dipanggil oleh kunci API, pilih izin Custom saat membuat kunci dan aktifkan sakelar Model access scope. Kunci tersebut kemudian hanya dapat memanggil model yang telah Anda pilih. -
Dapatkan ID ruang kerja Anda: Saat memanggil model di wilayah Tiongkok (Beijing), Singapura, Jepang (Tokyo), Jerman (Frankfurt), atau Tiongkok (Hong Kong), Anda perlu menyertakan ID ruang kerja (WorkspaceId) dalam URL dasar. Anda dapat menemukannya di halaman Workspace Management. Untuk model di wilayah AS (Virginia), domain spesifik ruang kerja tidak didukung. Jangan sertakan ID ruang kerja (WorkspaceId) dalam URL dasar — gunakan langsung
{WorkspaceId}.us-east-1.maas.aliyuncs.comsebagai domain titik akhir.
Atur kunci API Anda sebagai variabel lingkungan
Simpan kunci API Anda dalam variabel lingkungan untuk menghindari hardcoding kredensial dan mengurangi risiko keamanan.
Langkah-langkah
Linux
Permanen
Agar kunci API tersedia di semua sesi baru untuk pengguna saat ini, atur sebagai variabel lingkungan permanen.
- Jalankan perintah berikut untuk menambahkan pengaturan variabel lingkungan ke file
~/.bashrc.
# Ganti YOUR_DASHSCOPE_API_KEY dengan Kunci API Model Studio Anda
echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.bashrc
Atau, Anda dapat mengedit file ~/.bashrc secara manual.
Jalankan perintah berikut untuk membuka file ~/.bashrc.
nano ~/.bashrc Tambahkan konten berikut ke file konfigurasi.
# Ganti YOUR_DASHSCOPE_API_KEY dengan Kunci API Model Studio Anda
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
Di editor nano, tekan Ctrl+X, lalu Y, dan Enter untuk menyimpan serta menutup file. 2. Jalankan perintah berikut untuk menerapkan perubahan.
source ~/.bashrc
3. Buka jendela terminal baru dan jalankan perintah berikut untuk memverifikasi bahwa variabel lingkungan telah diatur.
echo $DASHSCOPE_API_KEY
Sementara
Untuk menggunakan variabel lingkungan hanya pada sesi saat ini, atur sebagai variabel lingkungan sementara.
- Jalankan perintah berikut.
# Ganti YOUR_DASHSCOPE_API_KEY dengan Kunci API Model Studio Anda
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
-
Jalankan perintah berikut untuk memverifikasi bahwa variabel lingkungan telah diatur.
echo $DASHSCOPE_API_KEY
macOS
Permanen
Agar kunci API tersedia di semua sesi baru untuk pengguna saat ini, atur sebagai variabel lingkungan permanen.
-
Jalankan perintah berikut di terminal Anda untuk memeriksa jenis shell default Anda.
echo $SHELL -
Lanjutkan berdasarkan jenis shell default Anda.
Zsh- Jalankan perintah berikut untuk menambahkan pengaturan variabel lingkungan ke file
~/.zshrc.
- Jalankan perintah berikut untuk menambahkan pengaturan variabel lingkungan ke file
# Ganti YOUR_DASHSCOPE_API_KEY dengan Kunci API Model Studio Anda
echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.zshrc
Atau, Anda dapat mengedit file ~/.zshrc secara manual.
Jalankan perintah berikut untuk membuka file konfigurasi shell.
nano ~/.zshrc Tambahkan konten berikut ke file konfigurasi.
# Ganti YOUR_DASHSCOPE_API_KEY dengan Kunci API Model Studio Anda
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
Di editor nano, tekan Ctrl+X, lalu Y, dan Enter untuk menyimpan serta menutup file. 2. Jalankan perintah berikut untuk menerapkan perubahan.
source ~/.zshrc
3. Buka jendela terminal baru dan jalankan perintah berikut untuk memverifikasi bahwa variabel lingkungan telah diatur.
echo $DASHSCOPE_API_KEY
- Jalankan perintah berikut untuk menambahkan pengaturan variabel lingkungan ke file
~/.bash_profile.
# Ganti YOUR_DASHSCOPE_API_KEY dengan Kunci API Model Studio Anda
echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.bash_profile
Atau, Anda dapat mengedit file ~/.bash_profile secara manual.
Jalankan perintah berikut untuk membuka file konfigurasi shell.
nano ~/.bash_profile Tambahkan konten berikut ke file konfigurasi.
# Ganti YOUR_DASHSCOPE_API_KEY dengan Kunci API Model Studio Anda
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
Di editor nano, tekan Ctrl+X, lalu Y, dan Enter untuk menyimpan serta menutup file. 2. Jalankan perintah berikut untuk menerapkan perubahan.
source ~/.bash_profile
3. Buka jendela terminal baru dan jalankan perintah berikut untuk memverifikasi bahwa variabel lingkungan telah diatur.
echo $DASHSCOPE_API_KEY
Sementara
Untuk menggunakan variabel lingkungan hanya pada sesi saat ini, atur sebagai variabel lingkungan sementara.
Perintah berikut berlaku untuk Zsh maupun Bash.
- Jalankan perintah berikut.
# Ganti YOUR_DASHSCOPE_API_KEY dengan Kunci API Model Studio Anda
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
-
Jalankan perintah berikut untuk memverifikasi bahwa variabel lingkungan telah diatur.
echo $DASHSCOPE_API_KEY
Windows
Di Windows, Anda dapat mengonfigurasi variabel lingkungan menggunakan System Properties, Command Prompt, atau Windows PowerShell.
System Properties
- Variabel lingkungan yang dikonfigurasi dengan cara ini bersifat permanen.
- Anda memerlukan izin administrator untuk mengubah variabel lingkungan sistem.
- Perubahan pada variabel lingkungan tidak memengaruhi aplikasi yang sedang berjalan, termasuk jendela Command Prompt dan IDE. Anda harus me-restart aplikasi tersebut atau membuka sesi command-line baru agar perubahan diterapkan.
-
Di desktop Windows, tekan
Win+Q, cari Edit the system environment variables di kotak pencarian, lalu klik hasil pencarian untuk membuka jendela System Properties. -
Di jendela System Properties, klik Environment Variable, lalu di bagian System variables, klik Create. Untuk Variable Name, masukkan
DASHSCOPE_API_KEY, dan untuk Variable value, masukkan Kunci API DashScope Anda. -
Klik OK pada ketiga jendela yang terbuka untuk menyimpan perubahan dan menutupnya.
-
Buka jendela Command Prompt atau Windows PowerShell baru dan jalankan perintah yang sesuai untuk memverifikasi bahwa variabel lingkungan telah diatur.
-
Di Command Prompt:
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>
-
Di 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>
Command Prompt
PermanenAgar variabel lingkungan kunci API tersedia di semua sesi baru untuk pengguna saat ini, ikuti langkah-langkah berikut.
- Jalankan perintah berikut di Command Prompt.
REM Ganti YOUR_DASHSCOPE_API_KEY dengan Kunci API Model Studio Anda
setx DASHSCOPE_API_KEY "YOUR_DASHSCOPE_API_KEY"
-
Buka jendela Command Prompt baru agar perubahan berlaku.
-
Di jendela Command Prompt baru, jalankan perintah berikut untuk memverifikasi bahwa variabel lingkungan telah diatur.
echo %DASHSCOPE_API_KEY%
Untuk menggunakan variabel lingkungan hanya pada sesi saat ini, jalankan perintah berikut di Command Prompt.
REM Ganti YOUR_DASHSCOPE_API_KEY dengan Kunci API Model Studio Anda
set DASHSCOPE_API_KEY=YOUR_DASHSCOPE_API_KEY
Anda dapat menjalankan perintah berikut pada sesi yang sama untuk memverifikasi bahwa variabel lingkungan telah diatur.
echo %DASHSCOPE_API_KEY%
Windows PowerShell
PermanenAgar variabel lingkungan kunci API tersedia di semua sesi baru untuk pengguna saat ini, ikuti langkah-langkah berikut.
- Jalankan perintah berikut di Windows PowerShell.
# Ganti YOUR_DASHSCOPE_API_KEY dengan Kunci API Model Studio Anda
[Environment]::SetEnvironmentVariable("DASHSCOPE_API_KEY", "YOUR_DASHSCOPE_API_KEY", [EnvironmentVariableTarget]::User)
-
Buka jendela Windows PowerShell baru agar perubahan berlaku.
-
Di jendela Windows PowerShell baru, jalankan perintah berikut untuk memverifikasi bahwa variabel lingkungan telah diatur.
echo $env:DASHSCOPE_API_KEY
Sementara
Jika Anda ingin menggunakan variabel lingkungan hanya pada sesi saat ini, Anda dapat menjalankan perintah berikut di PowerShell.
# Ganti YOUR_DASHSCOPE_API_KEY dengan Kunci API Model Studio Anda
$env:DASHSCOPE_API_KEY = "YOUR_DASHSCOPE_API_KEY"
Anda dapat menjalankan perintah berikut pada sesi yang sama untuk memverifikasi bahwa variabel lingkungan telah diatur.
echo $env:DASHSCOPE_API_KEY
Pilih bahasa pengembangan
Pilih bahasa atau tool untuk memanggil API model.
Python
Langkah 1: Siapkan Python
Periksa versi Python Anda
Diperlukan Python 3.9 atau lebih baru. Untuk instruksi instalasi, lihat Instal Python.
Jalankan perintah ini untuk memeriksa apakah Python dan pip telah terinstal:
python -V
pip --version
Contohnya, di Command Prompt 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)
FAQ
T: Perintah python -V dan pip --version menghasilkan error:
'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
Coba solusi berikut:
Windows
-
Pastikan Anda telah menginstal Python sesuai petunjuk di Instal Python, dan menambahkan python.exe ke variabel lingkungan PATH.
Saat menginstal Python 3.13.2, pilih Add python.exe to PATH di bagian bawah installer untuk menambahkan Python ke variabel lingkungan sistem, lalu klik Install Now untuk menyelesaikan instalasi.
-
Jika Python dan PATH telah dikonfigurasi dengan benar tetapi error masih muncul, tutup terminal saat ini dan buka yang baru.
Linux dan macOS
-
Pastikan Anda telah menginstal Python sesuai petunjuk di Instal Python.
-
Jika Python telah terinstal tetapi error masih muncul, jalankan
which python pipuntuk memeriksa apakahpythondanpipada di sistem Anda.- Jika hasil berikut muncul, tutup jendela terminal saat ini, buka jendela terminal baru, lalu coba lagi.
/usr/bin/python
/usr/bin/pip
- Jika hasil berikut dikembalikan, jalankan kueri
which python3 pip3lagi.
/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)
Jika hasil yang dikembalikan seperti ini, gunakan python3 -V dan pip3 --version untuk memeriksa versi.
/usr/bin/python3
/usr/bin/pip3
Siapkan lingkungan virtual (opsional)
Jika Python telah terinstal, Anda dapat membuat lingkungan virtual untuk menginstal OpenAI Python SDK atau DashScope Python SDK dan menghindari konflik dependensi.
-
Buat lingkungan virtual
Buat lingkungan virtual bernama .venv:
# Jika gagal, ganti python dengan python3
python -m venv .venv
-
Aktifkan lingkungan virtual
Di Windows, aktifkan lingkungan virtual:
.venv\Scripts\activate
Di macOS atau Linux, jalankan:
source .venv/bin/activate
Instal DashScope Python SDK atau OpenAI Python SDK
Anda dapat memanggil model di Model Studio menggunakan DashScope Python SDK (disarankan) atau OpenAI Python SDK.
Instal DashScope Python SDK
Instal atau tingkatkan DashScope Python SDK:
# Jika gagal, ganti pip dengan pip3
pip install -U dashscope
Cari Successfully installed ... dashscope-x.x.x untuk mengonfirmasi instalasi.
Instal OpenAI Python SDK
Instal atau tingkatkan OpenAI Python SDK:
# Jika gagal, ganti pip dengan pip3
pip install -U openai
Cari Successfully installed ... openai-x.x.x untuk mengonfirmasi instalasi.
Langkah 2: Panggil API
DashScope Python SDK
Dengan Python dan DashScope Python SDK yang telah terinstal, kirim permintaan API pertama Anda.
- Buat file bernama
hello_qwen.py. - Salin kode ini ke
hello_qwen.pydan simpan.
import os
from dashscope import MultiModalConversation
import dashscope
# URL berikut untuk wilayah Singapura. Saat memanggil, ganti {WorkspaceId} dengan ID ruang kerja aktual Anda. URL berbeda-beda tergantung wilayah.
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(
# Kunci API untuk wilayah Singapura, AS (Virginia), dan Tiongkok (Beijing) tidak dapat saling dipertukarkan. Dapatkan kunci API Anda: https://www.alibabacloud.com/help/model-studio/get-api-key
# Jika variabel lingkungan belum dikonfigurasi, ganti dengan: 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")
-
Jalankan
python hello_qwen.pyataupython3 hello_qwen.pydari command line.CatatanPerintah dalam contoh ini harus dijalankan dari direktori yang berisi file Python. Untuk menjalankannya dari lokasi lain, tentukan path lengkapnya.
Outputnya adalah:
I am a large-scale language model from Alibaba Cloud. My name is Qwen.
OpenAI Python SDK
Dengan Python dan OpenAI Python SDK yang telah terinstal, kirim permintaan API pertama Anda.
- Buat file bernama
hello_qwen.py. - Salin kode ini ke
hello_qwen.pydan simpan.
import os
from openai import OpenAI
try:
client = OpenAI(
# Jika variabel lingkungan belum dikonfigurasi, ganti dengan: api_key="sk-xxx"
api_key=os.getenv("DASHSCOPE_API_KEY"),
# URL berikut untuk wilayah Singapura. Saat memanggil, ganti {WorkspaceId} dengan ID ruang kerja aktual Anda. URL berbeda-beda tergantung wilayah.
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")
Untuk wilayah AS (Virginia), domain titik akhir adalah {WorkspaceId}.us-east-1.maas.aliyuncs.com dan URL dasar tidak menggunakan awalan ID ruang kerja (WorkspaceId) — formatnya berbeda dari Tiongkok (Beijing), Singapura, dan wilayah lainnya.
import os
from openai import OpenAI
try:
client = OpenAI(
# Jika variabel lingkungan belum dikonfigurasi, ganti dengan: api_key="sk-xxx"
api_key=os.getenv("DASHSCOPE_API_KEY"),
# URL dasar berikut untuk wilayah AS (Virginia), yang tidak menggunakan domain spesifik ruang kerja. Jangan sertakan WorkspaceId.
base_url="https://{WorkspaceId}.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")
-
Jalankan
python hello_qwen.pyataupython3 hello_qwen.pydari command line.Jika Anda melihat
No such file or directory, tentukan path lengkap ke file tersebut.Outputnya adalah:
I am a large-scale language model developed by Alibaba Cloud. My name is Qwen.
Node.js
Langkah 1: Siapkan lingkungan Node.js Anda
Periksa instalasi Node.js Anda
Periksa apakah Node.js dan npm telah terinstal:
node -v
npm -v
Contohnya, di Command Prompt Windows:
C:\Users\Administrator>node -v
v22.14.0
C:\Users\Administrator>npm -v
10.9.2
Ini mencetak versi Node.js Anda saat ini. Jika Node.js belum terinstal, unduh dari situs resmi Node.js.
Instal SDK pemanggilan model
Jalankan perintah ini di terminal Anda:
npm install --save openai
# Atau
yarn add openai
CatatanJika instalasi gagal, konfigurasikan mirror registri:
npm config set registry https://registry.npmmirror.com/
Setelah mengonfigurasi mirror, jalankan ulang perintah instalasi SDK.
Cari added xx package in xxs untuk mengonfirmasi instalasi. Periksa versi: npm list openai.
Langkah 2: Panggil API model
- Buat file bernama
hello_qwen.mjs. - Salin kode ini ke file tersebut.
import OpenAI from "openai";
try {
const openai = new OpenAI(
{
// Jika variabel lingkungan belum dikonfigurasi, ganti dengan: apiKey: "sk-xxx"
apiKey: process.env.DASHSCOPE_API_KEY,
// URL berikut untuk wilayah Singapura. Saat memanggil, ganti {WorkspaceId} dengan ID ruang kerja aktual Anda. URL berbeda-beda tergantung wilayah.
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("See: https://www.alibabacloud.com/help/model-studio/developer-reference/error-code");
}
- Jalankan perintah ini untuk mengirim permintaan API.
node hello_qwen.mjs
Catatan
- Jalankan perintah ini dari direktori yang berisi
hello_qwen.mjs. Untuk menjalankannya dari lokasi mana pun, tentukan path lengkap ke file tersebut. - Pastikan SDK telah diinstal di direktori yang sama dengan
hello_qwen.mjs. Jika berada di direktori berbeda, Anda akan melihatCannot find package 'openai' imported from xxx.
Setelah eksekusi berhasil, outputnya adalah:
I am a language model from Alibaba Cloud. My name is Qwen.
Java
Langkah 1: Siapkan lingkungan Java Anda
Periksa versi Java Anda
Jalankan perintah ini di terminal Anda:
java -version
# (Opsional) Jika Anda menggunakan Maven untuk mengelola dan membangun proyek Java, pastikan Maven telah terinstal
mvn --version
Contohnya, di Command Prompt 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
Diperlukan Java 8 atau lebih baru untuk DashScope Java SDK. Contohnya, openjdk version "16.0.1" 2021-04-20 berarti Java 16. Jika Java belum terinstal atau versinya di bawah Java 8, unduh dan instal dari Unduhan Java.
Instal SDK pemanggilan model
Instal DashScope Java SDK. Untuk versi terbaru, lihat DashScope Java SDK. Tambahkan dependensi ini, ganti the-latest-version dengan nomor versi terbaru.
XML
- Buka file
pom.xmlproyek Maven Anda. - Tambahkan dependensi ini ke tag
<dependencies>:
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>dashscope-sdk-java</artifactId>
<!-- Ganti 'the-latest-version' dengan nomor versi terbaru: https://mvnrepository.com/artifact/com.alibaba/dashscope-sdk-java -->
<version>the-latest-version</version>
</dependency>
- Simpan file
pom.xml. - Jalankan perintah Maven seperti
mvn compileataumvn clean installuntuk memperbarui dependensi. Maven akan secara otomatis mengunduh dan menambahkan DashScope Java SDK ke proyek Anda.
Contohnya, di IntelliJ IDEA pada Windows:
<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>
<!-- Ganti 'the-latest-version' dengan nomor versi terbaru: 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
- Buka file
build.gradleproyek Gradle Anda. - Tambahkan dependensi ini ke blok
dependencies:
dependencies {
// Ganti 'the-latest-version' dengan nomor versi terbaru: https://mvnrepository.com/artifact/com.alibaba/dashscope-sdk-java
implementation group: 'com.alibaba', name: 'dashscope-sdk-java', version: 'the-latest-version'
}
- Simpan file
build.gradle. - Di terminal Anda, navigasi ke direktori root proyek Anda dan jalankan perintah Gradle ini untuk memperbarui dependensi. Ini akan secara otomatis mengunduh dan menambahkan DashScope Java SDK ke proyek Anda.
./gradlew build --refresh-dependencies
Contohnya, di IntelliJ IDEA pada Windows:
Contoh file build.gradle lengkap:
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()
}
Setelah menjalankan perintah build, output terminal adalah:
~/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
Langkah 2: Panggil API
Jalankan kode ini untuk memanggil API model.
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 berikut untuk wilayah Singapura. Saat memanggil, ganti {WorkspaceId} dengan ID ruang kerja aktual Anda. URL berbeda-beda tergantung wilayah.
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()
// Kunci API untuk wilayah Singapura, AS (Virginia), dan Tiongkok (Beijing) tidak dapat saling dipertukarkan. Dapatkan kunci API Anda: https://www.alibabacloud.com/help/model-studio/get-api-key
// Jika variabel lingkungan belum dikonfigurasi, ganti dengan: .apiKey("sk-xxx")
.apiKey(System.getenv("DASHSCOPE_API_KEY"))
// Daftar model: https://www.alibabacloud.com/help/model-studio/getting-started/models
.model("qwen3.8-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("See: https://www.alibabacloud.com/help/model-studio/developer-reference/error-code");
}
System.exit(0);
}
}
Outputnya adalah:
I am a large-scale language model developed by Alibaba Cloud. My name is Qwen.
curl
Panggil model di Model Studio menggunakan titik akhir HTTP yang kompatibel dengan OpenAI atau DashScope. Untuk daftar model yang didukung, lihat Daftar model.
CatatanJika DASHSCOPE_API_KEY belum diatur, ganti -H "Authorization: Bearer $DASHSCOPE_API_KEY" dengan -H "Authorization: Bearer sk-xxx".
HTTP kompatibel OpenAI
URL dalam contoh ini menggunakan wilayah Singapura, ganti {WorkspaceId} dengan ID ruang kerja aktual Anda. URL berbeda-beda tergantung wilayah. Jika Anda menggunakan wilayah Tiongkok (Beijing), ganti URL dengan https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/chat/completions.
Kirim permintaan API:
Windows
Jalankan perintah ini di Command Prompt:
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 dan macOS
Jalankan perintah ini di Terminal:
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?"
}
]
}'
Setelah mengirim permintaan API, Anda menerima respons berikut:
{
"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 dalam contoh ini menggunakan wilayah Singapura, ganti {WorkspaceId} dengan ID ruang kerja aktual Anda. URL berbeda-beda tergantung wilayah.
- Jika Anda menggunakan wilayah AS (Virginia), ganti URL dengan
https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation. - Jika Anda menggunakan wilayah Tiongkok (Beijing), ganti URL dengan
https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation. Ganti {WorkspaceId} dengan ID ruang kerja Anda.
Kirim permintaan API:
Windows
Jalankan perintah ini di Command Prompt:
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 dan macOS
Jalankan perintah ini di Terminal:
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"
}
}'
Setelah mengirim permintaan API, Anda menerima respons berikut:
{
"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"
}
Bahasa lainnya
Panggil API modelpackage 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() {
// Buat klien HTTP
client := &http.Client{}
// Bangun badan permintaan
requestBody := RequestBody{
// Daftar model: https://www.alibabacloud.com/help/model-studio/getting-started/models
Model: "qwen3.8-max",
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 berikut untuk wilayah Singapura. Saat memanggil, ganti {WorkspaceId} dengan ID ruang kerja aktual Anda. URL berbeda-beda tergantung wilayah.
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)
}
// Atur header permintaan
// Kunci API untuk wilayah Singapura, AS (Virginia), dan Tiongkok (Beijing) tidak dapat saling dipertukarkan. Dapatkan kunci API Anda: https://www.alibabacloud.com/help/model-studio/get-api-key
// Jika variabel lingkungan belum dikonfigurasi, ganti dengan: apiKey := "sk-xxx"
apiKey := os.Getenv("DASHSCOPE_API_KEY")
req.Header.Set("Authorization", "Bearer "+apiKey)
req.Header.Set("Content-Type", "application/json")
// Kirim permintaan
resp, err := client.Do(req)
if err != nil {
log.Fatal(err)
}
defer resp.Body.Close()
// Baca badan respons
bodyText, err := io.ReadAll(resp.Body)
if err != nil {
log.Fatal(err)
}
// Cetak respons
fmt.Printf("%s\n", bodyText)
}
<?php
// URL berikut untuk wilayah Singapura. Saat memanggil, ganti {WorkspaceId} dengan ID ruang kerja aktual Anda. URL berbeda-beda tergantung wilayah.
$url = 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/chat/completions';
// Kunci API untuk wilayah Singapura, AS (Virginia), dan Tiongkok (Beijing) tidak dapat saling dipertukarkan. Dapatkan kunci API Anda: https://www.alibabacloud.com/help/model-studio/get-api-key
// Jika variabel lingkungan belum dikonfigurasi, ganti dengan: $apiKey = "sk-xxx"
$apiKey = getenv('DASHSCOPE_API_KEY');
// Atur header permintaan
$headers = [
'Authorization: Bearer '.$apiKey,
'Content-Type: application/json'
];
// Atur badan permintaan
$data = [
"model" => "qwen3.8-max",
"messages" => [
[
"role" => "system",
"content" => "You are a helpful assistant."
],
[
"role" => "user",
"content" => "Who are you?"
]
]
];
// Inisialisasi sesi cURL
$ch = curl_init();
// Atur opsi 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);
// Jalankan sesi cURL
$response = curl_exec($ch);
// Periksa error
if (curl_errno($ch)) {
echo 'Curl error: ' . curl_error($ch);
}
// Tutup resource cURL
curl_close($ch);
// Output respons
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)
{
// Kunci API untuk wilayah Singapura, AS (Virginia), dan Tiongkok (Beijing) tidak dapat saling dipertukarkan. Dapatkan kunci API Anda: https://www.alibabacloud.com/help/model-studio/get-api-key
// Jika variabel lingkungan belum dikonfigurasi, ganti dengan: 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 berikut untuk wilayah Singapura. Saat memanggil, ganti {WorkspaceId} dengan ID ruang kerja aktual Anda. URL berbeda-beda tergantung wilayah.
string url = "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/chat/completions";
// Daftar model: https://www.alibabacloud.com/help/model-studio/getting-started/models
string jsonContent = @"{
""model"": ""qwen3.8-max"",
""messages"": [
{
""role"": ""system"",
""content"": ""You are a helpful assistant.""
},
{
""role"": ""user"",
""content"": ""Who are you?""
}
]
}";
// Kirim permintaan dan dapatkan respons
string result = await SendPostRequestAsync(url, jsonContent, apiKey);
// Output hasilnya
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"))
{
// Atur header permintaan
httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", apiKey);
httpClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
// Kirim permintaan dan dapatkan respons
HttpResponseMessage response = await httpClient.PostAsync(url, content);
// Tangani respons
if (response.IsSuccessStatusCode)
{
return await response.Content.ReadAsStringAsync();
}
else
{
return $"Request failed: {response.StatusCode}";
}
}
}
}
Referensi API
- Untuk parameter input dan output, lihat Referensi API Qwen.
- Untuk model lainnya, lihat Daftar model.
FAQ
Bagaimana cara memperbaiki errorModel.AccessDeniedsetelah memanggil API model?
J: Error ini terjadi karena Anda menggunakan kunci API dari sub-ruang kerja. Sub-ruang kerja tidak dapat mengakses aplikasi atau model di ruang kerja default. Untuk menggunakan kunci API sub-ruang kerja, administrator akun root harus memberikan otorisasi model kepada sub-ruang kerja yang sesuai (misalnya, topik ini menggunakan model qwen3.8-max). Untuk langkah-langkah selengkapnya, lihat Konfigurasi izin pemanggilan model.
Langkah selanjutnya
Jelajahi lebih banyak model | Kode contoh menggunakan |
Pelajari fitur lanjutan | Kode contoh hanya mencakup tanya jawab dasar. Untuk mempelajari lebih lanjut tentang API Qwen, seperti keluaran streaming, output terstruktur, dan pemanggilan fungsi, lihat Ikhtisar model generasi teks. |
Coba model di browser | Jika Anda ingin berinteraksi dengan model melalui dialog box, seperti di Qwen Chat, buka Playground . |
Panggil model yang dilatih khusus | Jika Anda telah menerapkan model yang dilatih khusus di Model Studio, gunakan kode model (bukan ID model) dari halaman penerapan model sebagai parameter |