Dokumentace API

Autentizace a základní URL

Ověřte každý požadavek předáním svého API klíče do Authorization hlavička. Základní URL pro všechny endpointy je https://api.notfilter.cc/v1. Tato struktura zajišťuje kompatibilitu s existujícími SDK OpenAI bez složitých změn konfigurace.

Copycurl https://api.notfilter.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "what is the capital of france"}]
  }'

Váš klíč poskytuje přístup k modelu bez omezení. Chraňte jej a v případě ohrožení jej obnovte. Systém ověřuje přihlašovací údaje před zpracováním tokenů, takže neplatné klíče okamžitě vrátí chybu.

Endpoint Chat Completions

Odesílejte textové prompty a přijíme odpovědi přes /v1/chat/completions endpoint. Toto je vaše primární rozhraní pro interakci s modelem. Nakonfigurujte parametry jako temperature a top_p k úpravě chování odpovědi.

Copyfrom openai import OpenAI

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

API očekává standardní formát zpráv. Vstupní text je převeden na tokeny, zpracován a vrácen jako souvislá odpověď. Chyby jsou řešeny pomocí standardních stavových kódů HTTP.

Streamované odpovědi

Povolit výstup v reálném čase nastavením stream: true. API vrací data v chunkech, jak jsou generovány. To snižuje vnímanou latenci pro dlouhé odpovědi.

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)

Každý chunk obsahuje částečný obsah. Poslední chunk obsahuje statistiky využití tokenů. Parsovejte tyto události, abyste text uživatelům zobrazovali postupně.

Volání funkcí a nástroje

Definujte nástroje, aby model mohl volat externí funkce. Uveďte definice nástrojů v těle žádosti. Model vrací strukturované argumenty, když je vhodné zavolat funkci.

Copyimport OpenAI from "openai";

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

Proveďte funkci pomocí vrácených argumentů a vraťte výsledek zpět modelu. To umožňuje složité pracovní postupy bez ručního parsování. Výběry nástrojů mohou být vynuceny nebo automatické.

Režim JSON

Vynucení strukturovaného výstupu nastavením response_format na {"type": "json_object"}. To zajišťuje, že odpověď je platný JSON. Užitečné pro parsování dat v aplikacích.

Model se řídí poskytnutým schématem. Chyby ve struktuře JSON jsou vzácné, ale možné. Pro bezpečnost validujte výstup v aplikační vrstvě.

Limity rychlosti a kontextové okno

Každý API klíč podporuje 300 požadavků za minutu a 8 souběžných požadavků. Kontextové okno má 100 000 tokenů pro prompt a completion dohromady. Maximální výstup je 16 000 tokenů.

A 401 chyba naznačuje neplatný klíč. A 402 chyba znamená, že nemáte předplacený kredit. A 429 chyba signalizuje vyčerpání limitu rychlosti. Chyby jsou zdarma, takže za neúspěšné požadavky neplatíte. Kredit nikdy nevyprší.