Skip to main content

Qwen-Audio-ASR-Message Node.js SDK

Use o SDK Node.js de voz para chamar Qwen-Audio-ASR-Message, processar resultados e atualizar o contexto durante a tarefa.

Instalar o SDK

Requer Node.js 18 ou posterior. Baixe o pacote SDK 0.1.0 e execute no projeto:
npm install ./dashscope-sdk-nodejs-0.1.0.tgz

Início rápido

Obtenha uma chave de API no console e defina-a na variável de ambiente DASHSCOPE_API_KEY. Baixe o áudio de exemplo como input.mp3 e converta para PCM mono de 16 kHz e 16 bits:
ffmpeg -i input.mp3 -f s16le -ac 1 -ar 16000 input.pcm
Salve o exemplo como example.mjs e execute 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-message',
  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()
}

Referência da API

Opções do construtor

Opções do construtor de RecognitionClient:
ParâmetroTipoObrigatórioDescrição
apiKeystringNãoChave de API. Usa DASHSCOPE_API_KEY por padrão.
workspaceIdstringNãoID do espaço de trabalho. Usa DASHSCOPE_WORKSPACE_ID por padrão.
baseUrlstringNãoDefina o hostname como dashscope-intl.aliyuncs.com (Singapura).
modelstringSimDefina o ID como qwen-audio-3.1-asr-flash-message.
format'pcm' | 'wav' | 'mp3' | 'opus' | 'speex' | 'aac' | 'amr'NãoFormato de áudio. Padrão: pcm. WAV usa PCM, Opus/Speex usam contêineres Ogg e AMR usa AMR-NB.
sampleRatenumberNãoTaxa de amostragem de áudio. Use 16000 Hz.
vocabularyIdstringNãoID do vocabulário pré-compilado.
languageHintsstring[]NãoDicas de idioma do reconhecimento. Até os primeiros 4 valores têm efeito. Detecção automática se omitidas.
disfluencyRemovalEnabledbooleanNãoRemove disfluências e aprimora o texto. Padrão: false.
maxSentenceSilencenumberNãoLimiar de silêncio para fim de frase no VAD, em ms: [200,6000]; padrão: 800.
heartbeatbooleanNãoKeepalive em silêncio. Padrão: false; continue enviando áudio silencioso quando ativado.
contextAsrContextMessage[]NãoContexto de reconhecimento. Formato: { role, content: [{ type: "input_text", text }] }, com role como user ou assistant. Até 5 mensagens por papel, menos de 400 caracteres no total, na ordem dos turnos.
parametersPartial<RecognitionParameters>NãoParâmetros adicionais, como vad_model, keep_dialect e vocabulary.
connectTimeoutMsnumberNãoTempo limite de conexão em ms. Padrão: 10000.
taskTimeoutMsnumberNãoTempo limite da confirmação de início/fim em ms. Padrão: 60000; 0 desativa.
parameters.vad_model'near_meeting_16k' | 'far_field_meeting_16k'NãoVAD de campo próximo ou distante. Padrão: far_field_meeting_16k.
parameters.keep_dialectbooleanNãoPreserva expressões de dialeto. Padrão: false.
parameters.vocabularyRecord<string, number>NãoVocabulário instantâneo: palavras como chaves e pesos em [1,5] ou 50 como valores.
parameters.speech_noise_thresholdnumberNãoLimiar de sensibilidade do VAD: [-1,1].
parameters.intermediate_result_enabledbooleanNãoRetorna resultados intermediários de reconhecimento. Padrão: false.

Métodos principais

MétodoRetornoDescrição
start()Promise<void>Inicia o reconhecimento; envie áudio após resolver.
sendAudio(audio: Buffer | Uint8Array)voidEnvia quadros de áudio no formato e amostragem configurados.
updateContext(context: AsrContextMessage[])voidAtualiza o contexto após o início e antes de encerrar a entrada.
finish()Promise<void>Encerra a entrada e aguarda a conclusão. O texto chega por callbacks.
close(code?: number, reason?: string)voidFecha a conexão e libera os recursos da tarefa.

Eventos de callback

Registre callbacks com on(event, listener). Consulte os campos completos em eventos do servidor.
EventoPayloadDescrição
started{ taskId: string }A tarefa iniciou e aceita entrada.
result{ text: string; sentence_end: boolean; sentence_begin?: boolean; words?: RecognitionWord[] }Frase intermediária ou final, excluindo resultados de heartbeat.
sentenceEnd{ text: string; sentence_end: boolean; sentence_begin?: boolean; words?: RecognitionWord[] }Frase final com sentence_end === true.
finished{ taskId: string; duration?: number; usage?: RecognitionUsage }A tarefa terminou e o estado local foi limpo.
failed / errorDashScopeErrorErro com code, message e identificadores da requisição.
close{ code: number; reason: string }Notificação de fechamento da conexão subjacente.
eventServerEventMensagem JSON original do serviço.