Dokumentacja API & Szybki Start

Bazowy URL i autoryzacja

Zacznij od ustawienia adresu bazowego na HTTPS://api.uncensoredal.com/v1 i przekazania swojego klucza API w nagłówku Authorization. Otrzymujesz jeden aktywny klucz na konto, a wygenerowanie nowego klucza natychmiast unieważnia poprzedni. Ten prosty setup działa z dowolnym standardowym klientem kompatybilnym z OpenAI bez złożonej logiki trasowania.

Copycurl https://api.uncensoredal.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate the next 50 lines of a python script"}]
  }'

Punkt końcowy służy ściśle do uzupełniania czatu, więc nie musisz zarządzać routingiem modeli. Każde żądanie musi zawierać identyfikator modelu "uncensored", aby upewnić się, że trafiasz na właściwy serwer wnioskowania. Niepowodzenia uwierzytelnienia zwracają status 401, jeśli klucz jest nieobecny lub nieprawidłowy.

Punkt końcowy Uzupełnień Czat

Wyślij żądanie POST do /v1/chat/completions z historią swoich wiadomości w tablicy messages. System przetwarza dane wejściowe tekstowe i zwraca wygenerowany tekst bez odmów treści dla legalnego użytku dorosłego. Musisz określić model jako "uncensored" w swoim payloadzie, aby zapewnić kompatybilność.

Copyfrom openai import OpenAI

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

Żądania są rozliczane na podstawie rzeczywistego zużycia tokenów, przy czym błędy i odmowy są bezpłatne. Ten model z góry opłacony oznacza, że płacisz tylko za to, czego używasz. Punkt końcowy obsługuje standardowe parametry takie jak temperature i top_p do kontrolowania losowości wyjścia.

Odpowiedzi strumieniowe z SSE

Włącz strumieniowanie, ustawiając stream na true w ciele żądania, aby otrzymywać tokeny poprzez zdarzenia wysyłane przez serwer. Każdy fragment zawiera statystyki zużycia tokenów w ostatnim fragmencie, pozwalając na śledzenie kosztów w czasie rzeczywistym. To podejście zmniejsza postrzeganą latencję dla długich generacji.

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)

Korzystaj ze strumieniowania podczas budowania interfejsów czatowych, które muszą wyświetlać tekst w miarę jego generowania. API zwraca standardowe zdarzenia strumieniowe zgodne z OpenAI, co ułatwia integrację z istniejącymi bibliotekami UI. Możesz wcześnie zatrzymać strumień, jeśli użytkownik zmieni swoje wejście.

Wywoływanie funkcji i tryb JSON

Zdefiniuj narzędzia w żądaniu, aby włączyć wywoływanie funkcji lub wymusić output JSON za pomocą response_format. API obsługuje tool_choice dla precyzyjnej kontroli nad tym, kiedy model powinien wywołać funkcję. Funkcja ta działa ze standardowym schematem OpenAI, więc możesz ponownie wykorzystać istniejące definicje narzędzi.

Copyimport OpenAI from "openai";

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

Tryb JSON zapewnia, że wyjście jest poprawnym JSON, co jest przydatne do parsowania strukturalnych danych programistycznie. Możesz połączyć to z ustawieniami temperatury, aby zbalansować kreatywność z niezawodnością strukturalną. API obsługuje logikę wykonywania narzędzi, zwracając szczegóły wywołania funkcji do przetworzenia przez Twój kod.

Konfiguracja parametrów modelu

Skonfiguruj parametry takie jak temperatura, top_p, sekwencje stop oraz seed, aby kontrolować zachowanie generowania. Okno kontekstowe obsługuje 100 000 tokenów dla promptu i uzupełnienia łącznie. Maksymalna długość odpowiedzi jest ograniczona do 16 000 tokenów na żądanie lub do 2 048, jeśli nie określisz max_tokens.

Możesz użyć presence_penalty i frequency_penalty, aby zmniejszyć powtarzalność w dłuższych tekstach. Parametry te pozwalają na dostrajanie stylu modelu bez zmiany podstawowych wag. Dostosowuj je stopniowo, aby znaleźć odpowiedni balans dla Twojego konkretnego przypadku użycia.

Limity, Błędy i Kontekst

Limity szybkości wynoszą 300 żądań na minutę i 8 jednoczesnych żądań na klucz. Rozmiary ciał żądań są ograniczone do 8 MB, więc duże okna kontekstowe muszą być zarządzane ostrożnie. Błędy obejmują 401 dla nieprawidłowych kluczy, 402 dla niewystarczającego kredytu oraz 429 dla przekroczenia limitu szybkości.

Kredyt nie wygasa, więc możesz wstrzymać użycie między falami pracy bez utraty środków. Jeśli osiągniesz limit współbieżności, ponów próbę z wykładniczym opóźnieniem. Okno kontekstu 100,000 tokenów pozwala na przechowywanie rozległej historii, ale zwracaj uwagę na limity outputu, aby uniknąć obcinania tekstu.