O SDK iOS 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.
Passe uma string JSON para o parâmetro
Parâmetros
Use
Parâmetros
parâmetros de messages:
parâmetros de content:
Inicialize a instância do SDK de reconhecimento de fala. O SDK usa um singleton. Não o inicialize novamente antes de chamar
Parâmetros
Use este método para definir ou atualizar
Parâmetros
Iniciar o reconhecimento.
Assinatura do método
Parâmetros
Este recurso de reconhecimento de fala não em tempo real suporta apenas solicitações síncronas. Você pode ignorar este método.
Assinatura do método
Parâmetros
Cancelar imediatamente a tarefa atual.
Assinatura do método
Parâmetros
Libere todos os recursos internos do SDK e force a interrupção de todas as tarefas em andamento. Após esta chamada, a instância do SDK fica indisponível. Para usá-la novamente, chame
Obter a versão atual do SDK.
Assinatura do método
Valor de retorno
A versão atual do SDK.
Assinatura do método
Parâmetros
Este callback recebe 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.
- Extraia o arquivo ZIP e adicione nuisdk.framework ao projeto.
- Adicione nuisdk.xcframework em Build Phases → Link Binary With Libraries.
- Em General → Frameworks, Libraries, and Embedded Content, defina nuisdk.xcframework como Embed & Sign.
- Abra o projeto de exemplo no Xcode. O código de exemplo está em
DashFunAsrFlashFileTranscriberViewController.m. 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
nui_file_trans_startpara enviar uma solicitação de reconhecimento de fala não em tempo real. -
Use
onFileTransEventCallbackpara ouvir o eventoEVENT_FILE_TRANS_RESULTe 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
Passe uma string JSON para o parâmetro parameters do método nui_initialize 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:
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
url | String | Sim | Endpoints de serviço:
{WorkspaceId} pelo seu ID do Workspace. |
apikey | String | Sim | Chave de API. |
service_mode | String | Sim | O modo de operação. Para reconhecimento de fala não em tempo real, defina este parâmetro como "1". |
device_id | String | 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. |
debug_path | String | Não | O caminho para os arquivos de log. Este parâmetro só entra em vigor quando você chama nui_initialize com save_log definido como YES. Nesse caso, você deve especificar o caminho do arquivo de log. Caso contrário, ocorrerá um erro. Até dois arquivos de log são retidos 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 você chama nui_initialize com save_log definido como YES. Padrão: 104857600 (100 * 1024 * 1024 bytes, ou 100 MiB). |
log_track_level | int | Não | O nível de filtragem para logs enviados por meio do callback de log (onFileTransLogTrackCallback). Padrão: 2. Valores válidos:
log_track_level e level (configurados por meio do método nui_initialize) determinam em conjunto quais logs são entregues. O nível numérico de um log deve ser maior ou igual a log_track_level e level para que o log seja entregue. Por exemplo, se log_track_level estiver definido como 2 (INFO) e level estiver definido como 3 (WARNING), apenas logs de WARNING e de maior severidade (nível numérico >= 3) serão entregues. |
Parâmetros de reconhecimento
Use nui_file_trans_start 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:
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
apikey | string | Não | Se os Parâmetros de conexão e controle apikey usarem uma chave de API temporária, você pode atualizá-la aqui para evitar a expiração. |
nls_config | object | Sim | O objeto de configuração principal de reconhecimento de fala, incluindo o modelo e os parâmetros que controlam o reconhecimento. |
nls_config.model | string | Sim | O nome do modelo. |
nls_config.format | string | Sim | O formato de áudio. Defina este parâmetro para o formato real. Os formatos suportados incluem wav, mp3, opus. Para obter detalhes, consulte Especificações de áudio. |
nls_config.sample_rate | string | Não | A taxa de amostragem de áudio em Hz. Por exemplo, 16000 indica uma taxa de amostragem de 16 kHz. Para obter detalhes, consulte Especificações de áudio. |
nls_config.vocabulary_id | string | 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. |
nls_config.language_hints | array[string] | 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
|
messages | array[object] | 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. |
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
role | string | Sim | A função da mensagem. Valores válidos:
|
content | array[object] | Sim | A lista de conteúdo da mensagem. Consulte as descrições a seguir. |
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
type | string | Sim | O tipo de conteúdo. Cada solicitação requer pelo menos uma mensagem input_audio . Valores válidos:
|
input_audio | object | Não | Obrigatório quando type é input_audio. |
input_audio.data | string | 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:
https://example.com/audio/sample.wavExemplo (Base64): data:audio/wav;base64,{BASE64_ENCODED_DATA} |
text | string | Não | Obrigatório quando type é input_text, forneça os resultados de reconhecimento da fala do usuário de turnos anteriores ou um vocabulário específico de domínio. Quando type é text, forneça as respostas do modelo de linguagem grande de turnos anteriores. O comprimento do texto é contado em caracteres, com cada caractere contando como um. O comprimento total de todos os campos text das mensagens em cada turno de contexto não deve exceder 400 caracteres. Os caracteres excedentes são truncados a partir do final. |
Interfaces principais
NeoNui
nui_initialize
Inicialize a instância do SDK de reconhecimento de fala. O SDK usa 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 contendo parâmetros de autenticação, conexão e depuração. Consulte Parâmetros de conexão e controle. |
level | NuiSdkLogLevel | O nível de logs impressos pelo SDK. |
save_log | BOOL | Se deve salvar logs localmente. Se definido como YES, use os Parâmetros de conexão e controle para definir debug_path para especificar o caminho e use max_log_file_size para definir o tamanho do arquivo. |
nui_set_params
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 nui_file_trans_start em uma única chamada.
Assinatura do método
| Parâmetro | Tipo | Descrição |
|---|---|---|
params | char* | Parâmetros de reconhecimento em nls_config e parâmetros de messages.Exemplo: |
nui_file_trans_start
Iniciar o reconhecimento.
Assinatura do método
| Parâmetro | Tipo | Descrição |
|---|---|---|
params | char* | Parâmetros de reconhecimento. Exemplo: |
task_id | char* | Você pode ignorar este parâmetro e passar null. |
nui_file_trans_query
Este recurso de reconhecimento de fala não em tempo real suporta apenas solicitações síncronas. Você pode ignorar este método.
Assinatura do método
| Parâmetro | Tipo | Descrição |
|---|---|---|
task_id | char* | O ID da tarefa a ser consultada, obtido de EVENT_FILE_TRANS_UPLOADED. |
nui_file_trans_cancel
Cancelar imediatamente a tarefa atual.
Assinatura do método
| Parâmetro | Tipo | Descrição |
|---|---|---|
task_id | char* | O ID da tarefa a ser cancelada, obtido de EVENT_FILE_TRANS_UPLOADED. |
nui_release
Libere todos os recursos internos do SDK e force a interrupção de todas as tarefas em andamento. Após esta chamada, a instância do SDK fica indisponível. Para usá-la novamente, chame nui_initialize para inicializá-la novamente.
Assinatura do método
nui_get_version
Obter a versão atual do SDK.
Assinatura do método
NeoNuiSdkDelegate: Callbacks
onFileTransEventCallback: Ouça eventos e resultados de reconhecimento
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 | Se o reconhecimento para este turno foi concluído. |
code | int | Válido apenas quando o evento EVENT_ASR_ERROR ocorre. |
onFileTransLogTrackCallback: Ouça logs de rastreamento
Este callback recebe 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 com sucesso ao serviço. |
EVENT_FILE_TRANS_UPLOADED | O arquivo de áudio foi carregado com sucesso. Você pode obter o task_id atual neste momento. |
EVENT_FILE_TRANS_RESULT | O resultado final do reconhecimento. |
EVENT_ASR_ERROR | Ocorreu um erro durante o reconhecimento de fala. |