Documentație API

Începe rapid cu prima cerere

Începe generarea de text imediat indicând clientul tău către URL-ul nostru de bază și autentificându-te cu o cheie de API generată. Interfața urmează convenții standard, astfel încât poți folosi SDK-uri existente fără a învăța un protocol nou. Vei trimite prompturi la uncensored model și primești răspunsuri text care nu aplică filtrele tipice de conținut pentru uz adult legal.

Configurează URL-ul de bază și cheia

Configurați variabilele de mediu pentru a ruta solicitările către endpoint-ul nostru specific. Înlocuiți cheia placeholder cu cea generată la înregistrare. Acest lucru asigură că toate apelurile ulterioare utilizează instanța corectă a modelului uncensored.

• URL de bază: https://api.nsfwlocalllm.com/v1
• Header Auth: Authorization: Bearer YOUR_API_KEY

Poți verifica dacă cheia ta funcționează verificând endpoint-ul modelelor. O cheie validă returnează ID-ul modelului disponibil imediat.

Trimiteți o cerere de completare chat

Trimiteți un payload standard de completare chat pentru a genera text. Sistemul procesează intrarea dumneavoastră și returnează răspunsul modelului. Utilizați uncensored ID-ul modelului pentru a te asigura că atingi instanța fără filtre.

Răspunsul include statistici de utilizare a tokenilor și textul generat. Poți analiza acest lucru direct în logica aplicației tale.

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

Verificați codurile standard de status HTTP pentru a gestiona cazurile de succes sau eșec.

Activați streaming-ul pentru ieșiri în timp real

Fluxul răspunsurilor pentru a reduce latența percepută pentru utilizatorii tăi. Activează streamingul setând stream: true în corpul cererii tale. API-ul returnează o serie de Evenimente trimise de server (SSE) conținând tokeni parțiali.

Agregați acești tokeni pe partea de client pentru a reconstrui mesajul complet. Această abordare este ideală pentru interfețele de chat unde feedback-ul imediat este important. Evenimentul SSE final conține utilizarea totală a tokenilor pentru cerere.

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)

Gestionați erorile de conexiune cu grijă pentru a asigura o experiență fluidă a utilizatorului.

Folosește modul JSON pentru date structurate

Forțează modelul să genereze JSON valid pentru consum programatic. Setează response_format pentru {"type": "json_object"} în cererea ta. Acest lucru reduce erorile de analiză și asigură structuri de date consistente.

Folosește acest lucru pentru generarea de prompturi structurate, extragerea entităților sau construirea de conținut dinamic. Modelul se conformează constrângerilor de format furnizate în instrucțiunile sistemului. Acest lucru este crucial pentru o integrare fiabilă cu alte servicii.

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

Validați ieșirea JSON pe partea clientului pentru a prinde orice cazuri limită.

Implementați apelarea funcțiilor

Definește instrumente pentru a extinde capacitățile modelului. Transmite un tools array cu definiții de funcții către cerere. Modelul poate alege să apeleze aceste funcții pe baza contextului.

Aceasta permite fluxuri de lucru complexe în care LLM decide când să preia date sau să efectueze acțiuni. Primești argumentele funcției în răspuns și le execuți în partea ta. Transmiteți rezultatele înapoi la model pentru un raționament suplimentar.

Setează tool_choice pentru auto pentru luarea deciziilor flexibile. Această caracteristică suportă scenarii avansate de roleplay care necesită acces la date externe.

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)