Le SDK iOS de reconnaissance vocale non temps réel Fun-ASR-Flash convertit la parole en texte.
Pour les formats audio pris en charge, les limites de taille de fichier, les limites de durée et les autres exigences d'entrée, consultez Spécifications audio.
Transmettez une chaîne JSON au paramètre
Paramètres
Utilisez
Paramètres
paramètres de messages :
paramètres de content :
Initialisez l'instance du SDK de reconnaissance vocale. Le SDK utilise un singleton. Ne l'initialisez pas à nouveau avant d'appeler
Paramètres
Utiliser cette méthode pour définir ou mettre à jour
Paramètres
Démarrer la reconnaissance.
Signature de la méthode
Paramètres
Cette fonctionnalité de reconnaissance vocale non temps réel ne prend en charge que les requêtes synchrones. Vous pouvez ignorer cette méthode.
Signature de la méthode
Paramètres
Annuler immédiatement la tâche en cours.
Signature de la méthode
Paramètres
Libérer toutes les ressources internes du SDK et arrêter de force toutes les tâches en cours. Après cet appel, l'instance du SDK devient indisponible. Pour la réutiliser, appeler
Obtenir la version actuelle du SDK.
Signature de la méthode
Valeur de retour
La version actuelle du SDK.
Signature de la méthode
Paramètres
Ce rappel reçoit les journaux internes détaillés du SDK pour le dépannage et le débogage.
Démarrage rapide
- Obtenir une clé API : Obtenir une clé API
- Téléchargez le SDK et exécutez l'exemple de code :
- Télécharger le dernier bundle SDK.
- Extrayez l'archive ZIP et ajoutez nuisdk.framework au projet.
- Ajoutez nuisdk.xcframework dans Build Phases → Link Binary With Libraries.
- Dans General → Frameworks, Libraries, and Embedded Content, définissez nuisdk.xcframework sur Embed & Sign.
- Ouvrir le projet d'exemple dans Xcode. Le code d'exemple se trouve dans
DashFunAsrFlashFileTranscriberViewController.m. Remplacer la clé API pour tester la fonctionnalité.
Procédure d'appel
Mode synchrone
- Initialiser le SDK
- Configurez les paramètres en fonction de vos besoins métier
-
Appelez
nui_file_trans_startpour envoyer une requête de reconnaissance vocale non temps réel. -
Utilisez
onFileTransEventCallbackpour écouter l'événementEVENT_FILE_TRANS_RESULTet obtenir le résultat final de la reconnaissance -
Appelez
nui_releasepour libérer les ressources du SDK
Paramètres de requête
Paramètres de connexion et de contrôle
Transmettez une chaîne JSON au paramètre parameters de la méthode nui_initialize pour configurer ces paramètres.
Exemple de paramètre : La chaîne JSON suivante est un exemple et ne répertorie pas tous les paramètres. Ajoutez les paramètres selon vos besoins dans votre code :
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
url | String | Oui | Points de terminaison du service :
{WorkspaceId} par votre ID d'espace de travail. |
apikey | String | Oui | Clé API. |
service_mode | String | Oui | Le mode de fonctionnement. Pour la reconnaissance vocale non temps réel, définissez ce paramètre sur "1". |
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 unique généré par le client. Cet identifiant est principalement utilisé pour le suivi des journaux et le dépannage. |
debug_path | String | Non | Le chemin d'accès aux fichiers journaux. Ce paramètre prend effet uniquement lorsque vous appelez nui_initialize avec save_log défini sur YES. Dans ce cas, vous devez spécifier le chemin du fichier journal. Sinon, une erreur se produit. Jusqu'à deux fichiers journaux sont conservés localement. |
max_log_file_size | int | Non | La taille maximale du fichier journal en octets. Ce paramètre prend effet uniquement lorsque vous appelez nui_initialize avec save_log défini sur YES. 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 le rappel de journalisation (onFileTransLogTrackCallback). Valeur par défaut : 2. Valeurs valides :
log_track_level et level (configurés via la méthode nui_initialize) déterminent conjointement quels journaux sont transmis. Le niveau numérique d'un journal doit être supérieur ou égal à la fois à log_track_level et à level pour que le journal soit transmis. Par exemple, si log_track_level est défini sur 2 (INFO) et level sur 3 (WARNING), seuls les journaux de niveau WARNING et de gravité supérieure (niveau numérique >= 3) sont transmis. |
Paramètres de reconnaissance
Utilisez nui_file_trans_start pour configurer tous les paramètres de reconnaissance.
Exemple de paramètre : La chaîne JSON suivante est un exemple et ne répertorie pas tous les paramètres. Ajoutez les paramètres selon vos besoins dans votre code :
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
apikey | string | Non | Si les paramètres de connexion et de contrôle apikey utilisent une clé API temporaire, vous pouvez la mettre à jour ici pour éviter son expiration. |
nls_config | object | Oui | L'objet de configuration principal de la reconnaissance vocale, incluant le modèle et les paramètres qui contrôlent la reconnaissance. |
nls_config.model | string | Oui | Le nom du modèle. |
nls_config.format | string | Oui | Le format audio. Définissez ce paramètre sur le format réel. Les formats pris en charge incluent wav, mp3, opus. Pour plus de détails, consultez les spécifications audio. |
nls_config.sample_rate | string | Non | Le taux d'échantillonnage audio en Hz. Par exemple, 16000 indique un taux d'échantillonnage de 16 kHz. Pour plus de détails, consultez les spécifications audio. |
nls_config.vocabulary_id | string | Non | L'identifiant du vocabulaire précompilé. Créez un vocabulaire à l'avance et transmettez son identifiant lors de la reconnaissance pour utiliser ses mots-clés. Utilisez cette option lorsque le vocabulaire est connu, relativement stable et réutilisé d'une requête à l'autre. Pour les instructions d'utilisation, consultez Mots-clés précompilés. |
nls_config.language_hints | array[string] | Non | Les codes des langues à reconnaître. Si la langue est inconnue, omettez ce paramètre pour que le modèle la détecte automatiquement. Vous pouvez définir jusqu’à 1 valeur. Au-delà, seules les 1 premières sont prises en compte.
Codes de langue pris en charge
|
messages | array[object] | Oui | La liste des messages. Elle contient l'audio à reconnaître et le contexte de conversation facultatif pour améliorer la reconnaissance.Consultez les descriptions suivantes. |
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
role | string | Oui | Le rôle du message. Valeurs valides :
|
content | array[object] | Oui | La liste du contenu des messages. Consultez les descriptions suivantes. |
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
type | string | Oui | Le type de contenu. Chaque requête nécessite au moins un input_audio message. Valeurs valides :
|
input_audio | object | Non | Requis lorsque type est input_audio. |
input_audio.data | string | Oui | Les données audio à reconnaître. Pour les formats audio pris en charge, les limites de taille de fichier, les limites de durée et les autres exigences d'entrée, consultez Spécifications audio. Les deux méthodes d'entrée suivantes sont prises en charge :
https://example.com/audio/sample.wavExemple (Base64) : data:audio/wav;base64,{BASE64_ENCODED_DATA} |
text | string | Non | Requis lorsque type est input_text, fournissez les résultats de reconnaissance de la parole de l'utilisateur des tours précédents ou un vocabulaire spécifique à un domaine. Lorsque type est text, fournissez les réponses du grand modèle de langage des tours précédents. La longueur du texte est comptée en caractères, chaque caractère comptant pour un. La longueur totale de tous les champs text des messages dans chaque tour de contexte ne doit pas dépasser 400 caractères. Les caractères excédentaires sont tronqués à partir de la fin. |
Interfaces clés
NeoNui
nui_initialize
Initialisez l'instance du SDK de reconnaissance vocale. Le SDK utilise un singleton. Ne l'initialisez pas à nouveau avant d'appeler nui_release .
Signature de la méthode
| Paramètre | Type | Description |
|---|---|---|
parameters | char* | Une chaîne JSON contenant les paramètres d'authentification, de connexion et de débogage. Consultez les paramètres de connexion et de contrôle. |
level | NuiSdkLogLevel | Le niveau des journaux imprimés par le SDK. |
save_log | BOOL | Indique s'il faut enregistrer les journaux localement. Si défini sur YES, utilisez les paramètres de connexion et de contrôle pour définir debug_path afin de spécifier le chemin, et utilisez max_log_file_size pour définir la taille du fichier. |
nui_set_params
Utiliser cette méthode pour définir ou mettre à jour nls_config séparément. Il n'est pas nécessaire d'appeler cette méthode si tous les paramètres sont fournis dans nui_file_trans_start en un seul appel.
Signature de la méthode
| Paramètre | Type | Description |
|---|---|---|
params | char* | Paramètres de reconnaissance dans nls_config et paramètres de messages.Exemple : |
nui_file_trans_start
Démarrer la reconnaissance.
Signature de la méthode
| Paramètre | Type | Description |
|---|---|---|
params | char* | Paramètres de reconnaissance. Exemple : |
task_id | char* | Vous pouvez ignorer ce paramètre et transmettre null. |
nui_file_trans_query
Cette fonctionnalité de reconnaissance vocale non temps réel ne prend en charge que les requêtes synchrones. Vous pouvez ignorer cette méthode.
Signature de la méthode
| Paramètre | Type | Description |
|---|---|---|
task_id | char* | L'identifiant de la tâche à interroger, obtenu à partir de EVENT_FILE_TRANS_UPLOADED. |
nui_file_trans_cancel
Annuler immédiatement la tâche en cours.
Signature de la méthode
| Paramètre | Type | Description |
|---|---|---|
task_id | char* | L'identifiant de la tâche à annuler, obtenu à partir de EVENT_FILE_TRANS_UPLOADED. |
nui_release
Libérer toutes les ressources internes du SDK et arrêter de force toutes les tâches en cours. Après cet appel, l'instance du SDK devient indisponible. Pour la réutiliser, appeler nui_initialize pour l'initialiser à nouveau.
Signature de la méthode
nui_get_version
Obtenir la version actuelle du SDK.
Signature de la méthode
NeoNuiSdkDelegate : Rappels
onFileTransEventCallback : Écouter les événements et les résultats de reconnaissance
Signature de la méthode
| Paramètre | Type | Description |
|---|---|---|
nuiEvent | NuiCallbackEvent | L'événement de rappel. |
asr_result | char* | Le résultat de la reconnaissance vocale. |
task_id | char* | L'ID de la tâche. |
finish | BOOL | Indique si la reconnaissance pour ce tour est terminée. |
code | int | Valide uniquement lorsque l’événement EVENT_ASR_ERROR se produit. |
onFileTransLogTrackCallback : Écouter les journaux de suivi
Ce rappel reçoit les journaux internes détaillés du SDK pour le dépannage et le débogage.
NuiCallbackEvent : Types d'événements
| Événement | Description |
|---|---|
EVENT_FILE_TRANS_CONNECTED | Connexion au service réussie. |
EVENT_FILE_TRANS_UPLOADED | Le fichier audio a été téléchargé avec succès. Vous pouvez obtenir le task_id actuel à ce stade. |
EVENT_FILE_TRANS_RESULT | Le résultat final de la reconnaissance. |
EVENT_ASR_ERROR | Une erreur s'est produite lors de la reconnaissance vocale. |