O SDK HarmonyOS de reconhecimento de fala não em tempo real Fun-ASR-Flash converte fala em texto.
Para formatos de áudio suportados, limites de tamanho de arquivo, limites de duração e outros requisitos de entrada, consulte Especificações de áudio.
Início rápido
- Obtenha uma chave de API: Obter uma chave de API. Por segurança, recomendamos que você configure a chave de API em uma variável de ambiente.
- Baixe o SDK e execute o código de exemplo:
- Baixe o pacote mais recente do SDK.
- Extraia o arquivo TAR. Obtenha o SDK no formato HAR de
neonuie adicione-o às dependências do seu projeto. Para integração com C++, usenative/libsenative/includeno arquivo TAR para obter as bibliotecas dinâmicas e arquivos de cabeçalho. - Abra o projeto no DevEco Studio. O código de exemplo está em
DashFunAsrFlashFileTranscriberPage.ets. Substitua a chave de API para testar o recurso.
Procedimento de chamada
Modo síncrono
-
Inicializar o SDK
-
Configure os parâmetros com base nos requisitos do seu negócio
-
Chame
startFileTranscriberpara enviar uma solicitação de reconhecimento de fala não em tempo real e aguarde o resultado. -
Use
onFileTransEventCallbackpara ouvir o eventoEVENT_FILE_TRANS_RESULTe obter o resultado final do reconhecimento. -
Chame
releasepara liberar os recursos do SDK
Parâmetros de solicitação
Parâmetros de conexão e controle
Passe uma string JSON para o parâmetro parameters do método initializeFileTrans para configurar essas definições.
Exemplo de parâmetro: A string JSON a seguir é um exemplo e não lista todos os parâmetros. Adicione parâmetros conforme necessário em seu 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
|
| Sim | O endpoint de serviço. Defina este parâmetro como |
|
| Sim | A chave de API. Recomendamos o uso de uma chave de API temporária de curta duração e mais segura para reduzir o risco de expor uma chave de longa duração. |
|
| Sim | O modo de operação. Para reconhecimento de fala não em tempo real, defina este parâmetro como |
|
| Sim | Uma string exclusiva que identifica o usuário final. Você pode usar um ID de usuário no aplicativo ou um identificador de dispositivo exclusivo gerado pelo cliente. Este ID é usado principalmente para rastreamento de logs e solução de problemas. |
|
| Não | O caminho para os arquivos de log. Este parâmetro só tem efeito quando você chama |
|
| Não | O tamanho máximo do arquivo de log em bytes. Este parâmetro só tem efeito quando você chama |
Parâmetros de reconhecimento
Use setParams para configurar os parâmetros nls_config, ou use startFileTranscriber para configurar todos os parâmetros de reconhecimento.
Exemplo de parâmetro: A string JSON a seguir é um exemplo e não lista todos os parâmetros. Adicione parâmetros conforme necessário em seu 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
|
| Não | Se os Parâmetros de conexão e controle |
|
| Sim | O objeto de configuração principal de reconhecimento de fala, incluindo o modelo e os parâmetros que controlam o reconhecimento. |
|
| Sim | O nome do modelo. |
|
| Sim | O formato de áudio. Defina este parâmetro para o formato real. Os formatos suportados incluem |
|
| Não | A taxa de amostragem de áudio em Hz. Por exemplo, |
|
| Não | O ID do vocabulário pré-compilado. Crie um vocabulário com antecedência e passe seu ID durante o reconhecimento para usar suas palavras-chave. Use esta opção quando o vocabulário for conhecido, relativamente estável e reutilizado entre solicitações. Para instruções de uso, consulte Palavras-chave pré-compiladas. |
|
| Não | Os códigos de idioma a reconhecer. Se o idioma não for conhecido, omita este parâmetro para que o modelo o detecte automaticamente. Você pode definir até 1 valor. Se definir mais, apenas os 1 primeiros terão efeito. Códigos de idioma compatíveis
|
|
| Sim | A lista de messages. Ela contém o áudio a ser reconhecido e o contexto opcional de conversa para melhorar o reconhecimento. Consulte as descrições a seguir. |
ImportanteO contexto melhora a precisão do reconhecimento de termos especializados. Para instruções de uso, consulte Aprimoramento de contexto.
as mensagens de contexto (tipos input_text e text) são limitadas a cinco cada. Se o limite for excedido, apenas as cinco mensagens mais recentes serão mantidas. O comprimento total do texto de contexto por turno (a soma dos comprimentos dos campos user e assistant text) não deve exceder 400 caracteres. Cada caractere conta como um. Os caracteres excedentes são truncados a partir do final.
ImportanteQuando o contexto é incluído, as mensagens messages devem seguir uma ordem específica. Organize as mensagens de contexto por turno de conversa. Dentro de cada turno, user (tipo input_text) deve preceder o assistant correspondente (tipo text). A mensagem input_audio user contendo o áudio de entrada deve ser colocada no final de messages.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
|
| Sim | A função da mensagem. Valores válidos:
|
|
| Sim | A lista de conteúdo da mensagem. Consulte as descrições a seguir. |
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
|
| Sim | O tipo de conteúdo. Cada solicitação requer pelo menos uma mensagem
|
|
| Não | Obrigatório quando |
|
| Sim | Os dados de áudio a serem reconhecidos. Para formatos de áudio suportados, limites de tamanho de arquivo, limites de duração e outros requisitos de entrada, consulte Especificações de áudio. Os dois métodos de entrada a seguir são suportados:
|
|
| Não | Obrigatório quando |
Interfaces principais
NativeNui
initializeFileTrans
Inicialize a instância do SDK de reconhecimento de fala.
ObservaçãoAo contrário do reconhecimento de fala em tempo real, a transcrição não em tempo real (arquivo gravado) requer initializeFileTrans com um callback INativeFileTransCallback em vez de initialize.
Este método bloqueia. Chame-o a partir de uma thread que não seja de UI.
Assinatura do métodopublic initializeFileTrans(callback: INativeFileTransCallback,
parameters: string,
level: number,
save_log: boolean = false): number
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
|
| A implementação da interface de callback de eventos e dados de transcrição de arquivo. |
|
| Uma string JSON contendo parâmetros de autenticação, conexão e depuração. Consulte Parâmetros de conexão e controle. |
|
| O nível de log do SDK. Use um valor da enumeração . |
|
| Se deve salvar logs localmente. Se definido como |
setParams
Use este método para definir ou atualizar nls_config separadamente. Você não precisa chamar este método se todos os parâmetros forem fornecidos em startFileTranscriber em uma única chamada.
public setParams(params: string): number
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
|
| Parâmetros de reconhecimento nos parâmetros |
startFileTranscriber
Iniciar o reconhecimento.
Assinatura do métodopublic startFileTranscriber(params: string, task_id: ArrayBuffer): number
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
|
| Parâmetros de reconhecimento. Exemplo: |
|
| O buffer de ID da tarefa. O SDK grava uma string de ID de tarefa aleatória gerada internamente neste buffer. Seu comprimento em bytes deve ser >= 33 bytes (o exemplo usa |
queryFileTranscriber
Use este método para consultar o status atual e o resultado de uma tarefa assíncrona. Após uma chamada bem-sucedida, o resultado é retornado por meio do evento EVENT_FILE_TRANS_QUERY_RESULT do callback onFileTransEventCallback.
public queryFileTranscriber(task_id: string): number
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
|
| O ID da tarefa a ser consultada (gravado no buffer por |
cancelFileTranscriber
Cancelar imediatamente a tarefa atual.
Assinatura do métodopublic cancelFileTranscriber(task_id: string): number
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
|
| O ID da tarefa a ser cancelada. |
release
Libere todos os recursos internos do SDK. Após esta chamada, a instância do SDK fica indisponível. Para usá-la novamente, chame initializeFileTrans para inicializá-la novamente.
public release(): number
GetVersion
Obter a versão atual do SDK.
Assinatura do métodopublic GetVersion(): string
Valor de retorno
A versão atual do SDK.
INativeFileTransCallback: Callbacks
onFileTransEventCallback: Ouça eventos e resultados de reconhecimento
Assinatura do métodoonFileTransEventCallback: (event: Constants.NuiEvent, resultCode: number, finish: number,
asrResult: AsrResult, taskId: string) => void;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
|
| O evento de callback. |
|
| Válido apenas quando o evento |
|
| Se a tarefa foi concluída. |
|
| O resultado do reconhecimento de fala. |
|
| O ID da tarefa. |
onFileTransLogTrackCallback: Ouça logs de rastreamento
Este callback recebe logs internos detalhados do SDK para solução de problemas e depuração.
Para usar este callback, baixe o pacote do SDK do HarmonyOS com data de 20260908 ou posterior.
onFileTransLogTrackCallback?: (level: Constants.LogLevel, log: string) => void;
Tipos de evento
No SDK do HarmonyOS, os tipos de evento são definidos pela enumeração Constants.NuiEvent . Os seguintes eventos estão relacionados à transcrição de arquivos gravados:
| Evento | Descrição |
|---|---|
| Conectado com sucesso ao serviço. |
| O arquivo de áudio foi carregado com sucesso. |
| O resultado da consulta da tarefa. |
| O resultado final do reconhecimento. |
| Ocorreu um erro durante o reconhecimento de fala. |