Dokumentace API & Quickstart

Základní URL a ověření

Začněte nastavením základní URL na HTTPS://api.uncensoredal.com/v1 a předáním vašeho API klíče v hlavičce Authorization. Na účet obdržíte jeden aktivní klíč a vygenerování nového klíče okamžitě zneplatní předchozí. Toto jednoduché nastavení funguje s jakýmkoli klientem kompatibilním s OpenAI bez složité logiky směrování.

Copycurl https://api.uncensoredal.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate the next 50 lines of a python script"}]
  }'

Koncový bod je přísně určen pro dokončování chatu, takže nemusíte spravovat směrování modelů. Každá žádost musí obsahovat identifikátor modelu „uncensored“, abyste se ujistili, že zasíláte požadavky na správný server pro inferenci. Selhání ověření vrátí stav 401, pokud je klíč chybějící nebo neplatný.

Endpoint Chat Completions

Odešlete požadavek POST na /v1/chat/completions s historií svých zpráv v poli messages. Systém zpracovává textový vstup a vrací vygenerovaný text bez odmítání obsahu pro legální použití dospělými. Do svého payloadu musíte specifikovat model jako "uncensored", abyste zajistili kompatibilitu.

Copyfrom openai import OpenAI

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

Požadavky se účtují na základě skutečného využití tokenů, přičemž chyby a zamítnutí zůstávají zdarma. Tento předplacený model znamená, že platíte pouze za to, co spotřebujete. Endpoint podporuje standardní parametry jako temperature a top_p pro ovládání náhodnosti výstupu.

Streamované odpovědi s SSE

Povolte streamování nastavením stream na true v těle požadavku pro příjem tokenů prostřednictvím Server-Sent Events. Každá část zahrnuje statistiky o využití tokenů v poslední části, což vám umožňuje sledovat náklady v reálném čase. Tento přístup snižuje vnímanou latenci pro dlouhé generace.

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)

Použijte streamování při tvorbě chatových rozhraní, která potřebují zobrazovat text během jeho generování. API vrací standardní streamovací události kompatibilní s OpenAI, což usnadňuje integraci s existujícími knihovnami UI. Stream můžete předčasně ukončit, pokud uživatel změní svůj vstup.

Volání funkcí a režim JSON

Definujte nástroje v těle žádosti pro povolení volání funkcí nebo vynucení výstupu JSON pomocí response_format. API podporuje tool_choice pro přesnou kontrolu nad tím, kdy má model vyvolat funkci. Tato funkce funguje se standardním schématem OpenAI, takže můžete znovu použít stávající definice nástrojů.

Copyimport OpenAI from "openai";

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

Režim JSON zajišťuje, že výstup je platný JSON, což je užitečné pro programové parsování strukturovaných dat. Tento režim můžete kombinovat s nastavením teploty pro vyvážení kreativity a strukturální spolehlivosti. API řeší logiku provádění nástrojů vrácením detailů volání funkce, které má váš kód zpracovat.

Konfigurace parametrů modelu

Nastavte parametry jako teplota, top_p, sekvence stop a seed pro ovládání chování generování. Okno kontextu podporuje 100 000 tokenů pro prompt i dokončení celkem. Maximální výstup je omezen na 16 000 tokenů na požadavek nebo na 2 048, pokud neurčíte max_tokens.

Můžete použít presence_penalty a frequency_penalty k redukci opakování v delších textech. Tyto parametry umožňují jemné doladění stylu modelu bez změny základních vah. Upravujte je postupně, abyste našli správnou rovnováhu pro váš konkrétní případ použití.

Limity, chyby a kontext

Limity rychlosti jsou nastaveny na 300 požadavků za minutu a 8 souběžných požadavků na klíč. Těla požadavků jsou omezena na 8 MB, takže je třeba velká kontextová okna pečlivě spravovat. Chyby zahrnují 401 pro neplatné klíče, 402 pro nedostatečný kredit a 429 pro vyčerpání limitu rychlosti.

Úvěr nevyprší, takže můžete přerušit používání mezi dávkami bez ztráty prostředků. Pokud dosáhnete limitu souběžných požadavků, zkuste to znovu s exponenciálním zpomalováním. Kontextové okno o velikosti 100,000 tokenů umožňuje rozsáhlou historii, ale sledujte limity výstupu, abyste předešli ořezání.