Skip to main content

Qwen-Audio-ASR Node.js SDK

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:
npm install ./dashscope-sdk-nodejs-0.1.0.tgz

Mulai cepat

Contoh panggilan berikut dapat digunakan bersama. Ganti ID model sesuai tabel.
ModelID model dalam contoh
Qwen-Audio-ASR-Streamingqwen-audio-3.1-asr-flash-streaming
Qwen-Audio-ASR-Messageqwen-audio-3.1-asr-flash-message
Unduh audio contoh sebagai input.mp3 dan konversi ke PCM mono 16 kHz, 16-bit:
ffmpeg -i input.mp3 -f s16le -ac 1 -ar 16000 input.pcm
Simpan contoh berikut sebagai example.mjs dan jalankan node example.mjs.
import { readFile } from 'node:fs/promises'
import { setTimeout as sleep } from 'node:timers/promises'
import { RecognitionClient } from 'dashscope-sdk-nodejs/asr'

const pcm = await readFile('input.pcm')
const asr = new RecognitionClient({
  apiKey: process.env.DASHSCOPE_API_KEY,
  workspaceId: process.env.DASHSCOPE_WORKSPACE_ID,
  baseUrl: 'dashscope-intl.aliyuncs.com',
  model: 'qwen-audio-3.1-asr-flash-streaming',
  format: 'pcm',
  sampleRate: 16000,
})
asr.on('sentenceEnd', sentence => console.log('Final sentence:', sentence.text))
asr.on('error', err => console.error(err.code, err.message))

try {
  await asr.start()
  for (let offset = 0; offset < pcm.length; offset += 3200) {
    asr.sendAudio(pcm.subarray(offset, offset + 3200))
    await sleep(100)
  }
  await asr.finish()
} finally {
  asr.close()
}

Parameter permintaan

Qwen-Audio-ASR-Streaming

Referensi umum Opsi konstruktor RecognitionClient:
ParameterTipeWajibDeskripsi
apiKeystringTidakAPI key. Default membaca DASHSCOPE_API_KEY.
workspaceIdstringTidakID ruang kerja. Default membaca DASHSCOPE_WORKSPACE_ID.
baseUrlstringTidakAtur nama host layanan ke dashscope-intl.aliyuncs.com (Singapura).
modelstringTidakID model. Default: qwen-audio-3.1-asr-flash-streaming.
format'pcm' | 'wav' | 'mp3' | 'opus' | 'speex' | 'aac' | 'amr'TidakFormat audio. Default: pcm. WAV memakai PCM, Opus/Speex memakai kontainer Ogg, dan AMR memakai AMR-NB.
sampleRatenumberTidakLaju sampel audio sebenarnya dalam Hz. Default: 16000.
vocabularyIdstringTidakID kosakata yang telah dikompilasi.
languageHintsstring[]TidakPetunjuk bahasa pengenalan. Maksimal 4 nilai pertama berlaku. Bahasa dideteksi otomatis jika diabaikan.
multiThresholdModeEnabledbooleanTidakMode multiambang agar segmen VAD tidak terlalu panjang. Default: false.
maxSentenceSilencenumberTidakAmbang diam akhir kalimat VAD dalam ms: [200,6000]; default: 800.
heartbeatbooleanTidakKeepalive saat hening. Default: false; terus kirim audio hening jika diaktifkan.
contextAsrContextMessage[]TidakKonteks 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.
parametersPartial<RecognitionParameters>TidakParameter pengenalan tambahan, seperti vad_model, keep_dialect, dan vocabulary.
connectTimeoutMsnumberTidakBatas waktu koneksi dalam ms. Default: 10000.
taskTimeoutMsnumberTidakBatas waktu konfirmasi mulai/selesai dalam ms. Default: 60000; 0 menonaktifkannya.
parameters.vad_model'near_meeting_16k' | 'far_field_meeting_16k'TidakVAD jarak dekat atau jauh. Default: far_field_meeting_16k.
parameters.keep_dialectbooleanTidakPertahankan ekspresi dialek. Default: false.
parameters.vocabularyRecord<string, number>TidakKosakata instan: kata sebagai kunci, bobot [1,5] atau 50 sebagai nilai.
parameters.speech_noise_thresholdnumberTidakAmbang sensitivitas VAD: [-1,1].

Qwen-Audio-ASR-Message

Referensi umum Opsi konstruktor RecognitionClient:
ParameterTipeWajibDeskripsi
apiKeystringTidakAPI key. Default membaca DASHSCOPE_API_KEY.
workspaceIdstringTidakID ruang kerja. Default membaca DASHSCOPE_WORKSPACE_ID.
baseUrlstringTidakAtur nama host layanan ke dashscope-intl.aliyuncs.com (Singapura).
modelstringYaAtur ID model ke qwen-audio-3.1-asr-flash-message.
format'pcm' | 'wav' | 'mp3' | 'opus' | 'speex' | 'aac' | 'amr'TidakFormat audio. Default: pcm. WAV memakai PCM, Opus/Speex memakai kontainer Ogg, dan AMR memakai AMR-NB.
sampleRatenumberTidakLaju sampel audio. Gunakan 16000 Hz.
vocabularyIdstringTidakID kosakata yang telah dikompilasi.
languageHintsstring[]TidakPetunjuk bahasa pengenalan. Maksimal 4 nilai pertama berlaku. Bahasa dideteksi otomatis jika diabaikan.
disfluencyRemovalEnabledbooleanTidakHapus ketidaklancaran dan rapikan hasil. Default: false.
maxSentenceSilencenumberTidakAmbang diam akhir kalimat VAD dalam ms: [200,6000]; default: 800.
heartbeatbooleanTidakKeepalive saat hening. Default: false; terus kirim audio hening jika diaktifkan.
contextAsrContextMessage[]TidakKonteks 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.
parametersPartial<RecognitionParameters>TidakParameter pengenalan tambahan, seperti vad_model, keep_dialect, dan vocabulary.
connectTimeoutMsnumberTidakBatas waktu koneksi dalam ms. Default: 10000.
taskTimeoutMsnumberTidakBatas waktu konfirmasi mulai/selesai dalam ms. Default: 60000; 0 menonaktifkannya.
parameters.vad_model'near_meeting_16k' | 'far_field_meeting_16k'TidakVAD jarak dekat atau jauh. Default: far_field_meeting_16k.
parameters.keep_dialectbooleanTidakPertahankan ekspresi dialek. Default: false.
parameters.vocabularyRecord<string, number>TidakKosakata instan: kata sebagai kunci, bobot [1,5] atau 50 sebagai nilai.
parameters.speech_noise_thresholdnumberTidakAmbang sensitivitas VAD: [-1,1].
parameters.intermediate_result_enabledbooleanTidakKembalikan hasil pengenalan sementara. Default: false.

Referensi API

Qwen-Audio-ASR-Streaming

Metode utama

MetodeNilai kembalianDeskripsi
start()Promise<void>Mulai pengenalan; kirim audio setelah selesai.
sendAudio(audio: Buffer | Uint8Array)voidKirim 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)voidTutup koneksi dan lepaskan sumber daya tugas.

Peristiwa callback

Daftarkan callback dengan on(event, listener). Lihat peristiwa server untuk kolom lengkap.
PeristiwaPayloadDeskripsi
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 / errorDashScopeErrorKesalahan pemanggilan dengan code, message, dan identitas permintaan.
close{ code: number; reason: string }Notifikasi penutupan koneksi dasar.
eventServerEventPesan JSON layanan asli.

Qwen-Audio-ASR-Message

Metode utama

MetodeNilai kembalianDeskripsi
start()Promise<void>Mulai pengenalan; kirim audio setelah selesai.
sendAudio(audio: Buffer | Uint8Array)voidKirim frame audio sesuai format dan laju sampel yang dikonfigurasi.
updateContext(context: AsrContextMessage[])voidPerbarui 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)voidTutup koneksi dan lepaskan sumber daya tugas.

Peristiwa callback

Daftarkan callback dengan on(event, listener). Lihat peristiwa server untuk kolom lengkap.
PeristiwaPayloadDeskripsi
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 / errorDashScopeErrorKesalahan pemanggilan dengan code, message, dan identitas permintaan.
close{ code: number; reason: string }Notifikasi penutupan koneksi dasar.
eventServerEventPesan JSON layanan asli.