Podsumowanie specyfikacji
Jeśli masz już kod komunikujący się z OpenAI, krótkie streszczenie specyfikacji API kompatybilnego z OpenAI brzmi tak: zmień Base URL, zmień klucz, ustaw model na uncensored. Ciała żądań i odpowiedzi odpowiadają formatowi completions czatu, więc SDK parsują je bez zmian.
| Pozycja | Wartość |
|---|---|
| Bazowy URL | https://api.unrestrictedaiapi.com/v1 |
| Autoryzacja | Authorization: Bearer YOUR_KEY |
| Endpointy | POST /v1/chat/completions, GET /v1/models |
| ID modelu | uncensored |
| Okno kontekstu | 100 000 tokenów, prompt plus completion |
| Maksymalna treść zapytania | 8 MB |
| Wyjście | Tylko tekst |
Model to pojedynczy model o otwartych wagach uruchamiany przez niezależnego dostawcę i dostrojony do odpowiadania bez odmów na podstawie treści dla zgodnego z prawem użytku przez dorosłych. Nie jest to oficjalny endpoint żadnego dostawcy modeli i nie przekieruje ruchu między dostawcami. Dlatego istnieje tylko jedno ID modelu i lista modeli jest krótka.
Endpointy
GET /v1/models
Zwraca modele dostępne dla Twojego klucza. To najtańszy sposób potwierdzenia, że Twój klucz i Base URL są poprawne, a wiele klientów UI wywołuje go, aby wypełnić listę rozwijaną.
curl https://api.unrestrictedaiapi.com/v1/models \
-H "Authorization: Bearer $KEY"
POST /v1/chat/completions
Jedyny endpoint generowania. Wysyłasz tablicę messages obiektów z role (system, user, assistant lub tool) i content, a także model i dowolne opcje próbkowania. Minimalne wywołanie:
curl https://api.unrestrictedaiapi.com/v1/chat/completions \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [
{"role": "system", "content": "Answer in one sentence."},
{"role": "user", "content": "What is a base URL?"}
]
}'
Odpowiedź zawiera wygenerowany tekst w choices[0].message.content i liczniki tokenów w usage. Te liczniki są podstawą do rozliczeń.
Nie oferowane: legacy endpoint completions, embeddingi, endpointy obrazów, audio i wideo, fine-tuning i endpointy plików. Klient, który je wywoła, otrzyma błąd, więc wyłącz te funkcje w narzędziach, które domyślnie z nich korzystają.
Parametry zapytania
Te parametry są akceptowane i przekazywane do modelu:
temperatureitop_pdo próbkowania.stopdla jednej lub więcej sekwencji zatrzymujących.seeddla powtarzalnego próbkowania, gdy utrzymujesz równe pozostałe parametry.presence_penaltyifrequency_penalty, aby zmniejszyć powtarzalność.max_tokens, który jest opcjonalny. Jeśli go nie podasz, uzupełnienie może wykorzystać resztę okna 100 000 tokenów.streamdla zdarzeń wysłanych przez serwer.toolsitool_choicedo wywoływania funkcji.response_formatz{"type":"json_object"}dla trybu JSON.
Dwie praktyczne uwagi. Po pierwsze, okno liczy prompt i uzupełnienie razem, więc prompt 90 000 tokenów pozostawia około 10 000 tokenów na odpowiedź. Po drugie, limit treści żądania wynosi 8 MB, co jest znacznie więcej niż potrzeba na 100 000 tokenów tekstu, więc osiągniesz go tylko poprzez osadzenie dużych zakodowanych ładunków w wiadomościach.
Strumieniowanie
Ustaw stream: true, a odpowiedź przybędzie jako zdarzenia wysłane przez serwer. Każde zdarzenie to fragment JSON z delta zawierającym kolejną część tekstu, a użycie jest raportowane na końcu strumienia. SDK ukrywają ramowanie; przy surowym protokole czytasz linie zaczynające się od data:, aż strumień się zamknie.
from openai import OpenAI
client = OpenAI(base_url="https://api.unrestrictedaiapi.com/v1", api_key="YOUR_KEY")
with client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "List five HTTP status codes."}],
stream=True,
) as stream:
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="")
Jedna reguła wpływa na planowanie pojemności: strumieniowane zapytanie zajmuje slot współbieżności do końca strumienia, a nie do pierwszego tokena. Jeśli klient zablokuje się podczas czytania, utrzymuje slot zajęty. Zawsze zamykaj lub kończ strumień i ustaw limit czasu klienta.
Wywoływanie narzędzi i tryb JSON
Wywoływanie funkcji
Przekaż tools jako listę definicji funkcji z parametrami JSON Schema. Jeśli model zdecyduje się wywołać jedną, wiadomość zawiera tool_calls, które również są strumieniowane, gdy stream jest włączony. Uruchamiasz funkcję i zwracasz jej wynik jako wiadomość z role: "tool" i pasującym tool_call_id. Użyj tool_choice, aby wymusić konkretną funkcję lub pozostawić decyzję modelowi.
{
"model": "uncensored",
"messages": [{"role": "user", "content": "Weather in Oslo?"}],
"tools": [{
"type": "function",
"function": {
"name": "get_weather",
"description": "Current weather for a city",
"parameters": {
"type": "object",
"properties": {"city": {"type": "string"}},
"required": ["city"]
}
}
}]
}
Model proponuje argumenty; nie wykonuje niczego. Zweryfikuj je przed podjęciem działania, jak w przypadku dowolnego wejścia użytkownika.
Tryb JSON
Dodaj "response_format": {"type": "json_object"}, aby poprosić o pojedynczy poprawny obiekt JSON. Podobnie jak w innych implementacjach w stylu OpenAI, wskaż w prompcie, jakie klucze chcesz, np. "Zwróć obiekt z kluczami title i tags". Sparsuj wynik w bloku try/catch i zachowaj max_tokens na wysokim poziomie, aby długi obiekt nie został obcięty.
Limity, nagłówki i błędy
| Typ klucza | Żądania współbieżne | Zapytania na minutę |
|---|---|---|
| Pełny klucz | 8 | 300 |
| Klucz próbny | 2 | 60 |
Każda odpowiedź zawiera X-Request-Id (cytuj go, gdy kontaktujesz się z wsparciem), X-Balance-USD (twój pozostały kredyt), X-RateLimit-Limit-Requests i X-RateLimit-Limit-Concurrency.
Gdy przekroczysz limit, API zwraca HTTP 429. Kod błędu rozdziela przypadki:
rate_limited: za dużo zapytań w minutę. Zwolnij lub rozłóż obciążenie.concurrency: za dużo zapytań w locie w tym samym czasie. Kolejkuj je po swojej stronie.- 429 z nagłówkiem
Retry-After: 5: tymczasowe przeciążenie. Poczekaj pięć sekund i ponów żądanie.
import time
import httpx
def post_with_retry(payload, key, tries=4):
# payload example: {"model": "uncensored", "messages": [...]}
for attempt in range(tries):
r = httpx.post(
"https://api.unrestrictedaiapi.com/v1/chat/completions",
headers={"Authorization": "Bearer " + key},
json=payload,
timeout=120,
)
if r.status_code == 429:
wait = int(r.headers.get("Retry-After", 2 ** attempt))
time.sleep(wait)
continue
return r
return r
Żądania, które zakończą się niepowodzeniem lub zostaną odrzucone, nie są rozliczane.
Role, historia i obiekt odpowiedzi
API jest bezstanowe. Nie pamięta wcześniejszych zapytań, więc rozmowa istnieje tylko jako tablica messages, którą wysyłasz za każdym razem. Typowa historia zaczyna się od jednej wiadomości system, która ustawia zachowanie, po której następują naprzemienne wiadomości user i assistant. Gdy w grę wchodzi wywoływanie narzędzi, między nimi pojawiają się wiadomości tool, każda powiązana z wywołaniem, na które odpowiada, poprzez tool_call_id.
Ma to dwa skutki. Pierwszy to koszt: każda tura płaci za całą historię jako dane wejściowe, więc długi czat staje się droższy na wiadomość, nawet jeśli każde pytanie jest krótkie. Drugi to kontrola: możesz edytować, przycinać lub nadpisywać historię wedle uznania. Usunięcie najstarszych tur, zastąpienie ich podsumowaniem lub wstrzyknięcie poprawionej wiadomości asystenta to zwykłe operacje, a model traktuje to, co wyślesz, jako prawdę.
Po powrocie przeczytaj trzy rzeczy. choices[0].message zawiera tekst lub wywołania narzędzi. choices[0].finish_reason mówi, dlaczego generowanie się zakończyło: naturalny koniec, limit tokenów lub wywołanie narzędzia. usage zawiera liczby tokenów prompt, uzupełnienia i całkowite. Jeśli powód zakończenia mówi, że limit tokenów został przekroczony, tekst jest ucięty, a powinieneś albo podnieść limit, albo poprosić model o kontynuację w kolejnej turze.
Krótka lista kompatybilności
Przed wdrożeniem klienta dla tego endpointu przejdź przez te sprawdzenia. Wyłapują większość problemów z integracją w kilka minut.
- Wywołaj
GET /v1/modelsze swoim kluczem i potwierdź, że otrzymujesz listę zawierającąuncensored. - Wyślij zwykłe zapytanie czatu bez opcji i potwierdź normalną odpowiedź z blokiem
usage. - Powtórz to z
stream: truei potwierdź, że twój klient obsługuje koniec strumienia i końcowe dane użycia. - Jeśli używasz narzędzi, wyślij pełną pętlę wywołania narzędzia od początku do końca, w tym zapytanie następcze z wiadomością
tool. - Wyślij 10 żądań jednocześnie na kluczu próbnym i potwierdź, że twój kod radzi sobie z błędem 429, który następuje po drugim równoległym żądaniu.
- Loguj
X-Request-Iddla każdego wywołania, aby każdy dziwny wynik można było później prześledzić.
Zaliczenie wszystkich sześciu oznacza, że twój klient jest gotowy do ruchu produkcyjnego.
Gdzie to różni się od pełnej platformy OpenAI
Kompatybilność oznacza protokół czatu, a nie całą platformę. Wszystko poza czatem tekstowym jest nieobecne, a kilka zachowań pochodzi od modelu, a nie od protokołu. Nazwa modelu jest stała, odpowiedzi mogą różnić się stylem od dowolnego modelu, którego używałeś wcześniej, a próbkowanie z tym samym seed jest powtarzalne tylko dopóki prompt i parametry pozostają takie same.
Jedną niezmienną zasadą jest blokada treści seksualnych z udziałem nieletnich. Poza tym model jest dostrojony, aby unikać odmów dla legalnego użytku dorosłych, a prompty nie są wykorzystywane do trenowania.
Kod w pięciu językach znajdziesz w szybkim starcie, techniki promptowania przeczytasz w promptowaniu modelu bez ograniczeń, a po stronie konta cennik podaje stawki: $0,15 za 1 mln tokenów wejściowych i $0,50 za 1 mln tokenów wyjściowych, przy czym kredyt nigdy nie wygasa. dokumentacja zawiera tę samą specyfikację w skróconej formie.
