Gunakan API Responses yang kompatibel dengan OpenAI untuk memanggil model Qwen. Topik ini menjelaskan parameter input dan output serta menyediakan contoh pemanggilan.
- 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.
- Pengelolaan konteks yang disederhanakan: Hindari konstruksi manual array riwayat pesan dengan meneruskan
previous_response_iddari respons terakhir. - Peng-cache-an konteks yang praktis: Tambahkan
x-dashscope-session-cache: enable(nilai default: disable) ke header permintaan untuk mengaktifkan peng-cache-an otomatis di sisi server terhadap konteks percakapan. 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 developer, tetapi berbeda dalam parameter, fungsionalitas, dan perilakunya.
Prinsip Inti: Hanya parameter yang secara eksplisit tercantum dalam dokumen ini yang diproses. Parameter OpenAI apa pun 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
- China (Beijing)
- AS (Virginia)
- Jerman (Frankfurt)
- China (Hong Kong)
- Jepang (Tokyo)
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{WorkspaceId} dengan ID ruang kerja Anda yang sebenarnya.
Badan permintaanmodelstring (wajib)ID model yang akan digunakan.
Model yang didukung qwen4-max, qwen3.8-max, qwen3.8-flash, qwen3.7-max, qwen3.7-max-2026-05-20, qwen3.7-max-2026-06-08, qwen3.7-max-2026-05-17, qwen3.7-max-preview, qwen3.7-plus, qwen3.7-plus-2026-05-26, qwen3.6-plus, qwen3.6-plus-2026-04-02, qwen3.5-plus, qwen3.5-plus-2026-04-20, qwen3.5-plus-2026-02-15, qwen3.7-flash, qwen3.7-flash-2026-07-15, qwen3.6-flash, qwen3.6-flash-2026-04-16, qwen3.5-flash, qwen3.5-flash-2026-02-23, qwen3.8-2.4t-a95b, qwen3.8-27b, qwen3.6-35b-a3b, qwen3.5-397b-a17b, qwen3.5-122b-a10b, qwen3.5-27b, qwen3.5-35b-a3b, deepseek-v4.1-flash-1017, deepseek-v4-pro, deepseek-v4-pro-0813, deepseek-v4-flash-0731, glm-5.2, kimi-k3.1-pro, kimi-k3string atau array (wajib)Input untuk model. Format berikut didukung:
Jenis item array EasyInputMessage objekObjek dengan role untuk penulis pesan dan content untuk muatan pesan.
Properti role string (wajib)Peran penulis pesan. Nilai yang valid: user, assistant, system, developer.content string atau array (wajib)Konten pesan. Format berikut didukung:
API Responses saat ini tidak mendukung input video atau audio. Untuk meneruskan jenis data ini, gunakan API Chat Completions atau API DashScope.
Jenis item array Salah satu dari jenis berikut:input_text { type, text }Input teks.
Properti type string (wajib)Tetap sebagai input_text.text string (wajib)Konten teks yang diinput ke model.prompt_cache_breakpoint object (Opsional)Hanya didukung oleh qwen4-max. Menetapkan breakpoint cache manual, dengan prioritas di atas mode cache tingkat teratas. Lihat Cache eksplisit (Qwen4).
Properti mode string (Wajib)Hanya explicit yang didukung. Kirim secara eksplisit saat menetapkan breakpoint.{ type, image_url }Input gambar, hanya untuk peran user.
Properti type string (wajib)Tetap sebagai input_image.image_url string (wajib)URL publik gambar atau data yang dikodekan Base64. Untuk Base64, berikan URI Data lengkap, contohnya: data:image/png;base64,iVBORw0KGgoAAAANSUhEUg....prompt_cache_breakpoint object (Opsional)Hanya didukung oleh qwen4-max. Menetapkan breakpoint cache manual, dengan prioritas di atas mode cache tingkat teratas. Lihat Cache eksplisit (Qwen4).
Properti mode string (Wajib)Hanya explicit yang didukung. Kirim secara eksplisit saat menetapkan breakpoint.{ type, file_url }Input file, hanya untuk peran user. Saat ini didukung oleh qwen4-max, qwen3.8-flash, qwen3.8-max, dan qwen3.5-ocr.
Properti type string (wajib)Tetap sebagai input_file.file_url string (wajib)URL publik file PDF. Ukuran file maksimal 100 MB.Batas jumlah halaman PDF bergantung pada task di ocr_options: maksimal 50 halaman jika task disetel ke document_parsing; maksimal 10 halaman jika task tidak disetel atau disetel ke tugas lain.prompt_cache_breakpoint object (Opsional)Hanya didukung oleh qwen4-max. Menetapkan breakpoint cache manual, dengan prioritas di atas mode cache tingkat teratas. Lihat Cache eksplisit (Qwen4).
Properti mode string (Wajib)Hanya explicit yang didukung. Kirim secara eksplisit saat menetapkan breakpoint.{ type, text }Respons asisten, hanya untuk peran assistant.
Properti type string (wajib)Tetap sebagai output_text.text string (wajib)Konten teks respons asisten.string (opsional)Tetap sebagai message.objek (opsional)Pesan keluaran model. Untuk melanjutkan percakapan, Anda dapat meneruskan objek message dari array output respons sebelumnya kembali ke input. Berbeda dengan EasyInputMessage, objek ini mencakup struktur keluaran lengkap, dengan id, status, dan content terstruktur.
Properti type string (wajib)Tetap sebagai message.id string (wajib)Pengidentifikasi unik pesan keluaran, dari respons sebelumnya.role string (wajib)Tetap sebagai assistant.status string (wajib)Status pesan. Nilai yang valid: in_progress, completed, incomplete.content array (wajib)Array konten, di mana elemennya berupa objek output_text.
Properti type string (wajib)Tetap sebagai output_text.text string (wajib)Teks respons.annotations array (opsional)Informasi anotasi.object (opsional)Pemanggilan alat kustom yang dikembalikan model. Setelah menjalankan alat, tambahkan item pemanggilan dan custom_tool_call_output terkait ke input pada permintaan berikutnya.
Properti type string (wajib)Nilai tetap: custom_tool_call.id string (opsional)ID item pemanggilan dari respons sebelumnya. Kirim kembali tanpa perubahan.name string (wajib)Nama alat, misalnya emit_code.input string (wajib)Input teks bebas untuk alat kustom. Hanya ada jika type bernilai custom_tool_call.call_id string (wajib)Pengenal pemanggilan alat. Gunakan call_id yang dikembalikan model.namespace string (opsional)Namespace tempat alat berada. Dikembalikan untuk pemanggilan alat function atau custom dalam namespace. Pertahankan bidang ini saat mengirim kembali item pemanggilan.object (opsional)Hasil eksekusi alat kustom, yang dikaitkan dengan pemanggilannya melalui call_id.
Properti type string (wajib)Nilai tetap: custom_tool_call_output.call_id string (wajib)Pengenal pemanggilan alat. Gunakan call_id yang dikembalikan model.output string (wajib)Hasil eksekusi alat kustom, yang dikaitkan dengan pemanggilannya melalui call_id.objek (opsional)Instruksi terstruktur yang dihasilkan ketika model memutuskan untuk memanggil alat eksternal.
Properti type string (wajib)Tetap sebagai function_call.id string (opsional)Pengidentifikasi unik untuk pemanggilan fungsi, dari respons sebelumnya.name string (wajib)Nama fungsi alat.namespace string (opsional)Namespace tempat alat berada. Dikembalikan untuk pemanggilan alat function atau custom dalam namespace. Pertahankan bidang ini saat mengirim kembali item pemanggilan.arguments string (wajib)Argumen pemanggilan alat, dalam format string JSON.call_id string (wajib)Pengidentifikasi untuk pemanggilan alat. Ini harus cocok dengan call_id yang dikembalikan oleh model.status string (opsional)Status. Nilai yang valid: in_progress, completed, incomplete.objek (opsional)Keluaran pemanggilan alat. Dalam daftar pesan, objek ini harus segera mengikuti pesan function_call yang sesuai untuk mencegah kegagalan permintaan.
Properti type string (wajib)Tetap sebagai function_call_output.id string (opsional)Pengidentifikasi unik untuk keluaran pemanggilan fungsi.call_id string (wajib)Pengidentifikasi pemanggilan alat harus cocok dengan call_id yang dikembalikan oleh model.output string (wajib)Hasil eksekusi fungsi alat.status string (opsional)Status. Nilai yang valid: in_progress, completed, incomplete.objek (opsional)Proses reasoning model. Anda dapat meneruskan item reasoning dari output respons sebelumnya kembali ke input untuk melanjutkan proses ini di giliran berikutnya.
Properti type string (wajib)Tetap sebagai reasoning.id string (wajib)Pengidentifikasi unik untuk konten reasoning, dari respons sebelumnya.encrypted_content stringqwen4-max, reasoning.summary="auto": Item reasoning Responses berisi summary (elemen summary_text) dan encrypted_content. Ringkasan dikirim bertahap; teks terenkripsi dikirim pada peristiwa penyelesaian item reasoning dan response akhir. Gunakan snapshot selesai untuk melengkapi enkripsi tanpa menambahkan ringkasan dua kali. Ringkasan dan enkripsi penalaran.summary array (wajib)Konten ringkasan reasoning.
Properti type string (wajib)Tetap sebagai summary_text.text string (wajib)Teks ringkasan.string (opsional)Status. Nilai yang valid: in_progress, completed, incomplete.objek (opsional)Objek pemanggilan pencarian web. Anda dapat meneruskan kembali item web_search_call dari output respons sebelumnya ke input, memberikan konteks hasil pencarian dalam percakapan multi-putaran.
Properti type string (wajib)Selalu web_search_call.id string (wajib)Pengidentifikasi unik pemanggilan pencarian, dari respons sebelumnya.status string (wajib)Status pencarian. Nilai yang valid: in_progress, searching, completed, failed.action objek (wajib)Rincian tindakan pencarian. Hanya jenis search yang didukung.
Properti type string (wajib)Jenis pencarian. Selalu search.queries array (opsional)Daftar kueri pencarian. Setiap elemen berupa string.sources array (opsional)Daftar sumber hasil pencarian.
Properti type string (wajib)Jenis sumber. Selalu url.url string (wajib)URL sumber.string (opsional)Dimasukkan di awal konteks sebagai instruksi sistem. Ketika previous_response_id digunakan, instructions yang ditentukan di giliran sebelumnya tidak diteruskan ke konteks giliran saat ini.previous_response_id string (opsional)ID unik dari respons sebelumnya. id respons berlaku selama 7 hari. Anda dapat menggunakan parameter ini untuk membuat percakapan multi-putaran. Server secara otomatis mengambil dan menggabungkan input dan output giliran tersebut sebagai konteks. Jika Anda menyediakan array pesan input dan previous_response_id, pesan baru dalam input ditambahkan ke konteks historis. Parameter ini tidak dapat digunakan dengan conversation.conversation string (opsional)Percakapan tempat respons saat ini berada (lihat API Percakapan). Riwayat percakapan secara otomatis disertakan sebagai konteks. Input dan output permintaan ini ditambahkan ke percakapan setelah selesai. Tidak dapat digunakan dengan previous_response_id.prompt_cache_options object (Opsional)Hanya didukung oleh qwen4-max. Konfigurasi cache di tingkat teratas permintaan. Kirim parameter tingkat teratas nonstandar melalui extra_body di Python SDK, atau langsung di Node.js SDK dan curl. Lihat Cache eksplisit (Qwen4).
Properti mode stringimplicit (default): mengaktifkan cache eksplisit dan menetapkan breakpoint otomatis di akhir pesan input terakhir; breakpoint manual juga berlaku.explicit: mengaktifkan cache eksplisit; pembuatan cache memerlukan breakpoint manual. Tanpa breakpoint, opsi ini tidak berlaku.ttl string (Opsional)TTL cache. Mendukung 5m dan 1h; default 5m.boolean (opsional) Default ke falseMengaktifkan keluaran streaming. Jika diatur ke true, model mengalirkan respons secara real time.store boolean (opsional) Default ke trueMenentukan apakah respons model yang dihasilkan untuk sesi ini disimpan.
array (opsional)Array alat yang dapat dipanggil model saat menghasilkan respons. Mendukung alat bawaan serta alat function dan custom yang ditentukan pengembang. Gunakan namespace untuk mengelompokkan alat terkait.kimi-k3.1-pro (diterapkan di Alibaba Cloud Model Studio) mendukung ketiga alat bawaan web_search, web_extractor, dan code_interpreter di Beijing, Singapore, AS (Virginia), Jerman (Frankfurt), Jepang (Tokyo), dan China (Hong Kong).deepseek-v4.1-flash-1017 mendukung tiga alat bawaan: web_search, web_extractor, dan code_interpreter.Untuk hasil terbaik, aktifkan alat
Properti Pencarian webMencari informasi terkini di internet. Dokumentasi terkait: Pencarian WebCatatan: Dalam mode codex, mengaktifkan web_search dalam tools secara otomatis mengaktifkan web_extractor.
Properti type string (wajib)Tetap sebagai web_search.Contoh: [{"type": "web_search"}]web_search. Dokumentasi terkait: Ekstraksi Web
Properti type string (wajib)Tetap sebagai web_extractor.Contoh: [{"type": "web_search"}, {"type": "web_extractor"}]
Properti type string (wajib)Tetap sebagai code_interpreter.Contoh: [{"type": "code_interpreter"}]
Properti type string (wajib)Tetap sebagai web_search_image.Contoh: [{"type": "web_search_image"}]
Properti type string (wajib)Tetap sebagai image_search.Contoh: [{"type": "image_search"}]
Properti type string (wajib)Tetap sebagai file_search.vector_store_ids array(wajib)ID basis pengetahuan yang akan dicari. Saat ini, hanya satu ID basis pengetahuan yang dapat diberikan.Contoh: [{"type": "file_search", "vector_store_ids": ["your_knowledge_base_id"]}]
Properti type string (wajib)Tetap sebagai mcp.server_protocol string (wajib)Protokol komunikasi dengan layanan MCP, seperti "sse".server_label string (wajib)Label yang digunakan untuk mengidentifikasi layanan MCP.server_description string (opsional)Deskripsi layanan. Membantu model memahami fungsinya dan kapan harus menggunakannya.server_url string (wajib)URL titik akhir layanan MCP.headers objek (opsional)Header permintaan, digunakan untuk membawa informasi seperti autentikasi (misalnya, Authorization).Contoh:function_call. Dokumentasi terkait: Pemanggilan fungsi
Properti type string (wajib)Harus diatur ke function.namestring(wajib)Nama alat. Hanya boleh berisi huruf, angka, garis bawah (_), dan tanda hubung (-), dengan panjang maksimum 64 token.descriptionstring(wajib)Deskripsi alat, yang membantu model memutuskan kapan dan bagaimana memanggilnya.parameters objek (opsional)Definisi parameter untuk alat, yang harus berupa objek JSON Schema yang valid. Jika parameters kosong, alat tidak memerlukan argumen (misalnya, alat kueri waktu).
Untuk meningkatkan akurasi pemanggilan alat, kami merekomendasikan mendefinisikan Contoh:custom_tool_call dengan input alat di bidang input.
Properti type string (wajib)Nilai tetap: custom.name string (wajib)Nama alat, misalnya emit_code.description string (opsional)Deskripsi tujuan alat dan kapan alat perlu dipanggil.format object (opsional)Konfigurasi format input alat.Jika alat memerlukan tata bahasa tertentu, seperti format patch apply_patch, sebaiknya tetapkan format.type ke grammar dan berikan aturan tata bahasa untuk membantu model menghasilkan input pemanggilan dalam format yang ditentukan.Jika format.type bernilai grammar, berikan syntax dan definition bersama-sama. Jika bernilai text, input berupa teks bebas tanpa batasan, dan syntax serta definition bersifat opsional.
Properti type string (opsional)Gunakan text untuk teks bebas tanpa tata bahasa tertentu, atau grammar untuk format berbasis tata bahasa.syntax string (opsional)Sintaks tata bahasa: lark atau regex.definition string (opsional)Definisi tata bahasa: aturan produksi untuk Lark atau ekspresi reguler untuk Regex.tools.function atau custom terkait dalam satu namespace.
Properti type string (wajib)Nilai tetap: namespace.name string (wajib)Nama namespace, misalnya crm.description string (opsional)Deskripsi keseluruhan namespace.tools array[object] (wajib)Daftar alat dalam namespace. Setiap elemen adalah objek alat function atau custom dengan bidang yang sama seperti definisi alat terkait.tools.string atau objek (opsional) Default ke autoMengontrol cara model memilih dan memanggil alat. Parameter ini mendukung dua format: mode string dan mode objek.Mode string
Properti mode string (wajib)
array(wajib)Daftar definisi alat yang boleh dipanggil model.string (wajib)Jenis konfigurasi alat. Tetap sebagai allowed_tools.boolean (opsional) Default ke trueMenentukan apakah akan mengaktifkan pemanggilan alat paralel. Untuk informasi selengkapnya, lihat Pemanggilan alat paralel.kimi-k3 tidak mendukung pengendalian paralelisme pemanggilan alat melalui parameter ini. Mengaturnya keNilai yang valid:
float(opsional)Suhu pengambilan sampel, yang mengontrol keragaman teks yang dihasilkan.Nilai yang lebih tinggi membuat output lebih acak dan beragam, sedangkan nilai yang lebih rendah membuatnya lebih fokus dan deterministik.Kisaran nilai: [0, 2)Baik suhu maupun top_p mengontrol keragaman teks yang dihasilkan. Kami merekomendasikan hanya menggunakan salah satu parameter ini dalam satu waktu. Untuk informasi selengkapnya, lihat Ikhtisar.top_pfloat(opsional)qwen4-max:0.95 dalam mode penalaran; 0.8 dalam mode nonpenalaran.Ambang batas probabilitas untuk pengambilan sampel top-p, yang mengontrol keragaman teks yang dihasilkan.Nilai yang lebih tinggi membuat output lebih acak dan beragam, sedangkan nilai yang lebih rendah membuatnya lebih fokus dan deterministik.Kisaran nilai: (0, 1.0]Baik suhu maupun top_p mengontrol keragaman teks yang dihasilkan. Kami merekomendasikan hanya menggunakan salah satu parameter ini dalam satu waktu. Untuk informasi selengkapnya, lihat Ikhtisar.enable_thinking boolean (opsional)Mengaktifkan atau menonaktifkan mode reasoning. Ketika diaktifkan, model melakukan langkah reasoning sebelum merespons. Proses reasoning dikembalikan sebagai item keluaran bertipe reasoning. Ketika mengaktifkan mode reasoning, kami merekomendasikan juga mengaktifkan alat bawaan untuk mencapai hasil terbaik pada tugas kompleks.Nilai yang valid:
Parameter ini bukan parameter OpenAI standar. Di SDK Python, teruskan menggunakanreasoning objek (opsional)Mengontrol upaya reasoning model. Model melakukan langkah reasoning sebelum membalas, dan proses reasoning dikembalikan melalui item keluaran bertipe reasoning.Untuk kimi-k3.1-pro (diterapkan di Alibaba Cloud Model Studio), reasoning.effort secara default bernilai max. Nilai yang didukung adalah max (penalaran mendalam), high (penalaran yang ditingkatkan), medium (penalaran sedang), dan low (penalaran ringan). Disarankan untuk mempertahankan konfigurasi pemikiran default karena menonaktifkan pemikiran secara signifikan menurunkan kualitas output.
Properti Tingkat dan nilai default kimi-k3.1-pro mengikuti penjelasan di atas. Penjelasan umum berikut berlaku untuk model lainnya.effort string (opsional): Tingkat upaya reasoning. Default ke xhigh.qwen4-maxNilai default: reasoning.effort=high.
reasoning.effort yang diatur, batas penalaran default adalah 131072 token.Mendukung 7 tingkat bertahap: none, minimal, low, medium, high, xhigh, dan max. Menurunkan nilai ini akan mempercepat kecepatan respons dan mengurangi konsumsi Token inferensi.summary string (opsional)qwen4-max: "auto". Ringkasan dan enkripsi penalaran.Secara default, penalaran lengkap dikembalikan. Setelah diaktifkan, penalaran asli tidak lagi dikembalikan sebagai teks biasa; ringkasan digunakan untuk tampilan dan teks terenkripsi untuk memulihkan riwayat.ocr_options objek (opsional)Parameter tugas bawaan OCR. Hanya berlaku untuk model qwen3.5-ocr. Gunakan parameter ini untuk memanggil tugas OCR bawaan (seperti ekstraksi informasi dan pelokalan teks). Hasil tugas bawaan dikembalikan dalam bidang ocr_result respons.Saat mengurai file PDF, nilai task menentukan jumlah halaman yang didukung: maksimal 50 halaman jika disetel ke document_parsing; maksimal 10 halaman jika task tidak disetel atau disetel ke tugas lain.Parameter ini bukan parameter OpenAI standar. Di SDK Python, teruskan menggunakanmax_output_tokens integer (opsional)Untuk qwen4-max, mode penalaran membatasi jumlah token penalaran dan jawaban, dengan maksimum dan default 262144. Mode nonpenalaran memiliki maksimum dan default 131072.
incomplete.text object (opsional)Konfigurasi keluaran teks model. Keluaran dapat berupa teks biasa atau data JSON terstruktur.
Properti format object (opsional)Format yang harus dihasilkan model. Nilai default: {"type": "text"}.Salah satu dari jenis berikut:ResponseFormatText { type }Format default. Mengeluarkan teks.
Properti type string (wajib)Tetap sebagai text.{ type, json_schema }Mengeluarkan string JSON yang secara ketat sesuai dengan JSON Schema yang ditentukan, sehingga Anda dapat mengontrol struktur keluaran dan tipe bidang secara presisi. Didukung oleh seri qwen3.8, seri deepseek-v4, seri glm-5, dan model lainnya; seri deepseek-v4.1 akan segera mendukung. Dengan jenis ini, prompt tidak perlu memuat kata kunci JSON.
Properti type string (wajib)Tetap sebagai json_schema.json_schema object (wajib)Konfigurasi JSON Schema.
Properti name string (wajib)Nama skema.schema object (wajib)Objek JSON Schema yang menjelaskan struktur keluaran. Gunakan properties untuk mendefinisikan struktur bidang, required untuk mencantumkan bidang yang wajib diisi, dan additionalProperties untuk mengontrol apakah bidang yang tidak didefinisikan dalam skema boleh dikeluarkan (sebaiknya atur ke false agar hanya bidang yang telah didefinisikan yang dikeluarkan). Tipe data yang didukung: string, number, integer, boolean, object, array, dan enum. Untuk informasi selengkapnya, lihat Panduan konfigurasi.strict boolean (opsional)Menentukan apakah struktur yang didefinisikan oleh schema harus diikuti secara ketat. Sebaiknya atur parameter ini ke true.{ type }Mengeluarkan string berformat JSON standar. Didukung oleh seri qwen3.8, seri deepseek-v4, seri deepseek-v4.1, seri glm-5, dan kimi-k3.1-pro (diterapkan di Alibaba Cloud Model Studio). Dengan jenis ini, Anda harus secara eksplisit menginstruksikan model untuk mengeluarkan JSON dalam prompt, seperti "Silakan keluarkan dalam format JSON". Jika tidak, akan terjadi error.
Properti type string (wajib)Tetap sebagai json_object. |
Python |
Objek respons (keluaran non-streaming)idstringPengidentifikasi unik untuk respons ini, berupa UUID. ID ini berlaku selama 7 hari dan dapat digunakan dalam parameter previous_response_id untuk membuat percakapan multi-putaran.created_at integerTimestamp Unix (dalam detik) untuk permintaan ini.object stringJenis objek, yang selalu response.status stringStatus generasi respons. Nilai yang valid:
stringID model yang digunakan untuk menghasilkan respons.output arrayArray item keluaran yang dihasilkan model. Jenis dan urutan elemen dalam array bergantung pada respons model.
Properti elemen array type stringJenis item keluaran. Nilai yang valid:
stringPengidentifikasi unik item keluaran. Semua jenis item keluaran berisi bidang ini.role stringPeran pesan selalu assistant. Parameter ini ada hanya ketika type adalah message.status stringStatus item keluaran. Nilai yang valid: completed dan in_progress. Tidak dikembalikan jika type bernilai reasoning atau custom_tool_call.name stringNama alat atau fungsi. Parameter ini ada ketika type adalah function_call atau custom_tool_call, web_search_image_call, image_search_call, atau mcp_call.Untuk web_search_image_call dan image_search_call, nilainya tetap "web_search_image" dan "image_search", masing-masing.Untuk mcp_call, nilainya adalah nama fungsi spesifik yang dipanggil dalam layanan MCP, seperti amap-maps-maps_geo.namespace string (opsional)Namespace tempat alat berada. Dikembalikan untuk pemanggilan alat function atau custom dalam namespace. Pertahankan bidang ini saat mengirim kembali item pemanggilan.input string (opsional)Input teks bebas untuk alat kustom. Hanya ada jika type bernilai custom_tool_call.arguments stringParameter untuk pemanggilan alat, dalam format string JSON. Parameter ini ada ketika type adalah function_call, web_search_image_call, image_search_call, atau mcp_call. Uraikan string dengan menggunakan JSON.parse() sebelum digunakan. Konten argumen untuk berbagai jenis alat adalah sebagai berikut:
stringID unik untuk pemanggilan fungsi. Parameter ini hanya disertakan ketika type adalah function_call atau custom_tool_call. ID ini harus disertakan dalam hasil pemanggilan fungsi untuk menghubungkan permintaan dengan respons.content arrayArray konten pesan. Parameter ini ada hanya jika type diatur ke message.
Properti elemen array type stringJenis konten. Nilainya tetap output_text.text stringKonten teks yang dihasilkan model.annotations arrayArray anotasi teks. Biasanya berupa array kosong.stringqwen4-max, reasoning.summary="auto": Item reasoning Responses berisi summary (elemen summary_text) dan encrypted_content. Ringkasan dikirim bertahap; teks terenkripsi dikirim pada peristiwa penyelesaian item reasoning dan response akhir. Gunakan snapshot selesai untuk melengkapi enkripsi tanpa menambahkan ringkasan dua kali. Ringkasan dan enkripsi penalaran. Kirim kembali ciphertext tanpa perubahan.summary arrayArray ringkasan reasoning. Bidang ini ada hanya ketika type adalah reasoning. Setiap elemen berisi bidang type (nilai: summary_text) dan bidang text (teks ringkasan).action objekInformasi tentang tindakan pencarian. Parameter ini ada hanya ketika type adalah web_search_call.
Properti query stringKata kunci kueri pencarian.type stringJenis pencarian. Nilainya selalu search.sources arrayDaftar sumber pencarian. Setiap elemen berisi bidang type dan url.stringKode yang dihasilkan dan dieksekusi model. Ini ada hanya ketika type adalah code_interpreter_call.outputs arrayArray keluaran eksekusi kode. Ini ada hanya ketika type adalah code_interpreter_call. Setiap elemen memiliki bidang type (nilainya logs) dan bidang logs (log eksekusi kode).container_id stringPengidentifikasi kontainer untuk interpreter kode. Parameter ini ada hanya ketika type adalah code_interpreter_call. Pengidentifikasi ini mengaitkan beberapa eksekusi kode dalam sesi yang sama.goal stringDeskripsi informasi yang akan diekstraksi dari halaman web. Parameter ini tersedia hanya ketika type adalah web_extractor_call.output stringKeluaran pemanggilan alat. Keluarannya berupa string.
arrayDaftar URL untuk halaman web yang diekstraksi. Parameter ini tersedia hanya ketika type adalah web_extractor_call.server_label stringLabel untuk layanan MCP. Ini muncul hanya ketika type adalah mcp_call. Ini menunjukkan layanan MCP mana yang digunakan dalam pemanggilan.queries arrayDaftar kueri untuk pengambilan basis pengetahuan. Parameter ini ada hanya ketika type adalah file_search_call. Array berisi string. Setiap string adalah kueri pencarian yang dihasilkan model.results arrayArray hasil pencarian dari basis pengetahuan. Parameter ini ada hanya ketika type adalah file_search_call.
Properti elemen array file_id stringID file dokumen yang cocok.filename stringNama file dokumen yang cocok.score floatSkor relevansi kecocokan. Nilainya berkisar dari 0 hingga 1. Nilai yang lebih besar menunjukkan relevansi yang lebih tinggi.text stringCuplikan konten dari dokumen yang cocok.objectStatistik penggunaan alat untuk permintaan ini, dicatat secara terpisah dari penggunaan token model dalam usage. Jika tidak ada alat yang dipanggil, nilai default bidang ini adalah objek kosong {}.
Properti web_search object
Properti num_requests integerJumlah pencarian yang dikenai biaya.object
Properti num_requests integerJumlah eksekusi interpreter kode.object
Properti num_requests integerJumlah permintaan ekstraksi konten halaman web.object
Properti num_requests integerJumlah pencarian gambar berdasarkan gambar.object
Properti num_requests integerJumlah pencarian gambar berdasarkan teks.object
Properti num_requests integerJumlah halaman PDF yang diurai.object (Opsional)Hanya didukung oleh qwen4-max. Mode cache dan TTL untuk permintaan ini.
Properti mode stringimplicit / explicitttl string5m / 1hobjekInformasi tentang konsumsi token untuk permintaan ini.Seri Qwen4, seri Kimi-K3.1, dan model baru berikutnya menggunakan struktur respons baru di bawah.
Properti input_tokens integerJumlah token dalam input. Catatan Tambahanoutput_tokens integerJumlah token dalam output model.total_tokens integerJumlah total token yang dikonsumsi adalah jumlah dari input_tokens dan output_tokens.input_tokens_details objekKlasifikasi detail halus token input.
Properti cached_tokens integerJumlah token yang hit cache. Untuk informasi selengkapnya, lihat peng-cache-an konteks.objekRincian terperinci token output.
Properti reasoning_tokens integerJumlah token reasoning.arrayArray rincian penagihan untuk permintaan. Ini memberikan rincian lebih granular token multimodal daripada bidang usage tingkat atas.
Properti input_tokens integerJumlah token dalam input. Catatan Tambahanoutput_tokens integerJumlah token dalam output model.total_tokens integerJumlah total token yang dikonsumsi adalah jumlah dari input_tokens dan output_tokens.x_billing_type stringNilainya tetap response_api.image_tokens integerJumlah token untuk input gambar. Bidang ini dikembalikan ketika input menyertakan gambar dan setara dengan input_tokens_details.image_tokens.input_tokens_details objekRincian granular token input. Bidang ini dikembalikan untuk input multimodal. Saat ini hanya membedakan antara text_tokens dan image_tokens. Tidak memberikan rincian untuk token video atau audio.
Properti text_tokens integerJumlah token untuk input teks.image_tokens integerJumlah token untuk input gambar.objekRincian granular token output. Bidang ini memiliki tambahan bidang text_tokens dibandingkan dengan output_tokens_details tingkat atas. Bidang text_tokens dikembalikan untuk input multimodal.
Properti reasoning_tokens integerJumlah token untuk proses reasoning.text_tokens integerJumlah token untuk output teks. Bidang ini dikembalikan untuk input multimodal.objekStatistik untuk pemanggilan alat bawaan. Bidang ini dikembalikan ketika alat bawaan seperti web_search digunakan. Isinya sama dengan bidang x_tools tingkat atas.
Properti web_search objekStatistik untuk pemanggilan pencarian web.
Properti count integerJumlah kali pencarian web dipanggil dalam respons ini.objekRincian cache untuk token input. Bidang ini dikembalikan ketika cache sesi diaktifkan. Mungkin mengembalikan objek kosong jika input menyertakan gambar tetapi menghasilkan cache miss.
Properti cached_tokens integerJumlah token yang ditemukan di cache.cache_creation_input_tokens integerJumlah token yang digunakan untuk membuat cache baru dalam permintaan ini.cache_creation objekRincian pembuatan cache.
Properti ephemeral_5m_input_tokens integerJumlah token yang digunakan untuk membuat cache ephemeral baru selama 5 menit.stringJenis cache. Nilainya tetap ephemeral.objekStatistik penggunaan alat. Ini berisi jumlah kali setiap alat bawaan dipanggil.Contoh: {"web_search": {"count": 1}}
Properti (Qwen4, Kimi-K3.1) input_tokens integerTotal token input, termasuk pembacaan cache, penulisan cache, dan input tanpa cache.input_tokens_details objectDetail token input.
Properti cache_write_tokens integerToken yang ditulis ke cache.cache_write_tokens_details objectDetail penulisan cache berdasarkan TTL.
Properti ttl_1h_tokens integerToken yang ditulis ke cache 1 jam.ttl_5m_tokens integerToken yang ditulis ke cache 5 menit.integerToken yang dibaca dari cache.integerTotal token output.output_tokens_details objectDetail token output.
Properti reasoning_tokens integerToken penalaran.integerJumlah token input dan output.Struktur respons baru tidak mengembalikan x_details atau x_tools.objekObjek error dikembalikan ketika model gagal menghasilkan respons. Jika tidak, nilainya null.tools arrayMenggemakan konten lengkap parameter tools dari permintaan, dengan struktur yang sama seperti parameter tools dalam badan permintaan.tool_choice stringMenggemakan nilai parameter tool_choice dalam permintaan. Nilai yang valid adalah auto, none, dan required. | Contoh respons berikut menggunakan qwen3.8-max untuk menjelaskan field respons. |
Objek potongan respons (keluaran streaming)Keluaran streaming mengembalikan serangkaian objek JSON. Setiap objek mencakup bidangtype untuk menentukan jenis peristiwa dan bidang sequence_number untuk menunjukkan urutan peristiwa. Peristiwa response.completed menandai akhir aliran.type stringPengidentifikasi jenis peristiwa. Nilai yang mungkin meliputi:
integerNomor urutan peristiwa, dimulai dari 0 dan bertambah dengan setiap peristiwa. Gunakan nomor ini untuk memproses peristiwa dalam urutan yang benar.response objekObjek respons. Muncul dalam peristiwa response.created, response.in_progress, dan response.completed. Dalam peristiwa response.completed, objek ini berisi data respons lengkap (termasuk output dan usage), dan strukturnya identik dengan objek Respons non-streaming.item objekObjek item keluaran. Muncul dalam peristiwa response.output_item.added dan response.output_item.done. Dalam peristiwa added, objek ini merupakan kerangka awal di mana content adalah array kosong. Dalam peristiwa done, objek ini lengkap.
Properti id stringPengidentifikasi unik untuk item keluaran (misalnya, msg_xxx).type stringJenis item keluaran. Nilai yang mungkin: message, reasoning, web_search_call, web_search_image_call (pencarian teks-ke-gambar), image_search_call (pencarian gambar-ke-gambar), mcp_call (pemanggilan MCP), file_search_call (pencarian basis pengetahuan).role stringPeran pesan, yang selalu assistant. Ada hanya ketika type adalah message.status stringStatus generasi. Dalam peristiwa added, statusnya in_progress, dan dalam peristiwa done, statusnya completed.content arrayArray konten pesan. Dalam peristiwa added, array ini kosong []. Dalam peristiwa done, array ini berisi objek bagian konten lengkap yang strukturnya sama dengan objek part.objekObjek bagian konten. Muncul dalam peristiwa response.content_part.added dan response.content_part.done.
Properti type stringJenis bagian konten, yang selalu output_text.text stringKonten teks. Ini adalah string kosong dalam peristiwa added dan teks lengkap dalam peristiwa done.annotations arrayArray anotasi teks. Biasanya berupa array kosong.logprobs objek | nullProbabilitas log token. Bidang ini saat ini selalu mengembalikan null.stringSegmen teks inkremental. Bidang ini muncul dalam peristiwa response.output_text.delta dan berisi segmen teks yang baru ditambahkan. Gabungkan semua nilai delta untuk merekonstruksi teks lengkap.text stringKonten teks lengkap. Bidang ini muncul dalam peristiwa response.output_text.done. Anda dapat menggunakannya untuk memvalidasi teks yang direkonstruksi dari fragmen delta.item_id stringPengidentifikasi unik untuk item keluaran. Gunakan ID ini untuk menghubungkan peristiwa yang termasuk dalam item yang sama.output_index integerIndeks item keluaran dalam array output.content_index integerIndeks bagian konten dalam array content. | Contoh streaming untuk struktur respons sebelumnya. |
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 ditentukan oleh protokol OpenAI. Layanan kami tidak mendukung bidang-bidang ini, sehingga biasanya bernilai null. Fokuslah hanya pada bidang yang dijelaskan dalam topik ini.