Tutorial de configuração da API compatível com OpenAI

1Escolha um provedor compatível

Selecione um serviço que suporte o protocolo WebSocket da Realtime API da OpenAI. Importante: Muito poucos provedores atualmente suportam a Realtime API — a maioria dos serviços compatíveis com OpenAI suportam apenas a API de Chat Completions, o que não é suficiente. Sempre verifique se seu provedor suporta explicitamente a Realtime API antes de prosseguir.

2Obtenha seu endpoint e chave API

Obtenha a URL do endpoint API e a chave API do seu provedor escolhido. A URL do endpoint geralmente está no formato https://your-provider.com ou http://localhost:8080 para serviços auto-hospedados.

3Selecione API compatível com OpenAI no Sokuji

Abra o Sokuji e navegue até o painel de Configurações. Selecione "OpenAI Compatible API" como seu provedor de IA no menu suspenso de provedores.

4Insira sua configuração

Cole a URL do seu endpoint API personalizado no campo "API Endpoint". Insira sua chave API no campo "API Key". Se seu provedor não exigir uma chave API (por exemplo, serviços locais), você pode deixar vazio ou inserir um valor de espaço reservado.

5Selecione modelo e voz

Escolha as configurações de modelo e voz que seu provedor suporta. As opções disponíveis dependem do seu provedor específico. Modelos comuns incluem gpt-4o-realtime-preview ou nomes de modelos específicos do provedor.

6Teste a conexão

Inicie uma sessão de tradução para verificar se tudo está funcionando. Clique no botão Iniciar sessão, fale no microfone e verifique se a conexão é estabelecida com sucesso e se o áudio está sendo traduzido.

O que é a API compatível com OpenAI?

A API compatível com OpenAI é uma opção de provedor genérica que permite ao Sokuji conectar-se a qualquer serviço que implemente o protocolo Realtime API da OpenAI:

• Use qualquer endpoint compatível com OpenAI com uma URL base personalizada
• Suporta serviços hospedados na nuvem e auto-hospedados
• Flexibilidade para alternar entre diferentes provedores backend
• Útil para implantações privadas, otimização de custos ou conformidade regional

Sobre a compatibilidade do provedor

A maioria dos serviços compatíveis com OpenAI suporta apenas a API de Chat Completions. A Realtime API (baseada em WebSocket, com streaming de áudio) é um protocolo diferente e muito poucos provedores a suportam:

• Azure OpenAI Service: Suporta a Realtime API com modelos OpenAI hospedados no Microsoft Azure
• Sempre verifique a documentação do seu provedor para suporte explícito à Realtime API
• Serviços como OpenRouter, Together AI, etc. geralmente NÃO suportam a Realtime API
• Alguns serviços proxy (por exemplo, CometAPI) podem oferecer compatibilidade com Realtime API — verifique antes de usar
• Soluções auto-hospedadas devem implementar o protocolo WebSocket completo da Realtime API

Dicas de configuração

• A URL do endpoint não deve incluir uma barra final (por exemplo, use https://api.example.com e não https://api.example.com/)
• Para serviços locais, use http://localhost:<port> como endpoint
• Alguns provedores podem exigir cabeçalhos específicos ou métodos de autenticação
• Se estiver usando um serviço proxy, certifique-se de que ele encaminha conexões WebSocket corretamente

Problemas comuns

Conexão recusada: Verifique se a URL do endpoint está correta e se o serviço está em execução. Para serviços locais, verifique se o servidor está iniciado e ouvindo na porta esperada.

Erro de autenticação: Verifique novamente sua chave API. Alguns provedores exigem formatos de chave específicos. Certifique-se de que sua conta tenha acesso à Realtime API.

Modelo não encontrado: O nome do modelo pode diferir dos modelos padrão da OpenAI. Consulte a documentação do seu provedor para os nomes de modelos disponíveis.

Conexão WebSocket falhou: Certifique-se de que seu provedor suporta conexões WebSocket para a Realtime API. Endpoints padrão somente HTTP (Chat Completions) não funcionarão.

Verificando a compatibilidade do provedor

1. Verifique se seu provedor suporta explicitamente o protocolo Realtime API da OpenAI
2. Verifique se conexões WebSocket são suportadas (não apenas REST API)
3. Confirme que o provedor suporta streaming de áudio de entrada/saída
4. Teste a URL do endpoint diretamente com um cliente WebSocket, se possível
5. Revise a documentação do provedor para quaisquer requisitos de configuração específicos