Dokumentace API kompatibilní s OpenAI

Požadavky: SDK a základní URL

Začněte instalací preferované knihovny a nastavením jejího cíle na náš koncový bod. The base_url je https://api.apicompatible.com/v1. Dokumentace k této kompatibilní s OpenAI API potvrzuje, že standardní knihovny fungují okamžitě. Nepotřebujete router ani složité nastavení brány. Změňte URL a klíč, poté spusťte svůj existující kód.

Ověření: Formát hlavičky a klíče

Pošlete svůj klíč v Authorization hlavička. Použijte formát Bearer your_api_key. Naše API používá standardní strukturu klíčů kompatibilních s OpenAI. Klíče se generují okamžitě přes přihlášení Google nebo e-mailem. Uchovávejte svůj klíč v bezpečí, protože uděluje přístup k vašemu předplacenému kreditu.

Endpoint Chat Completions

Pošlete požadavky na /v1/chat/completions. Specifikujte model jako uncensored. API vrací textové odpovědi přímo. Použijte následující příkaz curl pro ověření připojení:

Copycurl https://api.apicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List available models"}]
  }'

Tento přístup kompatibilní s OpenAI SDK zajišťuje, že získáte neomezené generování textu. Model zvládne složité dotazy bez zbytečných odmítnutí u zákonného obsahu.

Streamované odpovědi s SSE

Povolte streamování nastavením stream: true. Odpovědi přichávají prostřednictvím Server-Sent Events (SSE). Podrobnosti o spotřebě tokenů se objeví v posledním chunku. Tato kompatibilní dokumentace API OpenAI podporuje standardní streamovací protokoly. Použijte to pro zážitky v reálném čase:

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.apicompatible.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)

Streamování výrazně snižuje vnímanou latenci. Bezproblémově funguje se standardními knihovnami na straně klienta.

Parametry: Teplota, Top-P a Tools

Ovládejte generování pomocí standardních parametrů. Nastavte temperature pro náhodnost nebo top_p pro nucleus sampling. Povolte tools pro volání funkcí. Režim JSON je k dispozici přes response_format. The uncensored model efektivně respektuje tato omezení:

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.apicompatible.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);

Tyto parametry umožňují jemné ladění stylu výstupu. Můžete vynutit přísné struktury JSON pro případ použití v programech.

Limity: Limity rychlosti a velikost těla

Každý klíč umožňuje 300 požadavků za minutu. Souběžné požadavky jsou omezeny na 8 na klíč. Maximální velikost těla požadavku je 8 MB. Kontextové okno podporuje celkem 100,000 tokenů. Chyby 401 řešte kontrolou klíče. Chyby 402 řešte doplněním kreditu. Chyby 429 řešte implementací logiky backoff.

Streamování

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)