Utilisez le SDK Android de Qwen-Audio-Realtime pour les conversations vocales en temps réel, avec une entrée audio en temps réel et une sortie vocale ou textuelle.
Prérequis
- Obtenez et configurez une clé API. Ne codez pas en dur de clé API de longue durée dans votre application mobile. Nous vous recommandons de générer une clé API temporaire sur votre serveur d’application et de la transmettre au client.
Installer le SDK
- Téléchargez le dernier package du SDK.
- Extrayez le package ZIP. Obtenez le SDK AAR depuis
app/libset ajoutez-le aux dépendances de votre projet. Pour l'intégration C++ Android, utilisezandroid_libsetandroid_includedans le package ZIP pour obtenir les bibliothèques dynamiques et les fichiers d'en-tête.
Démarrage rapide
Ouvrez le projet dans Android Studio. Le code d'exemple se trouve dans DashQwenAudioChatActivity.java. Remplacez la clé API pour tester la fonctionnalité.
Procédure d'appel
- Initialiser le SDK.
- Définissez les paramètres pour votre cas d'utilisation. Utilisez l'argument
parametersde initialize pour définir les paramètres de connexion et de contrôle, et utilisez setParams pour définir les paramètres de conversation vocale. - Appelez startDialog pour démarrer la conversation.
- Dans onNuiAudioStateChanged, démarrez le périphérique d'enregistrement en fonction de l'état audio.
- Fournissez en continu des données d'enregistrement dans onNuiNeedAudioData, ou appelez updateAudio pour pousser activement les données d'enregistrement.
- Recevez en continu l'audio renvoyé par le modèle dans onNuiAssistEventCallback.
- Écoutez les événements et obtenez les informations d'événement dans onNuiEventCallback.
- Appelez stopDialog pour arrêter la conversation, et écoutez
EVENT_TRANSCRIBER_COMPLETEpour confirmer qu'elle est terminée. - Lorsque la fonctionnalité de conversation n'est plus nécessaire, appelez release pour libérer les ressources du SDK.
Paramètres de requête
Paramètres de connexion et de contrôle
Transmettez une chaîne JSON dans l'argument parameters de initialize.
Exemple : La chaîne JSON suivante ne répertorie pas tous les paramètres. Ajoutez les paramètres nécessaires pour votre cas d'utilisation.
L’exemple utilise qwen-audio-3.1-realtime-plus. Pour utiliser un autre modèle, mettez à jour à la fois model dans l’URL et nls_config.model dans Paramètres de conversation vocale.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
url | String | Oui | Point de terminaison du service :
{WorkspaceId} par votre véritable ID d'espace de travail. |
apikey | String | Oui | Clé API. |
service_mode | String | Oui | Mode d'exécution. Définissez ce paramètre sur "1" pour une conversation vocale en temps réel. |
device_id | String | Oui | Une chaîne unique qui identifie l'utilisateur final. Vous pouvez utiliser un identifiant d'utilisateur dans l'application ou un identifiant d'appareil généré par le client. Cet identifiant est principalement utilisé pour le suivi des journaux et le dépannage. |
audio_update_manually | String | Non | Indique s'il faut pousser activement les données audio. Valeur par défaut : "false". Si défini sur "true" et que le SDK prend en charge les capacités audio sur l'appareil telles que l'AEC et le VAD, ces capacités sont activées par défaut. |
workspace | String | Non | Le chemin de stockage des fichiers de ressources sur l'appareil. Ce paramètre est requis lorsque audio_update_manually est "true" et qu'une capacité audio sur l'appareil telle que l'AEC ou le VAD est activée. |
debug_path | String | Non | Le chemin de stockage du fichier journal. Ce paramètre prend effet uniquement lorsque save_log est true dans initialize. Dans ce cas, le chemin est requis. Le SDK conserve au maximum deux fichiers journaux localement. |
save_wav | String | Non | Indique s'il faut enregistrer l'audio de débogage sous debug_path. Valeur par défaut : "false". Les valeurs valides sont "true" et "false". Ce paramètre prend effet uniquement lorsque save_log est true, et debug_path doit également être défini. |
max_log_file_size | int | Non | Taille maximale du fichier journal en octets. Ce paramètre prend effet uniquement lorsque save_log est true. Valeur par défaut : 104857600 (100 × 1024 × 1024 octets, soit 100 Mio). |
log_track_level | int | Non | Le niveau de filtrage pour les journaux envoyés via onNuiLogTrackCallback. Valeur par défaut : 2. Valeurs valides : 0 (VERBOSE), 1 (DEBUG), 2 (INFO), 3 (WARNING), 4 (ERROR) et 5 (NONE). Un journal n'est renvoyé que lorsque son niveau est supérieur ou égal à la fois à log_track_level et au level transmis à initialize. Par exemple, si log_track_level est 2 (INFO) et que level est 3 (WARNING), seuls les journaux de niveau WARNING et supérieur (valeurs supérieures ou égales à 3) sont renvoyés. |
aec_params | object | Non | Configuration AEC avancée sur l'appareil. Cet objet prend effet uniquement lorsque audio_update_manually est "true". |
aec_params.enable_aec | boolean | Non | Indique s'il faut activer l'AEC sur l'appareil. Si audio_update_manually est "true" et que le SDK prend en charge l'AEC sur l'appareil, l'AEC est activé par défaut. |
aec_params.save_audio | boolean | Non | Indique s'il faut enregistrer l'audio traité par le module AEC sur l'appareil. Si save_wav est "true" et que debug_path est défini, cette fonctionnalité est activée par défaut et l'audio est enregistré sous debug_path. |
aec_params.enable_aec_data_callback | boolean | Non | Indique s'il faut renvoyer l'audio traité par l'AEC via EVENT_AEC_DATA dans onNuiAssistEventCallback. Valeur par défaut : false. |
vad_params | object | Non | Configuration VAD avancée sur l'appareil. Cet objet prend effet uniquement lorsque audio_update_manually est "true". |
vad_params.enable_vad | boolean | Non | Indique s'il faut activer le VAD sur l'appareil. Si audio_update_manually est "true" et que le SDK prend en charge le VAD sur l'appareil, le VAD est activé par défaut. |
vad_params.save_audio | boolean | Non | Indique s'il faut enregistrer l'audio traité par le module VAD sur l'appareil. Si save_wav est "true" et que debug_path est défini, cette fonctionnalité est activée par défaut et l'audio est enregistré sous debug_path. |
Paramètres de conversation vocale
Transmettez une chaîne JSON dans l'argument params de setParams.
Exemple : La chaîne JSON suivante ne répertorie pas tous les paramètres. Ajoutez les paramètres nécessaires pour votre cas d'utilisation.
| Paramètre de niveau supérieur | Type | Obligatoire | Description |
|---|---|---|---|
service_type | int | Oui | Type de service vocal. Définissez ce paramètre sur 4 pour une conversation vocale en temps réel. |
nls_config | object | Oui | Configuration principale de la conversation vocale, y compris la sélection du modèle et le comportement de la conversation. |
nls_config.model | string | Oui | Nom du modèle. Prend en charge les séries de modèles qwen-audio-3.1-realtime-plus, qwen-audio-3.0-realtime-plus et qwen-audio-3.0-realtime-flash. |
nls_config.sr_format | string | Oui | Format audio d'entrée. Seul pcm est pris en charge. Le format par défaut est 16 kHz, 16 bits, PCM mono. |
nls_config.modalities | string | Non | Une chaîne contenant un tableau de modalités de sortie. Valeurs valides :
|
nls_config.voice | string | Non | Voix TTS. La valeur par défaut est longanqian_v3.1 pour 3.1 Plus et longanqian pour 3.0 Plus/Flash. Ce paramètre ne peut être défini que dans le premier session.update ; les valeurs ultérieures sont ignorées. Voix système : longanqian, longanlingxin, longanlingxi, longanxiaoxin et longanlufeng. Vous pouvez également spécifier un voice_id cloné créé via l'API de clonage vocal. Consultez Configuration de la voix.3.1 Plus prend également en charge longanqian_v3.1, longanhuan_v3.1, longanlingxin_v3.1, longanfengyue_v3.1, xunanchuan_v3.1, beth_v3.1, betty_v3.1 et cally_v3.1. |
nls_config.enable_speech_emotion | boolean | Non | Indique s'il faut activer l'expression émotionnelle améliorée. Lorsqu'elle est activée, la voix de réponse présente des variations émotionnelles plus perceptibles. Valeur par défaut : true. Valeurs valides : true et false. |
nls_config.instructions | string | Non | Instructions système qui définissent le rôle du modèle, le style de réponse et les préférences comportementales pour l'ensemble de la session. |
nls_config.max_history_turns | int | Non | Nombre maximal de tours de questions-réponses historiques autorisés dans une requête. Valeurs valides : 1 à 50. Valeur par défaut : 20. |
nls_config.tools | string | Non | Une chaîne contenant un tableau de définitions d'outils d'appel de fonction. Après avoir configuré ce paramètre, le modèle décide s'il doit appeler un outil en fonction de l'entrée de l'utilisateur. Chaque définition utilise type (requis et fixé à function) et un objet function contenant name (requis), description (facultatif) et parameters (facultatif). Si une fonction n'a pas d'arguments, omettez parameters.Exemple : |
nls_config.turn_detection | string | Non | Une chaîne contenant un objet JSON pour la détection des tours de parole. S'il est omis, la session utilise le mode push-to-talk, dans lequel l'audio est validé et l'inférence est déclenchée manuellement. S'il est défini, le mode de conversation duplex est activé. |
nls_config.turn_detection.type | string | Non | Type de VAD. server_vad (par défaut) détecte les limites de la parole à partir des caractéristiques acoustiques et déclenche automatiquement l'inférence. smart_turn combine les signaux acoustiques et sémantiques ; les sons sans contenu sémantique, tels que les tics de langage, ne démarrent pas un tour de parole et n'interrompent pas la lecture du modèle. |
nls_config.turn_detection.threshold | float | Non | Sensibilité du VAD. Ce paramètre s'applique uniquement à server_vad et n'a aucun effet sur smart_turn. Des valeurs plus basses rendent le VAD plus sensible aux sons faibles et au bruit de fond ; des valeurs plus élevées nécessitent une parole plus claire et plus forte. Plage valide : [-1.0, 1.0]. Valeur par défaut : 0.5. |
nls_config.turn_detection.silence_duration_ms | int | Non | Durée minimale de silence après la parole, en millisecondes, avant que la réponse du modèle ne soit déclenchée. Ce paramètre s'applique uniquement à server_vad et n'a aucun effet sur smart_turn. Des valeurs plus basses réduisent la latence mais peuvent se déclencher lors de brèves pauses. Plage valide : [200, 6000]. Valeur par défaut : 800. Recommandé pour la conversation : 400 à 800. |
nls_config.turn_detection.voiceprint_audio_urls | string | Non | Une chaîne contenant un tableau d'URL d'audio préenregistré accessibles au public pour le locuteur cible. Ce paramètre s'applique uniquement à smart_turn. Dans les conversations duplex, il aide le modèle à se concentrer sur le locuteur cible et à ignorer les autres locuteurs et le bruit de fond. Jusqu'à cinq URL sont prises en charge. L'audio doit être au format PCM ou WAV à 16 kHz. |
Référence de l’API
NativeNui
initialize · Initialiser le SDK
Initialise une instance du SDK de conversation vocale. Le SDK est un singleton. Ne l'initialisez pas plus d'une fois avant d'appeler release.
Cette méthode est bloquante, appelez-la donc sur un thread non UI.
Signature de la méthode
Paramètre | Type | Description |
|---|---|---|
| L'implémentation de l'interface de rappel des événements et des données. | |
|
| Une chaîne JSON qui contient les paramètres d'authentification, de connexion et de débogage. Consultez Paramètres de connexion et de contrôle. |
|
| Contrôle le niveau d'impression des propres journaux du SDK. |
|
| Indique s'il faut enregistrer les journaux locaux. Si défini sur |
setParams
Définit les paramètres de conversation vocale au format JSON. Appelez cette méthode avant startDialog.
Signature de la méthode
Paramètre | Type | Description |
|---|---|---|
|
|
startDialog
Démarre la conversation.
Signature de la méthode
| Paramètre | Type | Description |
|---|---|---|
vad_mode | VadMode | Mode VAD. Fixé à VadMode.TYPE_P2T. |
dialog_params | String | Si apikey dans les paramètres de connexion et de contrôle est une clé API temporaire, mettez-la à jour ici après son expiration.Format JSON : |
stopDialog
Met fin à la conversation. Après avoir appelé cette méthode, le serveur renvoie le résultat final de la conversation et met fin à la tâche.
Signature de la méthode
cancelDialog
Met fin à la conversation immédiatement. Après avoir appelé cette méthode, la tâche se termine aussitôt sans attendre que le serveur renvoie le résultat final de la conversation.
Signature de la méthode
updateAction
Envoie une commande d'action de conversation pendant une interaction pour mettre à jour le comportement d'exécution, tel que le contexte de la conversation.
Signature de la méthode
| Paramètre | Type | Description |
|---|---|---|
params | String | Une chaîne JSON utilisée pour mettre à jour le comportement d'exécution, tel que le contexte de conversation. |
params.type | String | Définir sur "action". |
params.command | String | Commande d'exécution. Valeurs valides :
|
params.context | String | Mise à jour de la requête d'appel de fonction. Utilisé lorsque command est "function_call". |
params.context.type | String | Type d'événement. Ce paramètre est requis lorsque command est "function_call". conversation.item.create insère un élément de conversation pour le contexte historique, le texte supplémentaire ou le résultat d'un outil. Après avoir envoyé conversation.item.create, utilisez response.create pour déclencher une autre inférence. |
params.context.item | object | Obligatoire lorsque params.context.type est conversation.item.create. L'élément de conversation à créer. |
params.context.response | object | Facultatif lorsque params.context.type est response.create. Remplace les valeurs par défaut de la session pour cette inférence. S'il est omis, la configuration de session actuelle est utilisée. |
context.item :
| Paramètre | Type | Description |
|---|---|---|
id | String | Identifiant unique facultatif de l'élément de conversation. S'il est omis, le serveur en génère un. Une erreur est renvoyée si l'identifiant spécifié existe déjà. |
type | String | Type d'élément requis. Valeurs valides :
|
role | String | Obligatoire pour message. Valeurs valides : system, user et assistant. |
content | array | Obligatoire pour message. Chaque élément contient un type et le champ de données associé. system prend en charge input_text avec text ; user prend en charge input_text avec text et input_audio avec audio encodé en Base64 ; assistant prend en charge output_text avec text. |
call_id | String | Obligatoire pour function_call et function_call_output. L'identifiant unique qui associe une requête d'appel de fonction à son résultat. |
name | String | Obligatoire pour function_call. Le nom de la fonction à appeler. |
arguments | String | Obligatoire pour function_call. Arguments de la fonction sous forme de chaîne JSON. |
output | String | Obligatoire pour function_call_output. Résultat de l'exécution de l'outil sous forme de chaîne JSON. |
context.response :
| Paramètre | Type | Description |
|---|---|---|
modalities | array | Modalités de sortie. ["text"] renvoie uniquement du texte. ["audio", "text"] (par défaut) renvoie à la fois de l'audio et du texte. |
voice | string | Remplace la voix TTS pour cette inférence. |
updateAudio
Lorsque audio_update_manually est défini sur "true", appelez cette méthode pour pousser activement les données d'enregistrement au lieu de fournir les données via onNuiNeedAudioData.
Signature de la méthode
Paramètre | Type | Description |
|---|---|---|
|
| Les données audio à transmettre. |
|
| Le nombre d'octets de données audio à transmettre. |
|
| Ignorer ce paramètre. |
updateRefAudio
Lorsque audio_update_manually est défini sur "true" et que l'AEC sur l'appareil est activé, appelez cette méthode pour pousser l'audio lu par le lecteur en tant que signal de référence.
Signature de la méthode
Paramètre | Type | Description |
|---|---|---|
|
| Les données audio à transmettre. |
|
| Le nombre d'octets de données audio à transmettre. |
|
| Ignorer ce paramètre. |
release · Libérer les ressources du SDK
Libère toutes les ressources internes du SDK. Après avoir appelé cette méthode, l'instance du SDK devient indisponible. Pour l'utiliser à nouveau, vous devez la réinitialiser en appelant initialize.
Signature de la méthode
GetVersion
Obtient les informations de version actuelles du SDK.
Signature de la méthode
INativeNuiCallback : rappels de l'écouteur
onNuiEventCallback : écouter les informations d'événement
Signature de la méthode
Paramètre | Type | Description |
|---|---|---|
| L'événement de rappel. | |
|
| Valide uniquement lorsque l’événement |
|
| Un paramètre réservé. |
|
| Le résultat de la reconnaissance vocale. |
|
| La fonctionnalité de réveil vocal. Vous n'avez pas besoin d'utiliser ce paramètre. |
onNuiAudioStateChanged : écouter l'état audio
Le SDK utilise ce rappel pour vous notifier quand démarrer ou arrêter l'enregistrement.
Signature de la méthode
État | Description |
|---|---|
| L'interaction a démarré. Vous pouvez ouvrir le périphérique d'enregistrement et commencer l'enregistrement. |
| L'interaction s'est arrêtée. Vous pouvez arrêter l'enregistrement. |
| L'instance du SDK a été libérée. Vous pouvez fermer complètement le périphérique d'enregistrement. |
onNuiNeedAudioData : fournir des données audio
Une fois la conversation démarrée, ce rappel est déclenché en continu. Fournissez les données audio dans ce rappel. Vous n'avez pas besoin d'utiliser ce rappel lorsque audio_update_manually est défini sur "true".
Signature de la méthode
Paramètre | Type | Description |
|---|---|---|
|
| Les données audio à remplir. |
|
| Le nombre d'octets de données audio à remplir. |
onNuiAssistEventCallback : recevoir les événements et données auxiliaires
Ce rappel reçoit les événements auxiliaires et les données associées du SDK.
Signature de la méthode
Paramètre | Type | Description |
|---|---|---|
|
| Un événement |
|
| Ignorer ce paramètre. |
|
| Ignorer ce paramètre. |
|
| Données auxiliaires, telles que l'audio TTS renvoyé par le modèle. |
onNuiLogTrackCallback : écouter les journaux de trace
Ce rappel reçoit les journaux internes détaillés du SDK pour aider au dépannage et au débogage.
NuiEvent : types d'événements
| Événement | Description |
|---|---|
EVENT_TRANSCRIBER_STARTED | La tâche a démarré avec succès. |
EVENT_VAD_START | Déclenché immédiatement après le démarrage de la tâche. Cela ne signifie pas que le début de la parole a été détecté. |
EVENT_VAD_END | La fin de la parole a été détectée. |
EVENT_ASR_PARTIAL_RESULT | Un résultat intermédiaire de reconnaissance vocale. |
EVENT_ASR_ERROR | Une erreur s'est produite pendant la conversation vocale. |
EVENT_MIC_ERROR | Déclenché lorsqu'aucune donnée audio n'est reçue pendant deux secondes consécutives. |
EVENT_SENTENCE_END | La fin d'une phrase a été détectée et un résultat de reconnaissance complet a été renvoyé. |
EVENT_TRANSCRIBER_COMPLETE | La conversation vocale est terminée. |
EVENT_AUDIO_TRANSCRIPTION | Événement de transcription textuelle incrémentielle pour la sortie audio. Les segments de transcription sont renvoyés en mode streaming. |
EVENT_AUDIO_TRANSCRIPTION_COMPLETED | La transcription de la sortie audio est terminée. |
EVENT_OTHER_RESULT | Autres informations d'événement, telles qu'un résultat de Function Calling. |
EVENT_ASR_TTS_START | Le modèle a commencé à renvoyer l'audio TTS. |
EVENT_ASR_TTS_DATA | Audio TTS renvoyé par le modèle. |
EVENT_ASR_TTS_COMPLETE | Le modèle a terminé de renvoyer l'audio TTS. |
EVENT_AEC_DATA | Données audio traitées par l'AEC. |