Skip to main content
Referência da API de reconhecimento de fala em tempo real do Paraformer

Server-sent events for real-time speech recognition (Paraformer)

Referência dos server-sent events que o serviço de reconhecimento de fala em tempo real Paraformer envia aos clientes via WebSocket. Este tópico documenta a estrutura de dados e a semântica dos campos dos quatro tipos de evento: task-started, result-generated, task-finished e task-failed.

Guia do usuário: Para obter detalhes sobre o modelo e orientações de seleção, consulte Fala para texto. Fluxo de interação de eventos: Para visualizar o diagrama de sequência de eventos, consulte API WebSocket.

task-started

Descrição: A tarefa foi iniciada com sucesso. O cliente pode começar a enviar dados de áudio.
headerobject

Properties

task_idstringID da tarefa gerado pelo cliente (formato UUID).eventstringTipo de evento. Sempre task-started.attributesobjectAtributos adicionais. Geralmente vazio.
{
    "header": {
        "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
        "event": "task-started",
        "attributes": {}
    },
    "payload": {}
}
payloadobjectSempre {}.

result-generated

Descrição: Resultado do reconhecimento. Inclui resultados intermediários (sentence_end=false) e finais (sentence_end=true).
headerobject

Properties

task_idstringID da tarefa gerado pelo cliente (formato UUID).eventstringTipo de evento. Sempre result-generated.
{
  "header": {
    "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
    "event": "result-generated",
    "attributes": {}
  },
  "payload": {
    "output": {
      "sentence": {
        "begin_time": 170,
        "end_time": null,
        "text": "Okay, I got it.",
        "heartbeat": false,
        "sentence_end": true,
        "words": [
          {
            "begin_time": 170,
            "end_time": 295,
            "text": "Okay",
            "punctuation": ","
          },
          {
            "begin_time": 295,
            "end_time": 503,
            "text": "I",
            "punctuation": ""
          },
          {
            "begin_time": 503,
            "end_time": 711,
            "text": "got",
            "punctuation": ""
          },
          {
            "begin_time": 711,
            "end_time": 920,
            "text": "it",
            "punctuation": ""
          }
        ]
      }
    },
    "usage": {
      "duration": 3
    }
  }
}
payloadobject

Properties

outputobject

Properties

usageobjectSe payload.output.sentence.sentence_end for false (a frase atual não terminou), usage será null.Se payload.output.sentence.sentence_end for true (a frase atual terminou), usage.duration indicará a duração faturável da tarefa atual.

Properties

durationintegerDuração faturável da tarefa, em segundos.

Properties

sentenceobject

Properties

begin_timeintegerHora de início da frase, em milissegundos.end_timeintegerHora de término da frase, em milissegundos.textstringTexto reconhecido.heartbeatbooleanSe verdadeiro, ignore este resultado (pacote de heartbeat).sentence_endbooleanIndica se a frase terminou (true=resultado final, false=resultado intermediário).emo_tagstring
  • Apenas o modelo paraformer-realtime-8k-v2 oferece suporte a este recurso.
  • Este recurso exige a desativação da segmentação semântica. Defina semantic_punctuation_enabled como false no evento execute-task.
  • O resultado do reconhecimento de emoção retorna apenas quando payload.output.sentence.sentence_end é true.
Sentimento da frase atual:
  • positive: sentimento positivo, como feliz ou satisfeito.
  • negative: sentimento negativo, como irritado ou desanimado.
  • neutral: sem sentimento distinto.
emo_confidencefloat
  • Apenas o modelo paraformer-realtime-8k-v2 oferece suporte a este recurso.
  • Este recurso exige a desativação da segmentação semântica. Defina semantic_punctuation_enabled como false no evento execute-task.
  • O resultado do reconhecimento de emoção retorna apenas quando payload.output.sentence.sentence_end é true.
Pontuação de confiança da emoção no intervalo [0,0, 1,0]. Valores maiores indicam maior confiança.wordsarray[object]Informações de carimbo de data/hora no nível da palavra.

Properties

begin_timeintegerHora de início da palavra, em milissegundos.end_timeintegerHora de término da palavra, em milissegundos.textstringTexto reconhecido.punctuationstringSinal de pontuação.

task-finished

Descrição: A tarefa terminou normalmente. Feche a conexão ou reutilize-a.
headerobject

Properties

task_idstringID da tarefa gerado pelo cliente (formato UUID).eventstringTipo de evento. Sempre task-finished.attributesobjectAtributos adicionais. Geralmente vazio.
{
    "header": {
        "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
        "event": "task-finished",
        "attributes": {}
    },
    "payload": {
        "output": {},
        "usage": null
    }
}
payloadobjectConteúdo ignorável. Geralmente {}.

task-failed

Descrição: Falha na tarefa. A conexão foi fechada e não pode ser reutilizada.
headerobject

Properties

task_idstringID da tarefa gerado pelo cliente (formato UUID).eventstringTipo de evento. Sempre task-failed.error_codestringDescrição do tipo de erro.error_messagestringCausa específica do erro.attributesobjectAtributos adicionais. Geralmente vazio.
{
    "header": {
        "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
        "event": "task-failed",
        "error_code": "CLIENT_ERROR",
        "error_message": "request timeout after 23 seconds.",
        "attributes": {}
    },
    "payload": {}
}
payloadobjectSempre {}.
Uso da API
Referência da API de Geração de Texto
Geração de Imagens
  • FAQ
Geração de Vídeo
Áudio
Multimodal em Tempo Real
API em tempo real
Incorporação de Texto
Mais Modelos
Toolkit/Framework
Produção de Modelos
File Management
Gerenciamento de modelos
Mais