Início Rápido da API Compatível com OpenAI

Pré-requisitos e Configuração do Ambiente

Você precisa de uma chave de API e do URL base correto para conectar seu cliente. Cadastre-se com Google ou e-mail na página Get API key para receber sua credencial imediatamente. O teste oferece $0.50 por sete dias, e você pode recarregar com USDT ou USDC via criptomoeda. Mantenha sua chave segura e verifique se ela corresponde às configurações da sua conta.

Certifique-se de que seu ambiente suporte solicitações HTTP padrão. Nosso serviço roda em um único modelo uncensored, então você não precisa gerenciar múltiplos endpoints de modelos. Defina sua URL base para HTTPS://api.openaiapicompatibility.com/v1 antes de fazer qualquer chamada. Isso garante que todas as solicitações sejam roteadas corretamente para nossos servidores de inferência ajustados.

Instalando o SDK Oficial da OpenAI

Use os SDKs oficiais para manter a compatibilidade com os fluxos de trabalho existentes do OpenAI. As bibliotecas Python e Node funcionam diretamente com nosso endpoint porque seguimos o esquema de API padrão. Instale o pacote no diretório do seu projeto usando seu gerenciador de pacotes preferido. Esta abordagem evita a necessidade de código de cliente HTTP personalizado.

Suportamos parâmetros padrão como temperature, top_p e sequências de parada. O SDK lida com a serialização JSON e os cabeçalhos da solicitação automaticamente. Você pode alterar a URL base na configuração do cliente para apontar para nossos servidores. Isso permite que você alterne entre provedores sem alterar a lógica do seu aplicativo.

Configurando a URL Base e a Chave de API

Defina a URL base e a chave da API no seu objeto de configuração do cliente. A URL base é HTTPS://api.openaiapicompatibility.com/v1. Passe sua chave da API no cabeçalho Authorization como um token Bearer. Essa configuração garante que suas solicitações sejam autenticadas e roteadas para o serviço correto.

Copycurl https://api.openaiapicompatibility.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list all python packages for data science"}]
  }'

Verifique sua conexão chamando o endpoint GET /v1/models. Isso retorna uma lista de modelos disponíveis, incluindo o identificador do modelo uncensored. Use este passo para confirmar que seu acesso à rede e as credenciais estão corretos antes de enviar prompts complexos.

Fazendo sua primeira solicitação de conclusão de chat

Envie uma solicitação POST para /v1/chat/completions com suas mensagens de prompt. Defina o modelo como uncensored para acessar o mecanismo de inferência sem filtros. Inclua seu prompt de sistema para definir o comportamento e adicione mensagens do usuário para o conteúdo que deseja gerar.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.openaiapicompatibility.com/v1", api_key="YOUR_KEY")

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

A resposta contém o texto gerado e as estatísticas de uso de tokens. Você pode ajustar parâmetros como temperatura para controlar a criatividade. O modelo não recusa tópicos adultos legais ou controversos, tornando-o adequado para diversos casos de uso. Verifique o objeto de resposta para o campo content para acessar a saída.

Respostas em Streaming com SSE

Ative o streaming definindo o parâmetro stream como true na sua solicitação. Isso envia respostas parciais como Server-Sent Events (SSE). Melhora a experiência do usuário mostrando o texto conforme é gerado.

Copystream = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Tell the story in second person."}],
    stream=True,
)
for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)

Cada chunk contém um delta da resposta. Acumule esses deltas para reconstruir o texto completo. O último chunk inclui o uso total de tokens da requisição. Esse método funciona com qualquer cliente ou biblioteca SSE padrão. Ele reduz a latência percebida para a geração de conteúdo longo.

Lidando com Modo JSON e Chamada de Função

Use o modo JSON definindo response_format como json_object. Isso força o modelo a gerar JSON válido em vez de texto livre. É útil para extração de dados estruturados ou respostas de API. Combine isso com chamada de funções para cenários de uso de ferramentas.

Defina suas ferramentas no array tools. Especifique o nome da função, descrição e parâmetros. O modelo retornará os detalhes da chamada da função na resposta. Você pode então executar a função e enviar o resultado de volta para o modelo. Isso permite fluxos de trabalho complexos em várias etapas com o modelo uncensored.

Node.js

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.openaiapicompatibility.com/v1", apiKey: process.env.API_KEY });

const resp = await client.chat.completions.create({
  model: "uncensored",
  messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);