Dokumentacja API Kompatybilnego z OpenAI

Wymagania wstępne: SDK i Base URL

Zacznij od zainstalowania preferowanej biblioteki i wskazania jej na nasz punkt końcowy. The base_url jest https://api.apicompatible.com/v1Dokumentacja API kompatybilnego z OpenAI potwierdza, że standardowe biblioteki działają natychmiast. Nie potrzebujesz routera ani złożonej konfiguracji bramy. Zmień URL i klucz, a następnie uruchom istniejący kod.

Uwierzytelnianie: Format nagłówka i klucza

Wyślij swój klucz w Authorization Nagłówek. Użyj formatu Bearer your_api_key. Nasze API używa standardowej struktury klucza API kompatybilnego z OpenAI. Klucze są generowane natychmiastowo poprzez logowanie Google lub e-mail. Chroń swój klucz, ponieważ daje on dostęp do Twojego kredytu wstępnie opłaconego.

Punkt końcowy Uzupełnień Czat

Wysyłaj żądania do /v1/chat/completions. Określ model jako uncensored. API zwraca odpowiedzi tekstowe bezpośrednio. Użyj następującej komendy curl, aby zweryfikować łączność:

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"}]
  }'

To podejście kompatybilne z SDK openai zapewnia nieograniczone generowanie tekstu. Model obsługuje złożone prompty bez niepotrzebnych odmów dla treści prawnych.

Odpowiedzi strumieniowe z SSE

Włącz strumieniowanie, ustawiając stream: true. Odpowiedzi przychodzą za pośrednictwem Server-Sent Events (SSE). Szczegóły użycia tokenów pojawiają się w ostatnim fragmencie. Ta dokumentacja API kompatybilna z OpenAI obsługuje standardowe protokoły strumieniowania. Użyj tego do doświadczeń użytkownika w czasie rzeczywistym:

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)

Strumieniowanie znacząco zmniejsza postrzeganą latencję. Działa bezproblemowo ze standardowymi bibliotekami po stronie klienta.

Parametry: Temperatura, Top-P, Narzędzia

Kontroluj generowanie za pomocą standardowych parametrów. Ustaw temperature dla losowości lub top_p do próbkowania jądra (nucleus sampling). Włącz tools dla wywoływania funkcji. Tryb JSON jest dostępny poprzez response_format. API uncensored model skutecznie respektuje te ograniczenia:

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

Te parametry pozwalają na precyzyjne kontrolowanie stylu wyjścia. Możesz wymusić ścisłe struktury JSON dla przypadków użycia programistycznych.

Limity: Limity Szybkości i Rozmiar Ciała

Każdy klucz pozwala na 300 żądań na minutę. Żądania równoczesne są ograniczone do 8 na klucz. Maksymalny rozmiar ciała żądania wynosi 8 MB. Okno kontekstowe obsługuje łącznie 100,000 tokenów. Obsłuż błędy 401, sprawdzając swój klucz. Rozwiąż błędy 402, doładowując kredyt. Zarządzaj błędami 429, implementując logikę opóźnienia.

Strumieniowanie

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)