Prasyarat
Dapatkan API key di konsol dan atur sebagai variabel lingkungan DASHSCOPE_API_KEY.
Instal SDK
Memerlukan Node.js 18 atau lebih baru. Unduh paket SDK 0.1.0, lalu jalankan perintah ini di proyek:
Mulai cepat
Contoh panggilan berikut dapat digunakan bersama. Ganti ID model sesuai tabel.
| Model | ID model dalam contoh |
|---|---|
| Qwen-Audio-ASR-Streaming | qwen-audio-3.1-asr-flash-streaming |
| Qwen-Audio-ASR-Message | qwen-audio-3.1-asr-flash-message |
input.mp3 dan konversi ke PCM mono 16 kHz, 16-bit:
example.mjs dan jalankan node example.mjs.
Parameter permintaan
Qwen-Audio-ASR-Streaming
Referensi umum
Opsi konstruktor RecognitionClient:
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
apiKey | string | Tidak | API key. Default membaca DASHSCOPE_API_KEY. |
workspaceId | string | Tidak | ID ruang kerja. Default membaca DASHSCOPE_WORKSPACE_ID. |
baseUrl | string | Tidak | Atur nama host layanan ke dashscope-intl.aliyuncs.com (Singapura). |
model | string | Tidak | ID model. Default: qwen-audio-3.1-asr-flash-streaming. |
format | 'pcm' | 'wav' | 'mp3' | 'opus' | 'speex' | 'aac' | 'amr' | Tidak | Format audio. Default: pcm. WAV memakai PCM, Opus/Speex memakai kontainer Ogg, dan AMR memakai AMR-NB. |
sampleRate | number | Tidak | Laju sampel audio sebenarnya dalam Hz. Default: 16000. |
vocabularyId | string | Tidak | ID kosakata yang telah dikompilasi. |
languageHints | string[] | Tidak | Petunjuk bahasa pengenalan. Maksimal 4 nilai pertama berlaku. Bahasa dideteksi otomatis jika diabaikan. |
multiThresholdModeEnabled | boolean | Tidak | Mode multiambang agar segmen VAD tidak terlalu panjang. Default: false. |
maxSentenceSilence | number | Tidak | Ambang diam akhir kalimat VAD dalam ms: [200,6000]; default: 800. |
heartbeat | boolean | Tidak | Keepalive saat hening. Default: false; terus kirim audio hening jika diaktifkan. |
context | AsrContextMessage[] | Tidak | Konteks pengenalan. Format: { role, content: [{ type: "input_text", text }] }, dengan role berupa user atau assistant. Maksimal 5 pesan per peran, total kurang dari 400 karakter, berurutan sesuai giliran percakapan. |
parameters | Partial<RecognitionParameters> | Tidak | Parameter pengenalan tambahan, seperti vad_model, keep_dialect, dan vocabulary. |
connectTimeoutMs | number | Tidak | Batas waktu koneksi dalam ms. Default: 10000. |
taskTimeoutMs | number | Tidak | Batas waktu konfirmasi mulai/selesai dalam ms. Default: 60000; 0 menonaktifkannya. |
parameters.vad_model | 'near_meeting_16k' | 'far_field_meeting_16k' | Tidak | VAD jarak dekat atau jauh. Default: far_field_meeting_16k. |
parameters.keep_dialect | boolean | Tidak | Pertahankan ekspresi dialek. Default: false. |
parameters.vocabulary | Record<string, number> | Tidak | Kosakata instan: kata sebagai kunci, bobot [1,5] atau 50 sebagai nilai. |
parameters.speech_noise_threshold | number | Tidak | Ambang sensitivitas VAD: [-1,1]. |
Qwen-Audio-ASR-Message
Referensi umum
Opsi konstruktor RecognitionClient:
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
apiKey | string | Tidak | API key. Default membaca DASHSCOPE_API_KEY. |
workspaceId | string | Tidak | ID ruang kerja. Default membaca DASHSCOPE_WORKSPACE_ID. |
baseUrl | string | Tidak | Atur nama host layanan ke dashscope-intl.aliyuncs.com (Singapura). |
model | string | Ya | Atur ID model ke qwen-audio-3.1-asr-flash-message. |
format | 'pcm' | 'wav' | 'mp3' | 'opus' | 'speex' | 'aac' | 'amr' | Tidak | Format audio. Default: pcm. WAV memakai PCM, Opus/Speex memakai kontainer Ogg, dan AMR memakai AMR-NB. |
sampleRate | number | Tidak | Laju sampel audio. Gunakan 16000 Hz. |
vocabularyId | string | Tidak | ID kosakata yang telah dikompilasi. |
languageHints | string[] | Tidak | Petunjuk bahasa pengenalan. Maksimal 4 nilai pertama berlaku. Bahasa dideteksi otomatis jika diabaikan. |
disfluencyRemovalEnabled | boolean | Tidak | Hapus ketidaklancaran dan rapikan hasil. Default: false. |
maxSentenceSilence | number | Tidak | Ambang diam akhir kalimat VAD dalam ms: [200,6000]; default: 800. |
heartbeat | boolean | Tidak | Keepalive saat hening. Default: false; terus kirim audio hening jika diaktifkan. |
context | AsrContextMessage[] | Tidak | Konteks pengenalan. Format: { role, content: [{ type: "input_text", text }] }, dengan role berupa user atau assistant. Maksimal 5 pesan per peran, total kurang dari 400 karakter, berurutan sesuai giliran percakapan. |
parameters | Partial<RecognitionParameters> | Tidak | Parameter pengenalan tambahan, seperti vad_model, keep_dialect, dan vocabulary. |
connectTimeoutMs | number | Tidak | Batas waktu koneksi dalam ms. Default: 10000. |
taskTimeoutMs | number | Tidak | Batas waktu konfirmasi mulai/selesai dalam ms. Default: 60000; 0 menonaktifkannya. |
parameters.vad_model | 'near_meeting_16k' | 'far_field_meeting_16k' | Tidak | VAD jarak dekat atau jauh. Default: far_field_meeting_16k. |
parameters.keep_dialect | boolean | Tidak | Pertahankan ekspresi dialek. Default: false. |
parameters.vocabulary | Record<string, number> | Tidak | Kosakata instan: kata sebagai kunci, bobot [1,5] atau 50 sebagai nilai. |
parameters.speech_noise_threshold | number | Tidak | Ambang sensitivitas VAD: [-1,1]. |
parameters.intermediate_result_enabled | boolean | Tidak | Kembalikan hasil pengenalan sementara. Default: false. |
Referensi API
Qwen-Audio-ASR-Streaming
Metode utama
| Metode | Nilai kembalian | Deskripsi |
|---|---|---|
start() | Promise<void> | Mulai pengenalan; kirim audio setelah selesai. |
sendAudio(audio: Buffer | Uint8Array) | void | Kirim frame audio sesuai format dan laju sampel yang dikonfigurasi. |
finish() | Promise<void> | Akhiri input audio dan tunggu selesai. Teks diterima melalui callback. |
close(code?: number, reason?: string) | void | Tutup koneksi dan lepaskan sumber daya tugas. |
Peristiwa callback
Daftarkan callback dengan on(event, listener). Lihat peristiwa server untuk kolom lengkap.
| Peristiwa | Payload | Deskripsi |
|---|---|---|
started | { taskId: string } | Tugas sudah dimulai dan menerima input. |
result | { text: string; sentence_end: boolean; sentence_begin?: boolean; words?: RecognitionWord[] } | Kalimat sementara atau final, tidak termasuk hasil heartbeat. |
sentenceEnd | { text: string; sentence_end: boolean; sentence_begin?: boolean; words?: RecognitionWord[] } | Kalimat final dengan sentence_end === true. |
finished | { taskId: string; duration?: number; usage?: RecognitionUsage } | Tugas selesai dan status lokal dibersihkan. |
failed / error | DashScopeError | Kesalahan pemanggilan dengan code, message, dan identitas permintaan. |
close | { code: number; reason: string } | Notifikasi penutupan koneksi dasar. |
event | ServerEvent | Pesan JSON layanan asli. |
Qwen-Audio-ASR-Message
Metode utama
| Metode | Nilai kembalian | Deskripsi |
|---|---|---|
start() | Promise<void> | Mulai pengenalan; kirim audio setelah selesai. |
sendAudio(audio: Buffer | Uint8Array) | void | Kirim frame audio sesuai format dan laju sampel yang dikonfigurasi. |
updateContext(context: AsrContextMessage[]) | void | Perbarui konteks setelah mulai dan sebelum input selesai. |
finish() | Promise<void> | Akhiri input audio dan tunggu selesai. Teks diterima melalui callback. |
close(code?: number, reason?: string) | void | Tutup koneksi dan lepaskan sumber daya tugas. |
Peristiwa callback
Daftarkan callback dengan on(event, listener). Lihat peristiwa server untuk kolom lengkap.
| Peristiwa | Payload | Deskripsi |
|---|---|---|
started | { taskId: string } | Tugas sudah dimulai dan menerima input. |
result | { text: string; sentence_end: boolean; sentence_begin?: boolean; words?: RecognitionWord[] } | Kalimat sementara atau final, tidak termasuk hasil heartbeat. |
sentenceEnd | { text: string; sentence_end: boolean; sentence_begin?: boolean; words?: RecognitionWord[] } | Kalimat final dengan sentence_end === true. |
finished | { taskId: string; duration?: number; usage?: RecognitionUsage } | Tugas selesai dan status lokal dibersihkan. |
failed / error | DashScopeError | Kesalahan pemanggilan dengan code, message, dan identitas permintaan. |
close | { code: number; reason: string } | Notifikasi penutupan koneksi dasar. |
event | ServerEvent | Pesan JSON layanan asli. |