Requisitos previos
Obtenga una clave API en la consola y configúrela como variable de entorno DASHSCOPE_API_KEY.
Instalar el SDK
Requiere Node.js 18 o posterior. Descargue el paquete SDK 0.1.0 y ejecute en su proyecto:
Inicio rápido
Use los mismos ejemplos para los modelos indicados. Sustituya el ID del modelo según la tabla.
| Modelo | ID de modelo en el ejemplo |
|---|---|
| Qwen-Audio-ASR-Streaming | qwen-audio-3.1-asr-flash-streaming |
| Qwen-Audio-ASR-Message | qwen-audio-3.1-asr-flash-message |
input.mp3 y conviértalo a PCM mono de 16 kHz y 16 bits:
example.mjs y ejecute node example.mjs.
Parámetros de solicitud
Qwen-Audio-ASR-Streaming
Referencia común
Opciones del constructor de RecognitionClient:
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
apiKey | string | No | Clave API. Usa DASHSCOPE_API_KEY de forma predeterminada. |
workspaceId | string | No | ID del espacio de trabajo. Usa DASHSCOPE_WORKSPACE_ID de forma predeterminada. |
baseUrl | string | No | Establezca el host en dashscope-intl.aliyuncs.com (Singapur). |
model | string | No | ID del modelo. Predeterminado: qwen-audio-3.1-asr-flash-streaming. |
format | 'pcm' | 'wav' | 'mp3' | 'opus' | 'speex' | 'aac' | 'amr' | No | Formato de audio. Predeterminado: pcm. WAV usa PCM, Opus/Speex usan contenedores Ogg y AMR usa AMR-NB. |
sampleRate | number | No | Frecuencia de muestreo real en Hz. Predeterminado: 16000. |
vocabularyId | string | No | ID del vocabulario precompilado. |
languageHints | string[] | No | Indicaciones del idioma de reconocimiento. Se aplican como máximo los primeros 4 valores. Detección automática si se omiten. |
multiThresholdModeEnabled | boolean | No | Modo de múltiples umbrales para evitar segmentos VAD demasiado largos. Predeterminado: false. |
maxSentenceSilence | number | No | Umbral de silencio de fin de frase VAD en ms: [200,6000]; predeterminado: 800. |
heartbeat | boolean | No | Keepalive en silencio. Predeterminado: false; siga enviando audio silencioso si se activa. |
context | AsrContextMessage[] | No | Contexto de reconocimiento. Formato: { role, content: [{ type: "input_text", text }] }, con role igual a user o assistant. Hasta 5 mensajes por rol y menos de 400 caracteres en total, en orden de turnos. |
parameters | Partial<RecognitionParameters> | No | Parámetros adicionales, como vad_model, keep_dialect y vocabulary. |
connectTimeoutMs | number | No | Tiempo de conexión en ms. Predeterminado: 10000. |
taskTimeoutMs | number | No | Tiempo de confirmación de inicio/fin en ms. Predeterminado: 60000; 0 lo desactiva. |
parameters.vad_model | 'near_meeting_16k' | 'far_field_meeting_16k' | No | VAD de campo cercano o lejano. Predeterminado: far_field_meeting_16k. |
parameters.keep_dialect | boolean | No | Conserva expresiones dialectales. Predeterminado: false. |
parameters.vocabulary | Record<string, number> | No | Vocabulario instantáneo: palabras como claves y pesos en [1,5] o 50 como valores. |
parameters.speech_noise_threshold | number | No | Umbral de sensibilidad VAD: [-1,1]. |
Qwen-Audio-ASR-Message
Referencia común
Opciones del constructor de RecognitionClient:
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
apiKey | string | No | Clave API. Usa DASHSCOPE_API_KEY de forma predeterminada. |
workspaceId | string | No | ID del espacio de trabajo. Usa DASHSCOPE_WORKSPACE_ID de forma predeterminada. |
baseUrl | string | No | Establezca el host en dashscope-intl.aliyuncs.com (Singapur). |
model | string | Sí | Establezca el ID en qwen-audio-3.1-asr-flash-message. |
format | 'pcm' | 'wav' | 'mp3' | 'opus' | 'speex' | 'aac' | 'amr' | No | Formato de audio. Predeterminado: pcm. WAV usa PCM, Opus/Speex usan contenedores Ogg y AMR usa AMR-NB. |
sampleRate | number | No | Frecuencia de muestreo de audio. Use 16000 Hz. |
vocabularyId | string | No | ID del vocabulario precompilado. |
languageHints | string[] | No | Indicaciones del idioma de reconocimiento. Se aplican como máximo los primeros 4 valores. Detección automática si se omiten. |
disfluencyRemovalEnabled | boolean | No | Elimina disfluencias y mejora el texto. Predeterminado: false. |
maxSentenceSilence | number | No | Umbral de silencio de fin de frase VAD en ms: [200,6000]; predeterminado: 800. |
heartbeat | boolean | No | Keepalive en silencio. Predeterminado: false; siga enviando audio silencioso si se activa. |
context | AsrContextMessage[] | No | Contexto de reconocimiento. Formato: { role, content: [{ type: "input_text", text }] }, con role igual a user o assistant. Hasta 5 mensajes por rol y menos de 400 caracteres en total, en orden de turnos. |
parameters | Partial<RecognitionParameters> | No | Parámetros adicionales, como vad_model, keep_dialect y vocabulary. |
connectTimeoutMs | number | No | Tiempo de conexión en ms. Predeterminado: 10000. |
taskTimeoutMs | number | No | Tiempo de confirmación de inicio/fin en ms. Predeterminado: 60000; 0 lo desactiva. |
parameters.vad_model | 'near_meeting_16k' | 'far_field_meeting_16k' | No | VAD de campo cercano o lejano. Predeterminado: far_field_meeting_16k. |
parameters.keep_dialect | boolean | No | Conserva expresiones dialectales. Predeterminado: false. |
parameters.vocabulary | Record<string, number> | No | Vocabulario instantáneo: palabras como claves y pesos en [1,5] o 50 como valores. |
parameters.speech_noise_threshold | number | No | Umbral de sensibilidad VAD: [-1,1]. |
parameters.intermediate_result_enabled | boolean | No | Devuelve resultados intermedios de reconocimiento. Predeterminado: false. |
Referencia de la API
Qwen-Audio-ASR-Streaming
Métodos principales
| Método | Valor de retorno | Descripción |
|---|---|---|
start() | Promise<void> | Inicia el reconocimiento; envíe audio tras resolverse. |
sendAudio(audio: Buffer | Uint8Array) | void | Envía tramas de audio con el formato y la frecuencia configurados. |
finish() | Promise<void> | Termina la entrada y espera a la finalización. El texto llega por callbacks. |
close(code?: number, reason?: string) | void | Cierra la conexión y libera los recursos de la tarea. |
Eventos de callback
Registre callbacks con on(event, listener). Consulte los campos completos en eventos del servidor.
| Evento | Carga útil | Descripción |
|---|---|---|
started | { taskId: string } | La tarea ha comenzado y acepta entrada. |
result | { text: string; sentence_end: boolean; sentence_begin?: boolean; words?: RecognitionWord[] } | Frase intermedia o final, excluidos los resultados de heartbeat. |
sentenceEnd | { text: string; sentence_end: boolean; sentence_begin?: boolean; words?: RecognitionWord[] } | Frase final con sentence_end === true. |
finished | { taskId: string; duration?: number; usage?: RecognitionUsage } | La tarea ha terminado y el estado local se ha borrado. |
failed / error | DashScopeError | Error con code, message e identificadores de solicitud. |
close | { code: number; reason: string } | Notificación de cierre de la conexión subyacente. |
event | ServerEvent | Mensaje JSON original del servicio. |
Qwen-Audio-ASR-Message
Métodos principales
| Método | Valor de retorno | Descripción |
|---|---|---|
start() | Promise<void> | Inicia el reconocimiento; envíe audio tras resolverse. |
sendAudio(audio: Buffer | Uint8Array) | void | Envía tramas de audio con el formato y la frecuencia configurados. |
updateContext(context: AsrContextMessage[]) | void | Actualiza el contexto tras el inicio y antes de terminar la entrada. |
finish() | Promise<void> | Termina la entrada y espera a la finalización. El texto llega por callbacks. |
close(code?: number, reason?: string) | void | Cierra la conexión y libera los recursos de la tarea. |
Eventos de callback
Registre callbacks con on(event, listener). Consulte los campos completos en eventos del servidor.
| Evento | Carga útil | Descripción |
|---|---|---|
started | { taskId: string } | La tarea ha comenzado y acepta entrada. |
result | { text: string; sentence_end: boolean; sentence_begin?: boolean; words?: RecognitionWord[] } | Frase intermedia o final, excluidos los resultados de heartbeat. |
sentenceEnd | { text: string; sentence_end: boolean; sentence_begin?: boolean; words?: RecognitionWord[] } | Frase final con sentence_end === true. |
finished | { taskId: string; duration?: number; usage?: RecognitionUsage } | La tarea ha terminado y el estado local se ha borrado. |
failed / error | DashScopeError | Error con code, message e identificadores de solicitud. |
close | { code: number; reason: string } | Notificación de cierre de la conexión subyacente. |
event | ServerEvent | Mensaje JSON original del servicio. |