Dokumentace API

Rychlý start vašeho prvního požadavku

Začněte generovat text ihned nastavením klienta na naši základní URL a autentizací pomocí vygenerovaného API klíče. Rozhraní se řídí standardními konvencemi, takže můžete používat existující SDK bez učení nového protokolu. Budete odesílat prompty na uncensored model a přijímejte textové odpovědi, které neuplatňují běžné filtry obsahu pro použití v zákonné oblasti pro dospělé.

Nastavte základní URL a klíč

Nastavte své proměnné prostředí tak, aby směrovaly požadavky na náš specifický endpoint. Nahraďte zástupný klíč tím, který byl vygenerován při registraci. To zajišťuje, že všechny následné volání používají správnou instanci modelu bez omezení.

• Základní URL: https://api.nsfwlocalllm.com/v1
• Hlavička Auth: Authorization: Bearer YOUR_API_KEY

Ověříte, že váš klíč funguje, zkontrolováním endpointu modelů. Platný klíč okamžitě vrátí dostupné ID modelu.

Pošlete požadavek na chat completion

Standardní payload pro dokončení chatu pro generování textu. Systém zpracuje váš vstup a vrátí odpověď modelu. Použijte uncensored ID modelu pro zajištění, že zasíláte požadavky na nefiltrovanou instanci.

Odpověď zahrnuje vygenerovaný text a statistiky využití tokenů. Tato data můžete přímo parsovat do logiky své aplikace.

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

Hledejte standardní kódy HTTP stavu pro zpracování případů úspěchu nebo selhání.

Povolte streamování pro výstup v reálném čase

Streamujte odpovědi pro snížení vnímané latence pro vaše uživatele. Povolte streamování nastavením stream: true ve vašem těle požadavku. API vrací řadu událostí odeslaných serverem (SSE) obsahujících částečné tokeny.

Tyto tokeny agregujte na straně klienta a rekonstruujte tak zprávu. Tento přístup je ideální pro chatová rozhraní, kde je důležitá okamžitá zpětná vazba. Poslední událost SSE obsahuje celkové využití tokenů pro požadavek.

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)

Gracefully zvládněte chyby připojení pro hladký uživatelský zážitek.

Použijte režim JSON pro strukturovaná data

Vynutit na modelu platný JSON pro programovou spotřebu. Nastavte response_format na {"type": "json_object"} ve vaší žádosti. To snižuje chyby parsování a zajišťuje konzistentné datové struktury.

Použijte toto pro generování strukturovaných promptů, extrakci entit nebo tvorbu dynamického obsahu. Model se řídí omezeními formátu uvedenými ve vašich systémových instrukcích. To je klíčové pro spolehlivou integraci s jinými službami.

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

Ověřte výstupní JSON na vaší straně, abyste zachytili hraniční případy.

Implementujte volání funkcí

Definujte nástroje pro rozšíření možností modelu. Předložte tools pole s definicemi funkcí do požadavku. Model se může rozhodnout tyto funkce volat na základě kontextu.

To umožňuje složité pracovní postupy, kde LLM rozhoduje, kdy načíst data nebo provést akce. V odpovědi získáte argumenty funkce a vykonáte je na své straně. Výsledky předáte zpět modelu pro další uvažování.

Nastavit tool_choice na auto pro flexibilní rozhodování. Tato funkce podporuje pokročilé scénáře roleplay vyžadující přístup k externím datům.

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)