Skip to main content

SDK iOS de reconnaissance vocale non temps réel Fun-ASR

Ce guide vous présente le SDK iOS de reconnaissance vocale non temps réel Fun-ASR, afin que vous puissiez convertir l'audio en texte.

Pour les exigences d'entrée telles que les formats audio pris en charge, les limites de taille de fichier et les limites de durée, consultez Spécifications audio.

Démarrage rapide

  1. Obtenir une clé API :Obtenir une clé API
  2. Téléchargez le SDK et exécutez l'exemple de code :
    • Télécharger le dernier bundle SDK.
    • Décompressez le package ZIP et ajoutez le nuisdk.framework inclus à votre projet.
    • Sous Build Phases → Link Binary With Libraries, ajoutez nuisdk.xcframework.
    • Sous General → Frameworks, Libraries, and Embedded Content, définissez nuisdk.xcframework sur Embed & Sign.
    • Ouvrez le projet d'exemple dans Xcode. Le code d'exemple se trouve dans DashFunAsrFileTranscriberViewController.m. Remplacez la API Key pour tester la fonctionnalité.

Étapes d'appel

  • Mode synchrone
  • Mode asynchrone
  1. Initialiser le SDK.
  2. Configurez les paramètres pertinents pour votre cas d'utilisation.
  3. Définissez async_request sur false et appelez nui_file_trans_start pour soumettre une requête de reconnaissance vocale non temps réel et attendre le résultat.
  4. Dans le rappel onFileTransEventCallback, écoutez l'événement EVENT_FILE_TRANS_RESULT pour obtenir le résultat final de la reconnaissance.
  5. Appelez nui_release pour libérer les ressources du SDK.

Paramètres de requête

Paramètres de connexion et de contrôle

Configurez ces paramètres en transmettant une chaîne JSON dans l'argument parameters de l'interface nui_initialize. Exemples de paramètres Ce qui suit est un exemple de chaîne JSON. Tous les paramètres ne sont pas répertoriés. Ajoutez ceux dont vous avez besoin lors de l'écriture de votre code :
{
    "url": "wss://dashscope.aliyuncs.com/api/v1/services/audio/asr/transcription",
    "apikey": "st-****",
    "device_id": "my_device_id",
    "service_mode": "1"
}
Descriptions des paramètres
ParamètreTypeObligatoireDescription
urlStringOuiPoints de terminaison de service :
  • wss://dashscope.aliyuncs.com/api/v1/services/audio/asr/transcription
  • Chine (Pékin) : wss://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/audio/asr/transcription
  • Singapour : wss://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/transcription
Remplacez {WorkspaceId} par votre véritable ID d'espace de travail.
apikeyStringOuiLa clé API.
service_modeStringOuiLe mode d'exécution. Fixé à "1" pour la reconnaissance vocale non temps réel.
device_idStringOuiUne chaîne unique qui identifie l'utilisateur final. Définissez-la sur 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.
debug_pathStringNonLe chemin de stockage du fichier journal.Ce paramètre prend effet uniquement lorsque save_log est défini sur YES lors de l'appel de l'interface nui_initialize. Dans ce cas, vous devez définir le chemin du fichier journal ; sinon, une erreur est renvoyée.Un maximum de deux fichiers journaux sont conservés localement.
max_log_file_sizeintNonLa taille maximale du fichier journal, en octets.Ce paramètre prend effet uniquement lorsque save_log est défini sur YES lors de l'appel de l'interface nui_initialize.Valeur par défaut : 104857600 (100 * 1024 * 1024 octets, soit 100 Mio).
log_track_levelintNonContrôle le niveau de filtrage du contenu des journaux envoyé via le rappel de journal (onFileTransLogTrackCallback).Valeur par défaut : 2.Valeurs valides :
  • 0: LOG_LEVEL_VERBOSE
  • 1: LOG_LEVEL_DEBUG
  • 2: LOG_LEVEL_INFO
  • 3: LOG_LEVEL_WARNING
  • 4: LOG_LEVEL_ERROR
  • 5 : LOG_LEVEL_NONE (désactive cette fonctionnalité)
Remarque : log_track_level et level (définis via l'interface nui_initialize) déterminent ensemble quels journaux sont finalement envoyés au rappel. La valeur de niveau d'un journal doit être supérieure ou égale à la fois à log_track_level et level avant d'être envoyée au rappel. Par exemple, si log_track_level est défini sur 2 (INFO) et level sur 3 (WARNING), seuls les journaux de niveau WARNING ou supérieur (valeur >= 3) sont envoyés au rappel.

Paramètres d'effet de reconnaissance vocale

Configurez tous les paramètres de reconnaissance vocale via l'interface nui_file_trans_start. Exemples de paramètres Ce qui suit est un exemple de chaîne JSON. Tous les paramètres ne sont pas répertoriés. Ajoutez ceux dont vous avez besoin lors de l'écriture de votre code :
{
    "apikey": "st-****",
    "file_urls": [
        "{YOUR_AUDIO_URL}"
    ],
    "async_request": false,
    "nls_config": {
        "model":"fun-asr",
        "diarization_enabled": false
    }
}
Descriptions des paramètres
ParamètreTypeObligatoireDescription
file_urlsarray[string]OuiUne liste d'URL des fichiers audio ou vidéo à transcrire. HTTP et HTTPS sont pris en charge. Une seule requête ne prend en charge qu'une seule URL. Pour les exigences d'entrée telles que les formats audio pris en charge, les limites de taille de fichier et les limites de durée, consultez Spécifications audio.Si l'enregistrement est stocké dans Alibaba Cloud OSS, l'API RESTful prend en charge les URL temporaires préfixées par oss://, tandis que le SDK ne prend pas en charge les URL temporaires préfixées par oss://.
  • Une URL temporaire est valide pendant 48 heures et ne peut pas être utilisée après son expiration. Ne l'utilisez pas en production.
  • L'interface d'identification de téléchargement est limitée à 100 QPS et ne peut pas être mise à l'échelle. Ne l'utilisez pas en production, dans des scénarios à forte concurrence ou lors de tests de charge.
  • Pour la production, utilisez un stockage stable tel que Alibaba Cloud OSS pour maintenir la disponibilité des fichiers à long terme et éviter la limitation du débit.
  • Si l'URL d'un fichier audio définie sur une URL publique temporaire OSS est inaccessible, définissez X-DashScope-OssResourceResolve sur enable dans l'en-tête de la requête (non recommandé). Le SDK ne prend pas en charge la configuration des en-têtes de requête.
async_requestbooleanNonIndique si la requête de reconnaissance vocale est asynchrone.Valeur par défaut : false.Valeurs valides :
  • true : requête asynchrone
  • false : requête synchrone
apikeystringNonSi la apikey dans Paramètres de connexion et de contrôle est une clé API temporaire, vous pouvez la mettre à jour ici pour éviter qu'elle n'expire.
nls_configobjectOuiL'objet de configuration principal de la reconnaissance vocale. Il contient des paramètres clés tels que la sélection du modèle et les contrôles d'effet de reconnaissance.
nls_config.modelstringOuiLe nom du modèle.
nls_config.special_word_filterobjectNonLes mots sensibles à traiter lors de la reconnaissance vocale. Vous pouvez définir une méthode de traitement différente pour chaque mot sensible. Pour plus de détails, consultez Filtrage des mots sensibles.
nls_config.channel_idarray[integer]NonL'index des pistes audio à reconnaître dans un fichier audio multipiste. L'index commence à 0. Par exemple, [0] reconnaît la première piste, et [0, 1] reconnaît la première et la deuxième piste en même temps. Si vous omettez ce paramètre, seule la première piste est traitée.
Chaque piste spécifiée est facturée indépendamment. Par exemple, demander [0, 1] pour un seul fichier entraîne deux frais distincts.
Valeur par défaut : [0].
nls_config.diarization_enabledbooleanNonIndique s'il faut activer la diarisation des locuteurs. Désactivé par défaut.S'applique uniquement à l'audio mono. L'audio multicanal ne prend pas en charge la diarisation des locuteurs.Lorsqu'elle est activée, le résultat de la reconnaissance inclut un champ speaker_id qui distingue les différents locuteurs.
Lorsque la diarisation des locuteurs est activée, maintenez la durée de l'audio dans la limite de 2 heures. Sinon, la reconnaissance peut échouer ou expirer.
Valeur par défaut : false.Pour un exemple de speaker_id, consultez la Description du résultat de la reconnaissance.
nls_config.speaker_countintegerNon
Prend effet uniquement lorsque la diarisation des locuteurs est activée (diarization_enabled est défini sur true).
Une valeur de référence pour le nombre de locuteurs. La plage valide est un entier de 2 à 100 (inclus).Par défaut, le nombre de locuteurs est détecté automatiquement. Si vous définissez cette valeur, elle guide uniquement l'algorithme pour qu'il produise le nombre spécifié lorsque cela est possible, sans garantir ce nombre exact.Aucune valeur par défaut.
nls_config.vocabulary_idstringNonL'ID d'une liste de mots clés précompilée.Générez cet ID à l'avance en appelant l'API de création de liste de mots clés. Transmettez l'ID lors de la reconnaissance pour utiliser les mots clés de la liste.Convient aux scénarios où le vocabulaire est connu et relativement stable, et où vous devez réutiliser la même liste de mots d'une requête à l'autre.Pour plus de détails sur l'utilisation, consultez Mots clés précompilés.
nls_config.instant_vocabularyobjectNonMots-clés instantanés. Transmettez des paires clé-valeur dont les clés sont les mots-clés (string) et les valeurs sont des poids entiers (integer). Aucune liste précompilée n’est nécessaire.Pour leur utilisation, consultez Mots-clés instantanés.
{
  "张三": 5,
  "李四": 5
}
nls_config.language_hintsarray[string]NonLes codes de langue à reconnaître. Si vous ne pouvez pas déterminer la langue à l'avance, laissez-le non défini et le modèle détectera la langue automatiquement.Vous pouvez définir jusqu’à 1 valeur. Au-delà, seules les 1 premières sont prises en compte.
  • zh : Chinois
  • en : Anglais
  • ja : Japonais
  • ko : Coréen
  • vi : Vietnamien
  • th : Thaï
  • id : Indonésien
  • ms : Malais
  • tl : Philippin
  • hi : Hindi
  • ar : Arabe
  • fr : Français
  • de : Allemand
  • es : Espagnol
  • pt : Portugais
  • ru : Russe
  • it : Italien
  • nl : Néerlandais
  • sv : Suédois
  • da : Danois
  • fi : Finnois
  • no : Norvégien
  • el : Grec
  • pl : Polonais
  • cs : Tchèque
  • hu : Hongrois
  • ro : Roumain
  • bg : Bulgare
  • hr : Croate
  • sk : Slovaque

Interfaces clés

NeoNui

nui_initialize

Initialise l'instance du SDK de reconnaissance vocale. Le SDK est un singleton. Ne l'initialisez pas à nouveau avant d'appeler nui_release. Signature de la méthode
-(NuiResultCode) nui_initialize:(const char *)parameters
                       logLevel:(NuiSdkLogLevel)level
                        saveLog:(BOOL)save_log;
Descriptions des paramètres
ParamètreTypeDescription
parameterschar*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.
levelNuiSdkLogLevelContrôle le niveau d'impression des propres journaux du SDK.
save_logBOOLIndique s'il faut enregistrer les journaux localement. Si défini sur YES, vous devez spécifier un chemin via debug_path dans Paramètres de connexion et de contrôle, et vous pouvez définir la taille du fichier via max_log_file_size.

nui_set_params

Utilisez cette interface pour définir ou mettre à jour le paramètre nls_config de manière indépendante. Si vous fournissez tous les paramètres à la fois dans nui_file_trans_start, vous n'avez pas besoin d'appeler cette méthode. Signature de la méthode
-(NuiResultCode) nui_set_params:(const char *)params;
Descriptions des paramètres
ParamètreTypeDescription
paramschar*Le paramètre nls_config dans Paramètres d'effet de reconnaissance vocale. Les paramètres autres que nls_config ne peuvent pas être définis via cette méthode.Exemple :
{
    "nls_config": {
        "model":"fun-asr",
        "diarization_enabled": false
    }
}

nui_file_trans_start

Démarre la reconnaissance. Signature de la méthode
-(NuiResultCode) nui_file_trans_start:(const char *)params
                               taskId:(char *)task_id;
Descriptions des paramètres
ParamètreTypeDescription
paramschar*Paramètres d'effet de reconnaissance vocale.Exemple :
{
    "file_urls": [
        "{YOUR_AUDIO_URL}"
    ],
    "async_request": false,
    "nls_config": {
        "model":"fun-asr",
        "diarization_enabled": false
    }
}
task_idchar*L'identifiant de la tâche. Le SDK génère une chaîne aléatoire en interne et renvoie le task_id lorsque cette interface est appelée avec succès.

nui_file_trans_query

Utilisez cette interface pour interroger activement l'état et le résultat actuels d'une tâche asynchrone. Après un appel réussi, le résultat est renvoyé via l'événement EVENT_FILE_TRANS_QUERY_RESULT dans le rappel onFileTransEventCallback.
Obtenez l'task_id transmis à cette méthode à partir de l'événement EVENT_FILE_TRANS_UPLOADED.
Signature de la méthode
-(NuiResultCode) nui_file_trans_query:(const char *)task_id;
Descriptions des paramètres
ParamètreTypeDescription
task_idchar*L'ID de la tâche à interroger, obtenu à partir de l'événement EVENT_FILE_TRANS_UPLOADED.

nui_file_trans_cancel

Annule immédiatement la tâche en cours. Signature de la méthode
-(NuiResultCode) nui_file_trans_cancel:(const char *)task_id;
Descriptions des paramètres
ParamètreTypeDescription
task_idchar*L'ID de la tâche à annuler, obtenu à partir de l'événement EVENT_FILE_TRANS_UPLOADED.

nui_release

Libère toutes les ressources internes du SDK et termine de force toutes les tâches en cours. Après avoir appelé cette méthode, l'instance du SDK devient indisponible. Pour la réutiliser, vous devez appeler à nouveau nui_initialize pour l'initialiser. Signature de la méthode
-(NuiResultCode) nui_release;

nui_get_version

Obtient les informations de version actuelles du SDK. Signature de la méthode
-(const char*) nui_get_version;
Valeur de retour Les informations de version actuelles du SDK.

NeoNuiSdkDelegate : surveiller les rappels

onFileTransEventCallback : surveiller les événements et les résultats de reconnaissance vocale

Signature de la méthode
-(void) onFileTransEventCallback:(NuiCallbackEvent)nuiEvent
                       asrResult:(const char *)asr_result
                          taskId:(const char *)task_id
                        ifFinish:(BOOL)finish
                         retCode:(int)code;
Descriptions des paramètres
ParamètreTypeDescription
nuiEventNuiCallbackEventL'événement de rappel.
asr_resultchar*Le résultat de la reconnaissance vocale.
task_idchar*L'ID de la tâche.
finishBOOLIndique si ce tour de reconnaissance est terminé.
codeintValide uniquement lorsque l’événement EVENT_ASR_ERROR se produit.

onFileTransLogTrackCallback : surveiller les journaux de trace

Utilisez ce rappel pour recevoir les journaux internes détaillés du SDK pour le dépannage et le débogage.
-(void)onFileTransLogTrackCallback:(NuiSdkLogLevel)level
                        logMessage:(const char *)log;

NuiCallbackEvent : types d'événements

ÉvénementDescription
EVENT_FILE_TRANS_CONNECTEDConnecté au service avec succès.
EVENT_FILE_TRANS_UPLOADEDLe fichier audio à reconnaître a été téléchargé avec succès. Vous pouvez maintenant obtenir l'task_id de la tâche en cours.
EVENT_FILE_TRANS_QUERY_RESULTLe résultat de la tâche de requête.
EVENT_FILE_TRANS_RESULTLe résultat final de la reconnaissance.
EVENT_ASR_ERRORUne erreur s'est produite lors de la reconnaissance vocale.