Referência de eventos do servidor CosyVoice: início da tarefa, síntese de frases, conclusão, falha e solicitações correspondentes.
Fluxo de eventos
- Envie run-task para iniciar e configurar a tarefa e aguarde task-started.
- Após receber
task-started, envie texto por continue-task enquanto recebe eventos result-generated e o áudio sintetizado. - Após enviar todo o texto, envie finish-task e continue recebendo os resultados e o áudio restantes até chegar task-finished. Uma tarefa com falha retorna task-failed.
result-generated retorna metadados da frase. O áudio é transmitido separadamente por quadros binários no WebSocket ou por uma Audio Track no AOQ. Para conexão, autenticação e transporte de áudio, consulte a API WebSocket ou o acesso AOQ.
task-started
Indica que a tarefa foi iniciada com sucesso e o cliente pode começar a enviar texto para síntese.
headerobjecttask_idstringID da tarefa gerado pelo cliente.
eventstringTipo de evento. Valor fixo:
task-started.payloadobjectObjeto vazio.
Solicitação:
Resposta:
result-generated
Retorna metadados da frase, incluindo início da frase, marcadores de blocos de áudio e fim da frase.
headerobjecttask_idstringID da tarefa gerado pelo cliente.
eventstringTipo de evento. Valor fixo:
result-generated.payloadobjectoutputobjectInformações de saída.
sentenceobjectindexintegerÍndice da frase, começando em 0.
wordsarrayArray de carimbos de data/hora no nível da palavra.
textstringConteúdo textual da palavra.
begin_indexintegerÍndice do caractere inicial da palavra na frase. Começa em 0.
end_indexintegerÍndice do caractere final da palavra na frase. Começa em 1.
begin_timeintegerTempo inicial do áudio correspondente à palavra, em milissegundos.
end_timeintegerTempo final do áudio correspondente à palavra, em milissegundos.
typestringTipo de subevento. Valores válidos:
sentence-begin: Início da frase. Retorna o texto a ser sintetizado.sentence-synthesis: Marca um quadro de áudio. Um quadro de áudio é transmitido pelo canal binário WebSocket imediatamente após cada evento.sentence-end: Fim da frase. Retorna o conteúdo textual e a contagem cumulativa de caracteres.
original_textstringTexto da frase conforme segmentado para síntese.
usageobjectInformações de faturamento, retornadas no evento
sentence-end.usage contém o uso acumulado da tarefa atual. Não some os valores de usage dos eventos. Após a conclusão, use o total acumulado final em task-finished.charactersintegerNúmero cumulativo de caracteres faturados.
Os exemplos a seguir definem
word_timestamp_enabled=true ao iniciar a tarefa.- sentence-begin
- sentence-synthesis
- sentence-end
Solicitação:
Resposta:
task-finished
O servidor retorna um evento task-finished ao concluir a tarefa. Nesse momento, o cliente pode fechar a conexão WebSocket ou reutilizá-la para iniciar uma nova tarefa.
headerobjecttask_idstringID da tarefa gerado pelo cliente.
eventstringTipo de evento. Valor fixo:
task-finished.payloadobjectusageobjectcharactersintegerNúmero cumulativo de caracteres faturados.
Solicitação:
Resposta:
task-failed
O servidor retorna um evento task-failed quando a tarefa falha. Ao receber esse evento, o cliente deve fechar a conexão WebSocket e tratar o erro.
headerobjecttask_idstringID da tarefa gerado pelo cliente.
eventstringTipo de evento. Valor fixo:
task-failed.error_codestringCódigo de erro.
error_messagestringMensagem de erro detalhada.
Este exemplo usa um formato de áudio não suportado. Após iniciar a tarefa e enviar o texto, o servidor retorna um erro. O código e a mensagem dependem da causa da falha.
Solicitação:
Resposta: