API Dokumentation

Hurtigstart din første anmodning

Start med at generere tekst med det samme ved at pege din klient mod vores base-URL og autentificere med en genereret API-nøgle. Grænsefladen følger standardkonventioner, så du kan bruge eksisterende SDK'er uden at lære en ny protokol. Du sender prompts til uncensored model og modtag tekstresponses, der ikke anvender typiske indholdsfiltere til lovligt voksenbrug.

Konfigurér base URL og nøgle

Indstil dine miljøvariabler til at dirigerer anmodninger til vores specifikke endpoint. Erstat pladsholder-nøglen med den, der blev genereret under tilmelding. Dette sikrer, at alle efterfølgende opkald bruger den korrekte uncensored-modelinstans.

• Base URL: https://api.nsfwlocalllm.com/v1
• Auth Header: Authorization: Bearer YOUR_API_KEY

Du kan verificere, at din nøgle fungerer, ved at tjekke models-endepunktet. En gyldig nøgle returnerer den tilgængelige model-ID med det samme.

Send en chat-completion-anmodning

Send en standard chat completion payload for at generere tekst. Systemet processor dit input og returnerer modellens svar. Brug uncensored model-ID for at sikre, at du rammer den ufiltrerede instans.

Svaret inkluderer den genererede tekst og tokenforbrugsstatistikker. Du kan parse dette direkte ind i din applikationslogik.

Copycurl https://api.nsfwlocalllm.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Send me the server uptime stats"}]
  }'

Tjek for standard HTTP-statuskoder til at håndtere succes- eller fejltilfælde.

Aktivér streaming til realtidsoutput

Stream-svar for at reducere den opfattede latens for dine brugere. Aktiver streaming ved at indstille stream: true i din anmodningskrop. API'et returnerer en række Server-Sent Events (SSE), der indeholder delvise tokens.

Aggreger disse tokens på klientsiden for at rekonstruere den fulde besked. Denne tilgang er ideel til chatgrænseflader, hvor øjeblikkelig feedback er vigtig. Den sidste SSE-hbegivenhed indeholder det samlede tokenforbrug for forespørgslen.

Copyfrom openai import OpenAI

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

Håndter forbindelsesfejl fejlfrit for at sikre en jævn brugeroplevelse.

Brug JSON-tilstand til strukturerede data

Tving modellen til at udskrive gyldig JSON til programmatisk forbrug. Indstil response_format til {"type": "json_object"} i din anmodning. Dette reducerer parsingfejl og sikrer konsistente datastrukturer.

Brug dette til at generere strukturerede prompts, udtrække enheder eller opbygge dynamisk indhold. Modellen overholder formatbegrænsningerne angivet i dine systeminstruktioner. Dette er afgørende for pålidelig integration med andre tjenester.

Copyimport OpenAI from "openai";

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

Valider output-JSON'en på din side for at fange eventuelle kanttilfælde.

Implementer funktionkald

Definer værktøjer for at udvide modellens funktionalitet. Send en tools array med funktionsdefinitioner til forespørgslen. Modellen kan vælge at kalde disse funktioner baseret på konteksten.

Dette muliggør komplekse workflows, hvor LLM'en beslutter, hvornår den skal hente data eller udføre handlinger. Du modtager funktionsargumenterne i svaret og eksekverer dem på din side. Send resultaterne tilbage til modellen til yderligere ræsonnement.

Indstil tool_choice til auto til fleksibel beslutningstagning. Denne funktion understøtter avancerede rollespilsscenarier, der kræver adgang til ekstern data.

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)