Prérequis
Obtenez une clé API dans la console et définissez-la dans la variable d’environnement DASHSCOPE_API_KEY.
Installer le SDK
Nécessite Node.js 18 ou ultérieur. Téléchargez le SDK 0.1.0, puis exécutez dans votre projet :
Démarrage rapide
Utilisez les mêmes exemples pour les modèles ci-dessous. Remplacez l’ID de modèle à l’aide de ce tableau.
| Modèle | ID de modèle dans l’exemple |
|---|---|
| Qwen-Audio-ASR-Streaming | qwen-audio-3.1-asr-flash-streaming |
| Qwen-Audio-ASR-Message | qwen-audio-3.1-asr-flash-message |
input.mp3 et convertissez-le en PCM mono 16 kHz, 16 bits :
example.mjs, puis exécutez node example.mjs.
Paramètres de requête
Qwen-Audio-ASR-Streaming
Référence commune
Options du constructeur de RecognitionClient :
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
apiKey | string | Non | Clé API. Utilise DASHSCOPE_API_KEY par défaut. |
workspaceId | string | Non | ID de l’espace de travail. Utilise DASHSCOPE_WORKSPACE_ID par défaut. |
baseUrl | string | Non | Définissez l’hôte sur dashscope-intl.aliyuncs.com (Singapour). |
model | string | Non | ID du modèle. Par défaut : qwen-audio-3.1-asr-flash-streaming. |
format | 'pcm' | 'wav' | 'mp3' | 'opus' | 'speex' | 'aac' | 'amr' | Non | Format audio. Par défaut : pcm. WAV utilise PCM, Opus/Speex des conteneurs Ogg et AMR utilise AMR-NB. |
sampleRate | number | Non | Fréquence d’échantillonnage réelle en Hz. Par défaut : 16000. |
vocabularyId | string | Non | ID du vocabulaire précompilé. |
languageHints | string[] | Non | Indications de langue de reconnaissance. Les 4 premières valeurs au plus sont prises en compte. Détection automatique si omises. |
multiThresholdModeEnabled | boolean | Non | Mode multiseuil pour éviter les segments VAD trop longs. Par défaut : false. |
maxSentenceSilence | number | Non | Seuil de silence de fin de phrase VAD en ms : [200,6000] ; par défaut : 800. |
heartbeat | boolean | Non | Maintien de connexion silencieuse. Par défaut : false ; continuez à envoyer de l’audio silencieux si activé. |
context | AsrContextMessage[] | Non | Contexte de reconnaissance. Format : { role, content: [{ type: "input_text", text }] }, avec role valant user ou assistant. Au plus 5 messages par rôle et moins de 400 caractères au total, dans l’ordre des tours. |
parameters | Partial<RecognitionParameters> | Non | Paramètres supplémentaires, tels que vad_model, keep_dialect et vocabulary. |
connectTimeoutMs | number | Non | Délai de connexion en ms. Par défaut : 10000. |
taskTimeoutMs | number | Non | Délai de confirmation de début/fin en ms. Par défaut : 60000 ; 0 le désactive. |
parameters.vad_model | 'near_meeting_16k' | 'far_field_meeting_16k' | Non | VAD de champ proche ou lointain. Par défaut : far_field_meeting_16k. |
parameters.keep_dialect | boolean | Non | Conserve les expressions dialectales. Par défaut : false. |
parameters.vocabulary | Record<string, number> | Non | Vocabulaire instantané : mots en clés, poids dans [1,5] ou 50 en valeurs. |
parameters.speech_noise_threshold | number | Non | Seuil de sensibilité VAD : [-1,1]. |
Qwen-Audio-ASR-Message
Référence commune
Options du constructeur de RecognitionClient :
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
apiKey | string | Non | Clé API. Utilise DASHSCOPE_API_KEY par défaut. |
workspaceId | string | Non | ID de l’espace de travail. Utilise DASHSCOPE_WORKSPACE_ID par défaut. |
baseUrl | string | Non | Définissez l’hôte sur dashscope-intl.aliyuncs.com (Singapour). |
model | string | Oui | Définissez l’ID sur qwen-audio-3.1-asr-flash-message. |
format | 'pcm' | 'wav' | 'mp3' | 'opus' | 'speex' | 'aac' | 'amr' | Non | Format audio. Par défaut : pcm. WAV utilise PCM, Opus/Speex des conteneurs Ogg et AMR utilise AMR-NB. |
sampleRate | number | Non | Fréquence d’échantillonnage audio. Utilisez 16000 Hz. |
vocabularyId | string | Non | ID du vocabulaire précompilé. |
languageHints | string[] | Non | Indications de langue de reconnaissance. Les 4 premières valeurs au plus sont prises en compte. Détection automatique si omises. |
disfluencyRemovalEnabled | boolean | Non | Supprime les disfluences et améliore le texte. Par défaut : false. |
maxSentenceSilence | number | Non | Seuil de silence de fin de phrase VAD en ms : [200,6000] ; par défaut : 800. |
heartbeat | boolean | Non | Maintien de connexion silencieuse. Par défaut : false ; continuez à envoyer de l’audio silencieux si activé. |
context | AsrContextMessage[] | Non | Contexte de reconnaissance. Format : { role, content: [{ type: "input_text", text }] }, avec role valant user ou assistant. Au plus 5 messages par rôle et moins de 400 caractères au total, dans l’ordre des tours. |
parameters | Partial<RecognitionParameters> | Non | Paramètres supplémentaires, tels que vad_model, keep_dialect et vocabulary. |
connectTimeoutMs | number | Non | Délai de connexion en ms. Par défaut : 10000. |
taskTimeoutMs | number | Non | Délai de confirmation de début/fin en ms. Par défaut : 60000 ; 0 le désactive. |
parameters.vad_model | 'near_meeting_16k' | 'far_field_meeting_16k' | Non | VAD de champ proche ou lointain. Par défaut : far_field_meeting_16k. |
parameters.keep_dialect | boolean | Non | Conserve les expressions dialectales. Par défaut : false. |
parameters.vocabulary | Record<string, number> | Non | Vocabulaire instantané : mots en clés, poids dans [1,5] ou 50 en valeurs. |
parameters.speech_noise_threshold | number | Non | Seuil de sensibilité VAD : [-1,1]. |
parameters.intermediate_result_enabled | boolean | Non | Renvoie les résultats intermédiaires. Par défaut : false. |
Référence de l’API
Qwen-Audio-ASR-Streaming
Méthodes principales
| Méthode | Valeur de retour | Description |
|---|---|---|
start() | Promise<void> | Démarre la reconnaissance ; envoyez l’audio après résolution. |
sendAudio(audio: Buffer | Uint8Array) | void | Envoie les trames audio au format et à l’échantillonnage configurés. |
finish() | Promise<void> | Termine l’entrée et attend la fin. Le texte arrive via les callbacks. |
close(code?: number, reason?: string) | void | Ferme la connexion et libère les ressources de la tâche. |
Événements de callback
Enregistrez les callbacks avec on(event, listener). Consultez les champs complets dans les événements serveur.
| Événement | Charge utile | Description |
|---|---|---|
started | { taskId: string } | La tâche a démarré et accepte les entrées. |
result | { text: string; sentence_end: boolean; sentence_begin?: boolean; words?: RecognitionWord[] } | Phrase intermédiaire ou finale, hors résultats de heartbeat. |
sentenceEnd | { text: string; sentence_end: boolean; sentence_begin?: boolean; words?: RecognitionWord[] } | Phrase finale avec sentence_end === true. |
finished | { taskId: string; duration?: number; usage?: RecognitionUsage } | La tâche est terminée et l’état local effacé. |
failed / error | DashScopeError | Erreur avec code, message et identifiants de requête. |
close | { code: number; reason: string } | Notification de fermeture de la connexion sous-jacente. |
event | ServerEvent | Message JSON brut du service. |
Qwen-Audio-ASR-Message
Méthodes principales
| Méthode | Valeur de retour | Description |
|---|---|---|
start() | Promise<void> | Démarre la reconnaissance ; envoyez l’audio après résolution. |
sendAudio(audio: Buffer | Uint8Array) | void | Envoie les trames audio au format et à l’échantillonnage configurés. |
updateContext(context: AsrContextMessage[]) | void | Met à jour le contexte après démarrage et avant la fin de l’entrée. |
finish() | Promise<void> | Termine l’entrée et attend la fin. Le texte arrive via les callbacks. |
close(code?: number, reason?: string) | void | Ferme la connexion et libère les ressources de la tâche. |
Événements de callback
Enregistrez les callbacks avec on(event, listener). Consultez les champs complets dans les événements serveur.
| Événement | Charge utile | Description |
|---|---|---|
started | { taskId: string } | La tâche a démarré et accepte les entrées. |
result | { text: string; sentence_end: boolean; sentence_begin?: boolean; words?: RecognitionWord[] } | Phrase intermédiaire ou finale, hors résultats de heartbeat. |
sentenceEnd | { text: string; sentence_end: boolean; sentence_begin?: boolean; words?: RecognitionWord[] } | Phrase finale avec sentence_end === true. |
finished | { taskId: string; duration?: number; usage?: RecognitionUsage } | La tâche est terminée et l’état local effacé. |
failed / error | DashScopeError | Erreur avec code, message et identifiants de requête. |
close | { code: number; reason: string } | Notification de fermeture de la connexion sous-jacente. |
event | ServerEvent | Message JSON brut du service. |