API Documentatie

Snelstart uw eerste verzoek

Begin direct met het genereren van tekst door uw client naar onze basis-URL te wijzen en te authenticeren met een gegenereerde API-sleutel. De interface volgt standaardconventies, zodat je bestaande SDK's kunt gebruiken zonder een nieuw protocol te leren. Je stuurt prompts naar de uncensored model en ontvang tekstantwoorden die geen typische inhoudsfilters toepassen voor wettelijk volwassen gebruik.

Configureer de basis-URL en sleutel

Stel je omgevingsvariabelen in om verzoeken naar ons specifieke eindpunt te routeren. Vervang de plaatsaanduidingssleutel door de sleutel die tijdens het aanmaken is gegenereerd. Dit zorgt ervoor dat alle daaropvolgende aanroepen de juiste uncensored modelinstantie gebruiken.

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

U kunt verifiëren of uw sleutel werkt door het models-eindpunt te controleren. Een geldige sleutel retourneert onmiddellijk de beschikbare model-ID.

Stuur een chat-completieverzoek

Stuur een standaard chat-completion payload om tekst te genereren. Het systeem verwerkt uw input en retourneert het antwoord van het model. Gebruik de uncensored model-ID om ervoor te zorgen dat je de ongefilterde instantie raakt.

De respons bevat de gegenereerde tekst en statistieken over tokengebruik. Je kunt dit direct parseren in de logica van je applicatie.

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"}]
  }'

Controleer op standaard HTTP-statuscodes om succes- of fallopdrachten af te handelen.

Schakel streaming in voor real-time uitvoer

Streamresponsen om de waargenomen latentie voor je gebruikers te verminderen. Schakel streaming in door stream: true in je aanvraaglichaam. De API retourneert een reeks Server-Sent Events (SSE) die gedeeltelijke tokens bevatten.

Aggregeer deze tokens aan de clientkant om het volledige bericht te reconstrueren. Deze aanpak is ideaal voor chatinterfaces waarbij directe feedback belangrijk is. Het laatste SSE-gebevenis bevat het totale tokengebruik voor de aanvraag.

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)

Verwerk verbindingsfouten soepel om een vlotte gebruikerservaring te waarborgen.

Gebruik JSON-modus voor gestructureerde gegevens

Forceer het model om geldige JSON uit te geven voor programmatische verwerking. Stel response_format naar {"type": "json_object"} in je verzoek. Dit vermindert parserfouten en zorgt voor consistente gegevensstructuren.

Gebruik dit voor het genereren van gestructureerde prompts, het extraheren van entiteiten of het bouwen van dynamische inhoud. Het model houdt zich aan de formaatbeperkingen die in je systeem-instructies zijn gegeven. Dit is cruciaal voor betrouwbare integratie met andere diensten.

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);

Valideer de uitvoer-JSON aan je kant om randgevallen op te vangen.

Implementeer function calling

Definieer tools om de mogelijkheden van het model uit te breiden. Stuur een tools array met functie-definities aan het verzoek. Het model kan kiezen om deze functies aan te roepen op basis van de context.

Dit maakt complexe workflows mogelijk waarbij het LLM beslist wanneer het data ophaalt of acties uitvoert. Je ontvangt de functieargumenten in het antwoord en voert ze aan je kant uit. Stuur de resultaten terug naar het model voor verder redeneren.

Instellen tool_choice naar auto voor flexibel beslissingsvorming. Deze functie ondersteunt geavanceerde roleplay-scenario's die toegang tot externe gegevens vereisen.

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)