Este guia orienta você pelo SDK iOS de reconhecimento de fala não em tempo real Qwen-Audio-ASR-Filetrans, para que você possa converter áudio em texto.
Para requisitos de entrada, como formatos de áudio suportados, limites de tamanho de arquivo e limites de duração, consulte Especificações de áudio.
Configure esses parâmetros passando uma string JSON no argumento
Descrições dos parâmetros
Configure todos os parâmetros de reconhecimento de fala por meio da interface
Descrições dos parâmetros
Inicializa a instância do SDK de reconhecimento de fala. O SDK é um singleton. Não o inicialize novamente antes de chamar
Descrições dos parâmetros
Use esta interface para definir ou atualizar o parâmetro
Descrições dos parâmetros
Inicia o reconhecimento.
Assinatura do método
Descrições dos parâmetros
Use esta interface para consultar ativamente o status e o resultado atuais de uma tarefa assíncrona. Após uma chamada bem-sucedida, o resultado é retornado por meio do evento
Assinatura do método
Descrições dos parâmetros
Cancela a tarefa atual imediatamente.
Assinatura do método
Descrições dos parâmetros
Libera todos os recursos internos do SDK e encerra forçosamente todas as tarefas em andamento. Depois de chamar este método, a instância do SDK fica indisponível. Para usá-la novamente, você deve chamar
Obtém as informações da versão atual do SDK.
Assinatura do método
Valor de retorno
As informações da versão atual do SDK.
Assinatura do método
Descrições dos parâmetros
Use este callback para receber logs internos detalhados do SDK para solução de problemas e depuração.
Início rápido
- Obtenha uma chave de API:Obter uma chave de API
-
Baixe o SDK e execute o código de exemplo:
- Baixe o pacote mais recente do SDK.
- Descompacte o pacote ZIP e adicione o nuisdk.framework incluído ao seu projeto.
- Em Build Phases → Link Binary With Libraries, adicione
nuisdk.xcframework. - Em General → Frameworks, Libraries, and Embedded Content, defina
nuisdk.xcframeworkcomo Embed & Sign. - Abra o projeto de exemplo no Xcode. O código de exemplo está localizado em
DashFunAsrFileTranscriberViewController.m. Substitua a API Key para testar o recurso.
Etapas de chamada
- Modo síncrono
- Modo assíncrono
- Inicialize o SDK.
- Configure os parâmetros relevantes para o seu caso de uso.
- Defina
async_requestcomofalsee chamenui_file_trans_startpara enviar uma solicitação de reconhecimento de fala não em tempo real e aguardar o resultado. - No callback
onFileTransEventCallback, escute o eventoEVENT_FILE_TRANS_RESULTpara obter o resultado final do reconhecimento. - Chame
nui_releasepara liberar os recursos do SDK.
Parâmetros de solicitação
Parâmetros de conexão e controle
Configure esses parâmetros passando uma string JSON no argumento parameters da interface nui_initialize.
Parâmetros de exemplo
A seguir está uma string JSON de exemplo. Nem todos os parâmetros estão listados. Adicione os que você precisa ao escrever seu código:
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
url | String | Sim | Endpoints de serviço:
{WorkspaceId} pelo seu ID do Workspace real. |
apikey | String | Sim | A chave de API. |
service_mode | String | Sim | O modo de execução. Fixado em "1" para reconhecimento de fala não em tempo real. |
device_id | String | Sim | Uma string exclusiva que identifica o usuário final. Defina-a como um ID de usuário no aplicativo ou um identificador de dispositivo gerado pelo cliente. Este ID é usado principalmente para rastreamento de logs e solução de problemas. |
debug_path | String | Não | O caminho de armazenamento para o arquivo de log.Este parâmetro só entra em vigor quando save_log é definido como YES ao chamar a interface nui_initialize. Nesse caso, você deve definir o caminho do arquivo de log; caso contrário, um erro será retornado.No máximo dois arquivos de log são mantidos localmente. |
max_log_file_size | int | Não | O tamanho máximo do arquivo de log, em bytes.Este parâmetro só entra em vigor quando save_log é definido como YES ao chamar a interface nui_initialize.Valor padrão: 104857600 (100 * 1024 * 1024 bytes, ou seja, 100 MiB). |
log_track_level | int | Não | Controla o nível de filtro do conteúdo de log enviado por meio do callback de log (onFileTransLogTrackCallback).Valor padrão: 2.Valores válidos:
log_track_level e level (definidos por meio da interface nui_initialize) determinam juntos quais logs são finalmente enviados para o callback. O valor do nível de um log deve ser maior ou igual a log_track_level e level antes de ser enviado para o callback. Por exemplo, se log_track_level estiver definido como 2 (INFO) e level estiver definido como 3 (WARNING), apenas logs no nível WARNING ou superior (valor >= 3) serão enviados para o callback. |
Parâmetros de efeito de reconhecimento de fala
Configure todos os parâmetros de reconhecimento de fala por meio da interface nui_file_trans_start.
Parâmetros de exemplo
A seguir está uma string JSON de exemplo. Nem todos os parâmetros estão listados. Adicione os que você precisa ao escrever seu código:
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
file_urls | array[string] | Sim | Uma lista de URLs dos arquivos de áudio ou vídeo a serem transcritos. HTTP e HTTPS são suportados. Uma única solicitação suporta apenas uma URL. Para requisitos de entrada, como formatos de áudio suportados, limites de tamanho de arquivo e limites de duração, consulte Especificações de áudio.Se a gravação estiver armazenada no Alibaba Cloud OSS, a API RESTful suporta URLs temporárias com o prefixo oss://, enquanto o SDK não suporta URLs temporárias com o prefixo oss://. |
async_request | boolean | Não | Se a solicitação de reconhecimento de fala é assíncrona.Valor padrão: false.Valores válidos:
|
apikey | string | Não | Se o apikey em Parâmetros de conexão e controle for uma chave de API temporária, você pode atualizá-la aqui para evitar que expire. |
nls_config | object | Sim | O objeto de configuração principal do reconhecimento de fala. Ele contém parâmetros chave, como seleção de modelo e controles de efeito de reconhecimento. |
nls_config.model | string | Sim | O nome do modelo. |
nls_config.special_word_filter | object | Não | As palavras sensíveis a serem processadas durante o reconhecimento de fala. Você pode definir um método de tratamento diferente para cada palavra sensível. Para obter detalhes, consulte Filtragem de palavras sensíveis. |
nls_config.channel_id | array[integer] | Não | O índice das faixas de áudio a serem reconhecidas em um arquivo de áudio com várias faixas. O índice começa em 0. Por exemplo, [0] reconhece a primeira faixa, e [0, 1] reconhece a primeira e a segunda faixas ao mesmo tempo. Se você omitir este parâmetro, apenas a primeira faixa será processada.Valor padrão: [0]. |
nls_config.diarization_enabled | boolean | Não | Se deve ativar a diarização de falantes. Desativado por padrão.Aplica-se apenas a áudio mono. Áudio multicanal não suporta diarização de falantes.Quando ativado, o resultado do reconhecimento inclui um campo speaker_id que distingue diferentes falantes.Quando a diarização de falantes está ativada, mantenha a duração do áudio dentro de 2 horas. Caso contrário, o reconhecimento pode falhar ou atingir o tempo limite. speaker_id, consulte Descrição do resultado do reconhecimento. |
nls_config.speaker_count | integer | Não | Um valor de referência para o número de falantes. O intervalo válido é um número inteiro de 2 a 100 (inclusivo).Por padrão, o número de falantes é detectado automaticamente. Se você definir este valor, ele apenas orientará o algoritmo a gerar a contagem especificada quando possível, e não garante essa contagem exata.Sem valor padrão. |
nls_config.vocabulary_id | string | Não | O ID de uma lista de palavras-chave pré-compilada.Gere este ID antecipadamente chamando a API de criação de lista de palavras-chave. Passe o ID durante o reconhecimento para usar as palavras-chave na lista.Adequado para cenários onde o vocabulário é conhecido e relativamente estável, e onde você precisa reutilizar a mesma lista de palavras em várias solicitações.Para detalhes de uso, consulte Palavras-chave pré-compiladas. |
nls_config.input_context | array | Não | Uma lista de mensagens contendo contexto de conversa opcional para melhorar a precisão do reconhecimento. |
nls_config.instant_vocabulary | object | Não | Palavras-chave instantâneas, passadas como pares chave-valor. Cada chave é o texto da palavra-chave (string) e cada valor é o seu peso (integer). Nenhuma lista de palavras-chave pré-compilada é necessária. Use este parâmetro para palavras-chave temporárias no nível da sessão.Os pesos válidos são inteiros de 1 a 5, ou 50. Um peso maior de 1 a 5 torna mais provável que o modelo gere a palavra-chave. Um peso de 50 define uma super palavra-chave e melhora significativamente a taxa de recall. Você pode especificar até 50 super palavras-chave.Se você também configurar palavras-chave pré-compiladas, os dois conjuntos serão mesclados. Se o conjunto mesclado exceder 2000 palavras-chave, 2000 serão selecionadas aleatoriamente. Para uso, consulte Palavras-chave instantâneas. |
nls_config.language_hints | array[string] | Não | Os códigos de idioma a serem reconhecidos. Se você não puder determinar o idioma com antecedência, deixe-o indefinido e o modelo detectará o idioma automaticamente.Você pode definir até 4 valores. Se definir mais, apenas os 4 primeiros serão usados.
Clique para ver os códigos de idioma suportados
|
Interfaces principais
NeoNui
nui_initialize
Inicializa a instância do SDK de reconhecimento de fala. O SDK é um singleton. Não o inicialize novamente antes de chamar nui_release.
Assinatura do método
| Parâmetro | Tipo | Descrição |
|---|---|---|
parameters | char* | Uma string JSON que contém os parâmetros de autenticação, conexão e depuração. Consulte Parâmetros de conexão e controle. |
level | NuiSdkLogLevel | Controla o nível de impressão dos próprios logs do SDK. |
save_log | BOOL | Se deve salvar logs localmente. Se definido como YES, você deve especificar um caminho por meio de debug_path em Parâmetros de conexão e controle, e pode definir o tamanho do arquivo por meio de max_log_file_size. |
nui_set_params
Use esta interface para definir ou atualizar o parâmetro nls_config de forma independente. Se você fornecer todos os parâmetros de uma vez em nui_file_trans_start, não precisará chamar este método.
Assinatura do método
| Parâmetro | Tipo | Descrição |
|---|---|---|
params | char* | O parâmetro nls_config em Parâmetros de efeito de reconhecimento de fala. Parâmetros diferentes de nls_config não podem ser definidos por meio deste método.Exemplo: |
nui_file_trans_start
Inicia o reconhecimento.
Assinatura do método
| Parâmetro | Tipo | Descrição |
|---|---|---|
params | char* | Parâmetros de efeito de reconhecimento de fala.Exemplo: |
task_id | char* | O ID da tarefa. O SDK gera uma string aleatória internamente e retorna o task_id quando esta interface é chamada com sucesso. |
nui_file_trans_query
Use esta interface para consultar ativamente o status e o resultado atuais de uma tarefa assíncrona. Após uma chamada bem-sucedida, o resultado é retornado por meio do evento EVENT_FILE_TRANS_QUERY_RESULT no callback onFileTransEventCallback.
Obtenha o
task_id passado para este método a partir do evento EVENT_FILE_TRANS_UPLOADED.| Parâmetro | Tipo | Descrição |
|---|---|---|
task_id | char* | O ID da tarefa a ser consultada, obtido a partir do evento EVENT_FILE_TRANS_UPLOADED. |
nui_file_trans_cancel
Cancela a tarefa atual imediatamente.
Assinatura do método
| Parâmetro | Tipo | Descrição |
|---|---|---|
task_id | char* | O ID da tarefa a ser cancelada, obtido a partir do evento EVENT_FILE_TRANS_UPLOADED. |
nui_release
Libera todos os recursos internos do SDK e encerra forçosamente todas as tarefas em andamento. Depois de chamar este método, a instância do SDK fica indisponível. Para usá-la novamente, você deve chamar nui_initialize novamente para inicializá-la.
Assinatura do método
nui_get_version
Obtém as informações da versão atual do SDK.
Assinatura do método
NeoNuiSdkDelegate: monitorar callbacks
onFileTransEventCallback: monitorar eventos e resultados de reconhecimento de fala
Assinatura do método
| Parâmetro | Tipo | Descrição |
|---|---|---|
nuiEvent | NuiCallbackEvent | O evento de callback. |
asr_result | char* | O resultado do reconhecimento de fala. |
task_id | char* | O ID da tarefa. |
finish | BOOL | Indica se esta rodada de reconhecimento foi concluída. |
code | int | Válido apenas quando o evento EVENT_ASR_ERROR ocorre. |
onFileTransLogTrackCallback: monitorar logs de rastreamento
Use este callback para receber logs internos detalhados do SDK para solução de problemas e depuração.
NuiCallbackEvent: tipos de evento
| Evento | Descrição |
|---|---|
EVENT_FILE_TRANS_CONNECTED | Conectado ao serviço com sucesso. |
EVENT_FILE_TRANS_UPLOADED | O arquivo de áudio a ser reconhecido foi carregado com sucesso. Agora você pode obter o task_id da tarefa atual. |
EVENT_FILE_TRANS_QUERY_RESULT | O resultado da tarefa de consulta. |
EVENT_FILE_TRANS_RESULT | O resultado final do reconhecimento. |
EVENT_ASR_ERROR | Ocorreu um erro durante o reconhecimento de fala. |