Dokumentace API kompatibilního s OpenAI

Rychlý start: Připojení pomocí SDK OpenAI

Začněte autentizací pomocí vašeho klíče a nastavením klienta na naši základní URL. Toto nastavení funguje s oficiálními SDK OpenAI pro Python a Node.js, což zajišťuje, že můžete spustit stejný klientský kód proti naší službě. Potřebujete platný API klíč z dashboardu a správnou konfiguraci endpointu.

Copycurl https://api.openaiapicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Return the current UTC timestamp in ISO 8601 format"}]
  }'

Copyfrom openai import OpenAI

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

Copyimport OpenAI from "openai";

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

Endpoint Chat Completions

Odeslat text do našeho jediného koncového bodu chatu pro přímý textový výstup. Používáme POST /v1/chat/completions k zpracování vašich podnětů a vrácení vygenerovaného textu. Toto je základní interakce pro většinu aplikací LLM, která nevyžaduje složité směrování ani další volání služeb.

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)

Streamování s SSE

Získejte tokeny v reálném čase pomocí Server-Sent Events pro nižší latenci. Povolte streamování nastavením parametru stream na true ve vašem požadavku. Poslední část obsahuje údaje o spotřebě tokenů, což vám umožňuje přesně sledovat náklady, jak model generuje text. Tento přístup udržuje vaše uživatelské rozhraní responzivní i pro dlouhé výstupy.

Volání funkcí & Režim JSON

Integrujte nástroje a vynutte strukturované výstupy pro spolehlivé programové interakce. Použijte parametr tools pro definování schémat funkcí a nastavte response_format na json_object pro přísnou shodu s JSON. Náš model bez omezení zvládá složité pokyny a hraniční případy bez odmítání platných funkčních požadavků.

Limity rychlosti & Parametry

Sledujte své využití vzhledem k přísným limitům na klíč, abyste předešli přerušení služby. Je vám povoleno 300 požadavků za minutu a osm souběžných požadavků na klíč s limitem těla 8 MB. Chyby jako 401 (neplatný klíč), 402 (žádný kredit) a 429 (limit rychlosti) indikují konkrétní stavy účtu.

Okno kontextu & Omezení

Zvyšte zpracování kontextu pomocí 100 000tokenového okna pro kombinovaný vstup a výstup. Nastavte max_tokens pro řízení délky generování, výchozí hodnota je 2 048, pokud není uvedeno. Náš model běží na vlastních serverech, nikoli jako proxy pro jiné dodavatele, což zajišťuje konzistentní výkon pro váš konkrétní případ použití.