Dokumentacja API kompatybilnego z OpenAI

Szybki start: Połączenie z SDK OpenAI

Zacznij od uwierzytelnienia się za pomocą swojego klucza i wskazania klienta na nasz podstawowy URL. Ta konfiguracja działa z oficjalnymi SDK OpenAI dla Pythona i Node.js, zapewniając, że możesz uruchomić ten sam kod klienta wobec naszej usługi. Potrzebujesz ważnego klucza API z panelu sterowania i poprawnej konfiguracji endpointa.

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);

Punkt końcowy Uzupełnień Czat

Wyślij tekst do naszego pojedynczego punktu końcowego czatu, aby uzyskać bezpośredni output tekstowy. Używamy POST /v1/chat/completions do przetwarzania Twoich promptów i zwracania wygenerowanego tekstu. Jest to podstawowa interakcja dla większości aplikacji LLM, nie wymagająca skomplikowanego routingu ani dodatkowych wywołań usług.

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)

Strumieniowanie z SSE

Otrzymuj tokeny w czasie rzeczywistym za pomocą Server-Sent Events dla niższego opóźnienia. Włącz strumieniowanie, ustawiając parametr strumienia na true w swoim żądaniu. Ostatni fragment zawiera dane o zużyciu tokenów, pozwalając na dokładne śledzenie kosztów w miarę generowania tekstu przez model. To podejście utrzymuje responsywność interfejsu UI nawet dla długich wyjść.

Wywoływanie funkcji & Tryb JSON

Zintegruj narzędzia i wymuś strukturalne wyjścia dla niezawodnych interakcji programistycznych. Użyj parametru tools do zdefiniowania schematów funkcji i ustaw response_format na json_object dla ścisłej zgodności z JSON. Nasz model bez cenzury radzi sobie ze złożonymi instrukcjami i przypadkami brzegowymi bez odmowy poprawnych żądań funkcjonalnych.

Limity prędkości & parametry

Monitoruj swoje użycie względem ścisłych limitów na klucz, aby uniknąć przerw w usłudze. Masz dozwolone 300 żądań na minutę i osiem żądań równoległych na klucz, z limitem ciała 8 MB. Błędy takie jak 401 (nieprawidłowy klucz), 402 (brak kredytu) i 429 (limit prędkości) wskazują konkretne stany konta.

Okno kontekstu i ograniczenia

Zmaksymalizuj obsługę kontekstu dzięki oknu o rozmiarze 100 000 tokenów dla danych wejściowych i wyjściowych. Ustaw max_tokens, aby kontrolować długość generowania, z wartością domyślną 2 048, jeśli nie zostanie określona. Nasz model działa na własnych serwerach, a nie jako proxy dla innych dostawców, zapewniając spójną wydajność dla Twojego konkretnego przypadku użycia.