Gunakan API Responses yang kompatibel dengan OpenAI untuk memanggil model Qwen. Topik ini menjelaskan parameter input dan output serta menyediakan contoh pemanggilan.
Keunggulan dibandingkan OpenAI Chat Completions API:
Alat bawaan: Hasilkan performa lebih baik pada tugas kompleks dengan alat bawaan seperti pencarian web, scraping web, interpreter kode, teks-ke-gambar, gambar-ke-gambar, dan pencarian basis pengetahuan. Untuk informasi selengkapnya, lihat pemanggilan alat.
Input lebih fleksibel: Mendukung input berupa string langsung maupun array pesan dalam format chat.
Manajemen konteks yang disederhanakan: Hindari konstruksi manual array riwayat pesan dengan meneruskan
previous_response_iddari respons terakhir.Cache konteks yang praktis: Tambahkan
x-dashscope-session-cache: enableke header permintaan untuk mengaktifkan cache konteks percakapan secara otomatis di sisi server. Fitur ini mengurangi latensi inferensi dan biaya untuk percakapan multi-putaran tanpa perubahan kode. Untuk detailnya, lihat cache sesi.
Kompatibilitas dan keterbatasan
API ini kompatibel dengan OpenAI untuk mengurangi biaya migrasi pengembang, tetapi berbeda dalam parameter, fungsionalitas, dan perilakunya.
Prinsip Inti: Hanya parameter yang secara eksplisit tercantum dalam dokumen ini yang diproses. Parameter OpenAI yang tidak disebutkan akan diabaikan.
Perbedaan utama berikut akan membantu Anda beradaptasi dengan cepat:
Parameter yang Tidak Didukung: API ini tidak mendukung beberapa parameter API OpenAI, seperti parameter eksekusi asinkron
background. API saat ini hanya mendukung panggilan sinkron.Kontrol Upaya Reasoning: Gunakan parameter
reasoning.effortuntuk mengontrol upaya reasoning model. Untuk detail penggunaan, lihat deskripsi parameter ini.
Singapore
base_url untuk konfigurasi pemanggilan SDK adalah https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1.
Titik akhir permintaan HTTP: POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/responses
China (Beijing)
base_url untuk konfigurasi pemanggilan SDK: https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1
Titik akhir permintaan HTTP: POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/responses
AS (Virginia)
Konfigurasi pemanggilan SDK base_url: https://dashscope-us.aliyuncs.com/compatible-mode/v1
Titik akhir permintaan HTTP: POST https://dashscope-us.aliyuncs.com/compatible-mode/v1/responses
Jerman (Frankfurt)
Konfigurasi pemanggilan SDK base_url: https://{<u>WorkspaceId</u>}<u>.eu-central-1.maas.aliyuncs</u>.com/compatible-mode/v1/responses
Titik akhir permintaan HTTP: POST https://{WorkspaceId}.eu-central-1.maas.aliyuncs.com/compatible-mode/v1/responses
Tiongkok (Hong Kong)
Konfigurasi pemanggilan SDK base_url: https://{WorkspaceId}.cn-hongkong.maas.aliyuncs.com/compatible-mode/v1
Titik akhir permintaan HTTP: POST https://{WorkspaceId}.cn-hongkong.maas.aliyuncs.com/compatible-mode/v1/responses
Jepang (Tokyo)
Konfigurasi pemanggilan SDK base_url: https://{WorkspaceId}.ap-northeast-1.maas.aliyuncs.com/compatible-mode/v1
Titik akhir permintaan HTTP: POST https://{WorkspaceId}.ap-northeast-1.maas.aliyuncs.com/compatible-mode/v1/responses
Ganti {WorkspaceId} dengan ID ruang kerja Anda yang sebenarnya.
Model Studio telah merilis domain khusus ruang kerja untuk wilayah Tiongkok (Beijing), Singapura, dan Tiongkok (Hong Kong). Domain khusus baru ini memberikan performa unggul dan stabilitas lebih tinggi untuk permintaan inferensi. Kami merekomendasikan migrasi ke domain baru:
-
Tiongkok (Beijing): dari
https://dashscope.aliyuncs.comkehttps://{WorkspaceId}.cn-beijing.maas.aliyuncs.com -
Singapura: dari
https://dashscope-intl.aliyuncs.comkehttps://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com -
Tiongkok (Hong Kong): dari
https://cn-hongkong.dashscope.aliyuncs.comkehttps://{WorkspaceId}.cn-hongkong.maas.aliyuncs.com
{WorkspaceId} adalah ID ruang kerja Anda, yang dapat ditemukan di halaman Detail Ruang Kerja di Konsol Model Studio. Domain lama tetap berfungsi penuh.
Jalur URL lama /api/v2/apps/protocols/compatible-mode/v1/responses untuk API Responses yang kompatibel dengan OpenAI akan segera ditinggalkan. Harap migrasi ke jalur baru /compatible-mode/v1/responses sesegera mungkin.
Badan permintaan | Panggilan dasarPythonNode.jscurlKeluaran streamingPythonNode.jscurlPercakapan multi-putaranPythonNode.jsAlat bawaanPythonNode.jscurlPemanggilan fungsiPythonNode.jsPemahaman dokumenPythonNode.jscurlCache sesiPythonNode.jscurl |
model ID model yang akan digunakan. | |
input Input untuk model. Format berikut didukung:
| |
instructions Disisipkan di awal konteks sebagai instruksi sistem. Ketika | |
previous_response_id ID unik dari respons sebelumnya. | |
conversation Percakapan tempat respons saat ini termasuk (lihat Conversations API). Riwayat percakapan secara otomatis disertakan sebagai konteks. Input dan output permintaan ini ditambahkan ke percakapan setelah selesai. Tidak dapat digunakan bersamaan dengan | |
stream Mengaktifkan keluaran streaming. Jika diatur ke | |
store Menentukan apakah respons model yang dihasilkan untuk sesi ini disimpan.
| |
tools Array alat yang dapat dipanggil model saat menghasilkan respons. Mendukung alat bawaan dan alat Untuk hasil terbaik, aktifkan alat | |
tool_choice Mengontrol cara model memilih dan memanggil alat. Parameter ini mendukung dua format: mode string dan mode objek. String Mode
Mode objek Membatasi model pada set alat tertentu untuk dipilih dan dipanggil. | |
suhu Suhu sampling, yang mengontrol keragaman teks yang dihasilkan. Nilai yang lebih tinggi membuat keluaran lebih acak dan beragam, sedangkan nilai yang lebih rendah membuatnya lebih fokus dan deterministik. Kisaran nilai: [0, 2) Baik | |
top_p Ambang batas probabilitas untuk pengambilan sampel top-p, yang mengontrol keragaman teks yang dihasilkan. Nilai yang lebih tinggi membuat keluaran lebih acak dan beragam, sedangkan nilai yang lebih rendah membuatnya lebih fokus dan deterministik. Kisaran nilai: (0, 1.0] Baik | |
enable_thinking Mengaktifkan atau menonaktifkan mode reasoning. Ketika diaktifkan, model melakukan langkah reasoning sebelum merespons. Proses reasoning dikembalikan sebagai item keluaran bertipe Nilai yang valid:
Untuk nilai default berbagai model, lihat Model yang didukung. Parameter ini bukan parameter OpenAI standar. Di SDK Python, teruskan menggunakan | |
reasoning Mengontrol upaya reasoning model. Model melakukan langkah reasoning sebelum membalas, dan proses reasoning dikembalikan melalui item keluaran bertipe
| |
ocr_options Parameter tugas bawaan OCR. Hanya berlaku untuk model Parameter ini bukan parameter OpenAI standar. Di SDK Python, teruskan menggunakan |
Objek respons (keluaran non-streaming) | |
id Identifikasi unik untuk respons ini, berupa UUID. ID ini berlaku selama 7 hari dan dapat digunakan dalam parameter | |
created_at Timestamp Unix (dalam detik) untuk permintaan ini. | |
object Jenis objek, yang selalu | |
status Status generasi respons. Nilai yang valid:
| |
model ID model yang digunakan untuk menghasilkan respons. | |
output Array item keluaran yang dihasilkan model. Jenis dan urutan elemen dalam array bergantung pada respons model. | |
usage Informasi tentang konsumsi token untuk permintaan ini. | |
error Objek error dikembalikan ketika model gagal menghasilkan respons. Jika tidak, nilainya | |
tools Menggemakan konten lengkap parameter | |
tool_choice Menggemakan nilai parameter |
Objek potongan respons (keluaran streaming) | Panggilan dasarEkstraksi webPencarian teks-ke-gambarPencarian gambar-ke-gambarMCPPencarian basis pengetahuan |
Keluaran streaming mengembalikan serangkaian objek JSON. Setiap objek mencakup bidang | |
type Pengidentifikasi jenis peristiwa. Nilai yang mungkin meliputi:
| |
sequence_number Nomor urutan peristiwa, dimulai dari 0 dan bertambah dengan setiap peristiwa. Gunakan nomor ini untuk memproses peristiwa dalam urutan yang benar. | |
response Objek respons. Muncul dalam peristiwa | |
item Objek item keluaran. Muncul dalam peristiwa | |
part Objek bagian konten. Muncul dalam peristiwa | |
delta Segmen teks inkremental. Bidang ini muncul dalam peristiwa | |
text Konten teks lengkap. Bidang ini muncul dalam peristiwa | |
item_id Identifikasi unik untuk item keluaran. Gunakan ID ini untuk mengkorelasikan peristiwa yang termasuk dalam item yang sama. | |
output_index Indeks item keluaran dalam array | |
content_index Indeks bagian konten dalam array | |
summary_index Indeks item dalam array |
FAQ
T: Bagaimana cara meneruskan konteks untuk percakapan multi-putaran?
J: Saat membuat permintaan percakapan baru, teruskan id dari respons sukses sebelumnya model sebagai parameter previous_response_id.
T: Mengapa beberapa bidang dalam contoh respons tidak dijelaskan dalam topik ini?
J: SDK OpenAI resmi mungkin mengeluarkan bidang tambahan yang didefinisikan oleh protokol OpenAI. Layanan kami tidak mendukung bidang-bidang tersebut, sehingga biasanya bernilai null. Fokuslah hanya pada bidang yang dijelaskan dalam topik ini.