Dokumentacja API: Szybki start

Bazowy URL i uwierzytelnianie

API serverless llm używa standardowej struktury endpointu kompatybilnej z OpenAI. Aby rozpocząć, potrzebujesz dwóch informacji: bazowego URL i swojego klucza API.

Użyj następującego bazowego URL dla wszystkich zapytań:

https://api.serverlessllmapi.com/v1

Uwierzytelnianie jest obsługiwane za pomocą nagłówka Authorization. Załóż konto na stronie Uzyskanie klucza API, aby otrzymać swój klucz. Możesz go wygenerować ponownie w dowolnym momencie, co natychmiast unieważnia poprzedni. Chroń swój klucz, ponieważ zapewnia bezpośredni dostęp do przedpłaconego kredytu.

Pierwsze zapytanie: Uzupełnienia czatu

Wyślij standardowe zapytanie o uzupełnienie czatu do endpointu /v1/chat/completions. API przyjmuje nazwę modelu, listę wiadomości i parametry opcjonalne. Naszym domyślnym ID modelu jest uncensored, zoptymalizowany pod kątem wysokiej jakości, nieograniczonych odpowiedzi.

Oto podstawowy przykład użycia curl do wygenerowania odpowiedzi:

Copycurl https://api.serverlessllmapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

Odpowiedź ma standardowy format JSON OpenAI. Jeśli zapytanie powiedzie się, otrzymasz obiekt uzupełnienia zawierający wygenerowany tekst. Ta prostota pozwala na podmianę naszego endpointu w istniejących konfiguracjach SDK OpenAI poprzez prostą zmianę bazowego URL i klucza.

Integracja z SDK Pythona

Użycie oficjalnego SDK Pythona OpenAI to najszybszy sposób na integrację. Ponieważ nasze API jest kompatybilne z OpenAI, musisz tylko nadpisać bazowy URL i klucz API. Dzięki temu istniejący kod działa bez modyfikacji.

Copyfrom openai import OpenAI

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

To podejście pozwala wykorzystać znane biblioteki Pythona, czerpiąc korzyści z naszego modelu bez cenzury. Okno kontekstu obsługuje do 100 000 tokenów, co pozwala na dużą długość danych wejściowych i wyjściowych w jednym zapytaniu. Upewnij się, że tablica wiadomości zawiera niezbędne prompty systemowe i użytkownika, aby skutecznie kierować modelem.

Integracja z SDK Node.js

Dla programistów JavaScript i TypeScript SDK Node.js OpenAI zapewnia prostą ścieżkę integracji. Skonfiguruj klienta z naszym bazowym URL i kluczem API, aby rozpocząć wysyłanie zapytań.

Copyimport OpenAI from "openai";

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

To rozwiązanie jest idealne dla funkcji bezserwerowych lub usług backendowych wymagających interakcji LLM w czasie rzeczywistym. Model cenowy pay-as-you-go oznacza, że płacisz tylko za to, czego używasz, bez miesięcznych subskrypcji. Kredyty nie wygasają, więc możesz wstrzymać użytkowanie między projektami bez utraty salda.

Odpowiedzi strumieniowe (SSE)

Włącz strumieniowanie, ustawiając stream: true w swoim zapytaniu. API zwróci strumień Server-Sent Events (SSE), pozwalający wyświetlać tokeny w miarę ich generowania. Zmniejsza to postrzeganą latencję dla użytkowników końcowych i poprawia doświadczenie w aplikacjach czatu.

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)

Obsłuż zdarzenia strumienia w kodzie klienta, aby zebrać ostateczną odpowiedź. Strumieniowanie działa zarówno z SDK Pythona, jak i Node.js przy poprawnej konfiguracji. Funkcja ta jest szczególnie przydatna przy generowaniu treści długich, gdzie natychmiastowa informacja zwrotna jest cenna.

Limity zapytań i ograniczenia

Zrozum ograniczenia, aby zapewnić płynną integrację. API narzuca limit zapytań na poziomie 300 zapytań na minutę na klucz API. Ciało każdego zapytania nie może przekraczać 8 MB. Jeśli przekroczysz limit zapytań, otrzymasz kod statusu 429.

Błędy uwierzytelniania zwracają status 401, wskazując na nieprawidłowy lub unieważniony klucz. Jeśli przedpłacony kredyt zostanie wyczerpany, zapytania zwrócą status 402. ID modelu uncensored nie obsługuje osadzania (embeddings), generowania obrazów ani dostrajania (fine-tuning). Trzymaj się uzupełnień czatu opartych na tekście dla optymalnej wydajności.