Przewodnik szybkiego startu API Nieskażony

Uwierzytelnianie i URL bazowy

Zacznij od wskazania swojego SDK na nasz bazowy adres URL i przekazania klucza w nagłówku autoryzacji. Zapewniamy bezpośrednią usługę jednokrotną bez opłat za routowanie proxy. Użyj standardowego Authorization: Bearer schemat do uwierzytelniania żądań. Twój klucz jest generowany natychmiast po rejestracji przez Google lub e-mail. Upewnij się, że zastąpisz klucz zastępczy w konfiguracji klienta tym wyświetlonym na dashboardzie. Bazowy URL to https://api.uncensoredmodelsollama.com/v1. Ten endpoint obsługuje standardowych klientów kompatybilnych z OpenAI, pozwalając na zmianę dostawcy bez przepisania logiki aplikacji. Chroń swój klucz, ponieważ daje on dostęp do salda kredytu z góry opłaconego.

Punkt końcowy Uzupełnień Czat

Wyślij żądania tekstowe do /v1/chat/completions endpoint do generowania odpowiedzi. Endpoint ten obsługuje standardowe historie konwersacji i prompty systemowe. Musisz określić identyfikator modelu jako uncensored w ciele żądania. API zwraca odpowiedzi w formacie JSON zawierające wygenerowany tekst oraz statystyki użycia tokenów. Błędy, takie jak niewystarczający kredyt lub nieprawidłowy klucz, są zwracane z odpowiednimi kodami statusu HTTP. Używaj tego endpointu do wszystkich standardowych zadań generowania tekstu. Nie obsługuje embeddingów, obrazów ani dostrajania. Zachowaj ładunek poniżej 8 MB, aby zapewnić niezawodne przetwarzanie. Model przetwarza tokeny wejściowe i wyjściowe w ramach wspólnego okna kontekstowego.

Odpowiedzi strumieniowe

Włącz strumieniowanie, ustawiając stream parametru do true w żądaniu. API zwraca Zdarzenia Wysyłane przez Serwer (SSE) zawierające inkrementalne fragmenty tekstu. To podejście redukuje postrzeganą opóźnienie dla użytkowników oczekujących na długie wyjścia. Otrzymujesz informacje o użyciu tokenów w ostatnim fragmencie strumienia. Zaimplementuj handler strumienia w swoim kliencie, aby efektywnie przetwarzać te zdarzenia. Strumieniowanie jest idealne dla interfejsów czatu i aplikacji w czasie rzeczywistym. Upewnij się, że Twoja biblioteka klienta obsługuje parsowanie SSE, aby poprawnie obsługiwać ciągły przepływ danych. Całkowite okno kontekstowe pozostaje 100,000 tokenów niezależnie od trybu strumieniowania.

Wywoływanie funkcji i tryb JSON

Korzystaj z tools parametr włączający możliwości wywoływania funkcji. Zdefiniuj swoje funkcje w ciele żądania, aby umożliwić modelowi zwracanie danych strukturalnych. Ustaw response_format do {"type": "json_object"} dla ścisłego wyjścia JSON. Ta funkcja jest przydatna do ekstrakcji danych lub generowania ładunków strukturalnych. Model obsługuje parametry wyboru narzędzi do kontrolowania zachowania wywoływania funkcji. Użyj tych funkcji, aby zintegrować API z zautomatyzowanymi przepływami pracy. Upewnij się, że definicje Twoich funkcji pasują do oczekiwanego schematu wejściowego dla niezawodnych wyników. API zwraca wywołania narzędzi w standardowym formacie OpenAI dla łatwego parsowania.

Parametry i limity szybkości

Dostosuj zachowanie generowania za pomocą parametrów takich jak temperature, top_p, a także seed. Ustaw max_tokens ograniczenie długości outputu, z wartością domyślną 2,048, jeśli nie zostanie określona. API narzuca limit szybkości 300 żądań na minutę na klucz. Równoczesne żądania są ograniczone do 8 na klucz. Jeśli przekroczysz te limity, API zwróci kod statusu 429. Żądania są rozliczane na podstawie rzeczywistego zużycia tokenów, przy czym błędy i odmowy są darmowe. Kredyt nie wygasa, a kwoty z góry opłacone są przejrzyste. Zarządzaj swoimi kluczami ostrożnie, ponieważ każde konto obsługuje tylko jeden aktywny klucz jednocześnie.

Limity, Błędy i Kontekst

Okno kontekstowe obsługuje 100,000 tokenów dla połączonego wejścia i wyjścia. Żądania przekraczające limit 8 MB treści żądania zakończą się niepowodzeniem. Powszechne błędy obejmują kod 401 dla nieprawidłowych kluczy oraz 402 za niewystarczające środki. Obsłuż te błędy w sposób elegancki w logice swojej aplikacji. API odrzuca żądania zawierające treści seksualne z udziałem małoletnich, niezależnie od innych ustawień. Pozostałe treści pozostają bez cenzury do użytku prawnego osób dorosłych. Monitoruj zużycie tokenów, aby uniknąć nieoczekiwanych opłat. System kredytu z góry opłaconego zapewnia, że płacisz tylko za to, czego używasz. Nie ma opłat subskrypcyjnych ani ukrytych kosztów związanych z Twoją integracją.

cURL

Copycurl https://api.uncensoredmodelsollama.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List all available models in the ollama library."}]
  }'

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

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)