Skip to main content

HarmonyOS SDK de reconocimiento de voz no en tiempo real (Fun-ASR-Flash)

El SDK de HarmonyOS para reconocimiento de voz no en tiempo real Fun-ASR-Flash convierte voz en texto.

Para formatos de audio admitidos, límites de tamaño de archivo, límites de duración y otros requisitos de entrada, consulte Especificaciones de audio.

Inicio rápido

  1. Obtener una clave API: Obtener una clave API. Por seguridad, recomendamos configurar la clave API en una variable de entorno.
  2. Descargue el SDK y ejecute el código de ejemplo:
    • Descargue el paquete más reciente del SDK.
    • Extraiga el archivo TAR. Obtenga el SDK en formato HAR de neonui y agréguelo a las dependencias de su proyecto. Para la integración con C++, utilice native/libs y native/include en el archivo TAR para obtener las bibliotecas dinámicas y los archivos de encabezado.
    • Abra el proyecto en DevEco Studio. El código de ejemplo se encuentra en DashFunAsrFlashFileTranscriberPage.ets. Reemplace la clave API para probar la función.

Procedimiento de llamada

Modo síncrono

  1. Inicializar el SDK
  2. Configure los parámetros según sus requisitos comerciales
  3. Llame a startFileTranscriber para enviar una solicitud de reconocimiento de voz no en tiempo real y esperar el resultado.
  4. Utilice onFileTransEventCallback para escuchar el evento EVENT_FILE_TRANS_RESULT y obtener el resultado final del reconocimiento.
  5. Llame a release para liberar los recursos del SDK

Parámetros de solicitud

Parámetros de conexión y control

Pase una cadena JSON al parámetro parameters del método initializeFileTrans para configurar estos ajustes. Ejemplo de parámetro: La siguiente cadena JSON es un ejemplo y no enumera todos los parámetros. Agregue parámetros según sea necesario en su código:
{
    "url": "wss://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation",
    "apikey": "st-****",
    "device_id": "my_device_id",
    "service_mode": "1"
}
Parámetros
ParámetroTipoObligatorioDescripción
urlstringSíEl punto de conexión del servicio. Establezca este parámetro en wss://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation. Reemplace {WorkspaceId} con su ID de espacio de trabajo real.
apikeystringSíLa clave API. Recomendamos utilizar una clave API temporal de corta duración y mayor seguridad para reducir el riesgo de exponer una clave de larga duración.
service_modestringSíEl modo de operación. Para el reconocimiento de voz no en tiempo real, establezca este parámetro en "1".
device_idstringSíUna cadena única que identifica al usuario final. Puede usar un ID de usuario dentro de la aplicación o un identificador de dispositivo único generado por el cliente. Este ID se utiliza principalmente para el rastreo de registros y la resolución de problemas.
debug_pathstringNoLa ruta para los archivos de registro. Este parámetro solo tiene efecto cuando llama a initializeFileTrans con save_log establecido en true. En este caso, debe especificar la ruta del archivo de registro. De lo contrario, se producirá un error. Se conservan hasta dos archivos de registro localmente.
max_log_file_sizenumberNoEl tamaño máximo del archivo de registro en bytes. Este parámetro solo tiene efecto cuando llama a initializeFileTrans con save_log establecido en true. Valor predeterminado: 104857600 (100 * 1024 * 1024 bytes, o 100 MiB).

Parámetros de reconocimiento

Utilice setParams para configurar los parámetros de nls_config, o utilice startFileTranscriber para configurar todos los parámetros de reconocimiento. Ejemplo de parámetro: La siguiente cadena JSON es un ejemplo y no enumera todos los parámetros. Agregue parámetros según sea necesario en su código:
{
  "apikey": "st-****",
  "messages": [
    {
      "content": [
        {
          "input_audio": {
            "data": "{YOUR_AUDIO_URL}"
          },
          "type": "input_audio"
        }
      ],
      "role": "user"
    }
  ],
  "nls_config": {
    "format": "mp3",
    "model": "fun-asr-flash-2026-06-15"
  }
}
Parámetros
ParámetroTipoObligatorioDescripción
apikeystringNoSi Parámetros de conexión y control apikey utiliza una clave API temporal, puede actualizarla aquí para evitar su caducidad.
nls_configobjectSíEl objeto de configuración principal de reconocimiento de voz, que incluye el modelo y los parámetros que controlan el reconocimiento.
nls_config.modelstringSíEl nombre del modelo.
nls_config.formatstringSíEl formato de audio. Establezca este parámetro en el formato real. Los formatos admitidos incluyen wav, mp3, opus. Para más detalles, consulte Especificaciones de audio.
nls_config.sample_ratestringNoLa frecuencia de muestreo de audio en Hz. Por ejemplo, 16000 indica una frecuencia de muestreo de 16 kHz. Para más detalles, consulte Especificaciones de audio.
nls_config.vocabulary_idstringNoEl ID de vocabulario precompilado. Cree un vocabulario con antelación y pase su ID durante el reconocimiento para usar sus palabras clave. Use esta opción cuando el vocabulario es conocido, relativamente estable y se reutiliza en varias solicitudes. Para instrucciones de uso, consulte Palabras clave precompiladas.
nls_config.language_hintsarray[string]NoLos códigos de idioma que se reconocerán. Si desconoce el idioma, omita este parámetro para que el modelo lo detecte automáticamente. Puede especificar hasta 1 valor. Si especifica más, solo los primeros 1 tendrán efecto.
  • zh: Chino
  • en: Inglés
  • ja: Japonés
  • ko: Coreano
  • vi: Vietnamita
  • th: Tailandés
  • id: Indonesio
  • ms: Malayo
  • tl: Filipino
  • hi: Hindi
  • ar: Árabe
  • fr: Francés
  • de: Alemán
  • es: Español
  • pt: Portugués
  • ru: Ruso
  • it: Italiano
  • nl: Neerlandés
  • sv: Sueco
  • da: Danés
  • fi: Finés
  • no: Noruego
  • el: Griego
  • pl: Polaco
  • cs: Checo
  • hu: Húngaro
  • ro: Rumano
  • bg: Búlgaro
  • hr: Croata
  • sk: Eslovaco
messagesarray[object]SíLa lista de mensajes. Contiene el audio a reconocer y el contexto de conversación opcional para mejorar el reconocimiento.Consulte las siguientes descripciones.
parámetros de messages:
El contexto mejora la precisión del reconocimiento de términos especializados. Para instrucciones de uso, consulte Mejora de contexto.Los mensajes de contexto (tipos input_text y text) están limitados a cinco cada uno. Si se supera el límite, solo se conservan los cinco mensajes más recientes. La longitud total del texto de contexto por turno (la suma de las longitudes de los campos user y assistant text) no debe exceder los 400 caracteres. Cada carácter cuenta como uno. Los caracteres excedentes se truncan desde el final.
Cuando se incluye contexto, los mensajes de messages deben seguir un orden específico. Organice los mensajes de contexto por turno de conversación. Dentro de cada turno, user (tipo input_text) debe preceder al assistant correspondiente (tipo text). El mensaje input_audio user que contiene el audio de entrada debe colocarse al final de messages.
ParámetroTipoObligatorioDescripción
rolestringSíEl rol del mensaje. Valores válidos:
  • user (requerido): Un mensaje de usuario. Cuando type es input_audio, representa el audio a reconocer. Cuando type es input_text, representa resultados de reconocimiento de turnos anteriores o un vocabulario específico del dominio (contexto opcional).
  • assistant (contexto opcional): Respuestas del modelo de lenguaje grande de turnos anteriores.
contentarray[object]SíLa lista de contenido de mensajes. Consulte las siguientes descripciones.
parámetros de content:
ParámetroTipoObligatorioDescripción
typestringSíEl tipo de contenido. Cada solicitud requiere al menos un mensaje input_audio . Valores válidos:
  • input_audio (requerido): La entrada de audio a reconocer (el rol es user). También debe proporcionar el objeto input_audio.
  • input_text (contexto opcional): Resultados de reconocimiento del habla del usuario de turnos anteriores o un vocabulario específico del dominio (el rol es user). También debe proporcionar el campo text.
  • text (contexto opcional): Respuestas del modelo de lenguaje grande de turnos anteriores (el rol es assistant). También debe proporcionar el campo text.
input_audioobjectNoRequerido cuando type es input_audio.
input_audio.datastringSíLos datos de audio a reconocer. Para formatos de audio admitidos, límites de tamaño de archivo, límites de duración y otros requisitos de entrada, consulte Especificaciones de audio. Se admiten los siguientes dos métodos de entrada:
  • URL del archivo de audio: Pase una URL de archivo de audio accesible públicamente.
  • URI de datos Base64: Pase audio codificado en Base64 como un URI de datos. Concatene el prefijo data:{MIME_TYPE};base64, con los datos de audio codificados en Base64. Los tipos MIME admitidos incluyen audio/wav, audio/mp3.Ejemplo (URL): https://example.com/audio/sample.wavEjemplo (Base64): data:audio/wav;base64,{BASE64_ENCODED_DATA}
textstringNoObligatorio cuando type es input_text, proporcione resultados de reconocimiento del habla del usuario de turnos anteriores o un vocabulario específico del dominio. Cuando type es text, proporcione respuestas del modelo de lenguaje grande de turnos anteriores. La longitud del texto se cuenta en caracteres, y cada carácter cuenta como uno. La longitud total de todos los campos text de los mensajes en cada turno de contexto no debe exceder los 400 caracteres. Los caracteres excedentes se truncan desde el final.

Interfaces clave

NativeNui

initializeFileTrans

Inicialice la instancia del SDK de reconocimiento de voz.
A diferencia del reconocimiento de voz en tiempo real, la transcripción no en tiempo real (de archivos grabados) requiere initializeFileTrans con una devolución de llamada INativeFileTransCallback en lugar de initialize.
Este método es bloqueante. Llámelo desde un hilo que no sea de UI. Firma del método
public initializeFileTrans(callback: INativeFileTransCallback,
                           parameters: string,
                           level: number,
                           save_log: boolean = false): number
Parámetros
ParámetroTipoDescripción
callbackINativeFileTransCallbackLa implementación de la interfaz de devolución de llamada de eventos y datos de transcripción de archivos.
parametersstringUna cadena JSON que contiene parámetros de autenticación, conexión y depuración. Consulte Parámetros de conexión y control.
levelnumberEl nivel de registro del SDK. Utilice un valor de la enumeración.
save_logbooleanIndica si se deben guardar los registros localmente. Si se establece en true, use Parámetros de conexión y control para establecer debug_path y especificar la ruta, y use max_log_file_size para establecer el tamaño del archivo.

setParams

Utilice este método para establecer o actualizar nls_config por separado. No es necesario llamar a este método si todos los parámetros se proporcionan en startFileTranscriber en una sola llamada. Firma del método
public setParams(params: string): number
Parámetros
ParámetroTipoDescripción
paramsstringParámetros de reconocimiento en los parámetros de nls_config; los parámetros fuera de nls_config no se pueden establecer con este método.

startFileTranscriber

Iniciar el reconocimiento. Firma del método
public startFileTranscriber(params: string, task_id: ArrayBuffer): number
Parámetros
ParámetroTipoDescripción
paramsstringParámetros de reconocimiento.Ejemplo:
{
 "apikey": "st-****",
 "messages": [
 {
 "content": [
 {
 "input_audio": {
 "data": "{YOUR_AUDIO_URL}"
 },
 "type": "input_audio"
 }
 ],
 "role": "user"
 }
 ],
 "nls_config": {
 "format": "mp3",
 "model": "fun-asr-flash-2026-06-15"
 }
}
task_idArrayBufferEl búfer de ID de tarea. El SDK escribe una cadena de ID de tarea aleatoria generada internamente en este búfer. Su longitud en bytes debe ser >= 33 bytes (el ejemplo utiliza new ArrayBuffer(64)). Después de una llamada exitosa, decodifique el búfer para obtener el task_id de la tarea.

queryFileTranscriber

Utilice este método para consultar el estado actual y el resultado de una tarea asíncrona. Después de una llamada exitosa, el resultado se devuelve a través del evento EVENT_FILE_TRANS_QUERY_RESULT de la devolución de llamada onFileTransEventCallback. Firma del método
public queryFileTranscriber(task_id: string): number
Parámetros
ParámetroTipoDescripción
task_idstringEl ID de la tarea a consultar (escrito en el búfer por startFileTranscriber).

cancelFileTranscriber

Cancelar inmediatamente la tarea actual. Firma del método
public cancelFileTranscriber(task_id: string): number
Parámetros
ParámetroTipoDescripción
task_idstringEl ID de la tarea a cancelar.

release

Libere todos los recursos internos del SDK. Después de esta llamada, la instancia del SDK deja de estar disponible. Para volver a utilizarla, llame a initializeFileTrans para inicializarla nuevamente. Firma del método
public release(): number

GetVersion

Obtener la versión actual del SDK. Firma del método
public GetVersion(): string
Valor de retorno La versión actual del SDK.

INativeFileTransCallback: Callbacks

onFileTransEventCallback: Escuchar eventos y resultados de reconocimiento

Firma del método
onFileTransEventCallback: (event: Constants.NuiEvent, resultCode: number, finish: number,
                           asrResult: AsrResult, taskId: string) => void;
Parámetros
ParámetroTipoDescripción
eventConstants.NuiEventEl evento de devolución de llamada.
resultCodenumberVálido solo cuando ocurre el evento EVENT_ASR_ERROR.
finishnumberIndica si la tarea ha finalizado.
asrResultAsrResultEl resultado del reconocimiento de voz.
taskIdstringEl ID de la tarea.

onFileTransLogTrackCallback: Escuchar registros de rastreo

Este callback recibe registros internos detallados del SDK para resolución de problemas y depuración. Para utilizar esta devolución de llamada, descargue el paquete del SDK de HarmonyOS con fecha 20260908 o posterior.
onFileTransLogTrackCallback?: (level: Constants.LogLevel, log: string) => void;

Tipos de eventos

En el SDK de HarmonyOS, los tipos de eventos se definen mediante la enumeración Constants.NuiEvent. Los siguientes eventos están relacionados con la transcripción de archivos grabados:
EventoDescripción
EVENT_FILE_TRANS_CONNECTEDConectado correctamente al servicio.
EVENT_FILE_TRANS_UPLOADEDEl archivo de audio se cargó correctamente.
EVENT_FILE_TRANS_QUERY_RESULTEl resultado de la consulta de la tarea.
EVENT_FILE_TRANS_RESULTEl resultado final del reconocimiento.
EVENT_ASR_ERROROcurrió un error durante el reconocimiento de voz.