tryvoice v0.0.13

Documentação do Web Socket Server

Conexão com o Servidor Web Socket

Você pode estabelecer uma conexão com o servidor Web Socket utilizando as seguintes URLs:

• wss://io.tryvoice.ia
• wss://10.100.241.75

Para criar a conexão com o servidor Web Socket, utilize o seguinte trecho de código:

const socket = socketIOClient("host", {
    query: {
        "token",
        "sub"
    }
});

• Parâmetros:
  • host: A URL do servidor WebSocket desejado.
  • token: O token de autenticação, se necessário.
  • sub: Informações adicionais, se necessário.

Eventos

Evento "text:speech"

Este evento permite a síntese de texto em voz.

• Parâmetros:
  • voice - A voz associada ao arquivo de áudio.
  • text - O texto a ser sintetizado.
  • coreAi - O núcleo de IA utilizado.
  • LANGUAGE_CODE - O código de idioma.

Exemplo de uso:

socket.emit("text:speech", {
    "voice": "es-ES-Standard-A",
    "text": "lorem ipsum",
    "coreAi": "chatgpt",
    "LANGUAGE_CODE": (navigator.language || navigator.userLanguage)
});

Evento "upload"

Este evento é usado para realizar o streaming de áudio do microfone com o comando de interação por voz.

• Parâmetros:

  • voice - A voz associada ao arquivo de áudio.
  • modelAi - O modelo de IA utilizado.
  • coreAi - O núcleo de IA utilizado.
  • interationID - O ID da interação.
  • bytesAudio - Os dados de áudio em formato base64.
  • recognitionTranscript - A transcrição da fala. Opcional.
  • LANGUAGE_CODE - O código de idioma.

Opções Disponíveis para Parâmetros

Vozes Disponivels

• "code-country-Standard-A": FEMININO
• "code-country-Standard-B": MASCULINO

• "code-country-Standard-C": MASCULINO

• "code-country-Wavenet-A": FEMININO

• "code-country-Wavenet-B": MASCULINO

• "code-country-Wavenet-C": MASCULINO

• "code-country-Neural2-A": FEMININO

• "code-country-Neural2-B": MASCULINO
• "code-country-Neural2-C": MASCULINO

Modelos Disponíveis

Você pode escolher entre os seguintes modelos:

• "gpt-4": Este modelo utiliza a versão "gpt-4" da IA para interações.
• "Chat": Este modelo é adequado para interações de bate-papo.
• "Friend chat": Este modelo simula conversas de amizade.
• "Marv the sarcastic chat bot": Esse modelo fornece respostas sarcásticas.
• "ML/AI language model tutor.": Atua como um tutor de modelos de linguagem de ML/AI.
• "Interview questions": Ajuda a criar perguntas para entrevistas com autores de ficção científica.
• "Classify sentiment": É usado para classificar o sentimento em tweets.

Escolha o modelo que melhor se adapte ao seu cenário de aplicação.

Core AIs Disponíveis

Você pode selecionar entre os seguintes Core AIs:

• "chatgpt": Este Core AI é especializado em chatbots.
• "bingchat": Oferece recursos de chat com foco na pesquisa da Microsoft.
• "googlebard": Um Core AI desenvolvido pela Google.
• "morefast": Outra opção de Core AI para suas interações.

Escolha o Core AI que melhor atenda às suas necessidades específicas.

Certifique-se de selecionar o modelo e o Core AI apropriados com base em seus requisitos e preferências para obter os resultados desejados.

socket.emit("upload", {
    "voice": "es-ES-Standard-A",
    "modelAi": "gpt-4",
    "coreAi": "chatgpt",
    "interationID",
    "bytesAudio": "base64StringStreamAudio",
    "recognitionTranscript",
    "LANGUAGE_CODE": (navigator.language || navigator.userLanguage)
});

Evento "upload:listener"

Este evento foi descontinuado.

• Parâmetros:
  • bytesAudio - Os dados de áudio em formato base64.
  • LANGUAGE_CODE - O código de idioma.

Exemplo de uso:

socket.emit("upload:listener", {
    "bytesAudio": "base64String",
    "LANGUAGE_CODE": "es-ES"
});

Funções

Evento "ONstarted"

Esse evento retorna o diálogo de inicialização da interação.

Exemplo de uso:

socket.on("ONstarted", async () => { /* sua lógica aqui */ });

Evento "audio"

Este evento recebe a resposta em áudio, ou seja, uma voz sintetizada.

Exemplo de uso:

socket.on("audio", async (data) => { /* sua lógica aqui */ }");

Evento "text:response"

Esse evento recebe a resposta em texto puro.

Exemplo de uso:

socket.on("text:response", async (text) => { /* sua lógica aqui */ });

Evento "text:transcript"

Este evento recebe o áudio transcrito em texto puro.

Exemplo de uso:

socket.on("text:transcript", async (text) => { /* sua lógica aqui */ });

Evento "text:transcript:not:voice"

Esse evento ocorre quando nenhum diálogo é encontrado no áudio enviado.

Exemplo de uso:

socket.on("text:transcript:not:voice", async (data) => { /* sua lógica aqui */ });

Evento "historic:update"

Esse evento recebe a atualização do histórico de interação.

Exemplo de uso:

socket.on("historic:update", async (data) => { /* sua lógica aqui */ });

Evento "disconnect"

Este evento é acionado quando ocorre uma desconexão do servidor.

Exemplo de uso:

socket.on("disconnect", async () => { /* sua lógica aqui */ });