Dokumentace API

Rychlý start: Vaše první žádost

Pošlete svou první zprávu do uncensored modelu ihned. Použijte standardní endpoint chat-completions pro generování textu. Model odpovídá na přirozené jazykové podněty bez odmítání obsahu pro zákonné použití pro dospělé. Toto nastavení funguje s jakýmikoli klienty kompatibilními s OpenAI.

Začněte instalací SDK pro váš preferovaný jazyk. Poté nakonfigurujte svůj API klíč. Následující příklad ukazuje základní požadavek curl k otestování připojení.

Můžete upravit parametry jako teplotu pro ovládání náhodnosti. Odpověď vrátí vygenerovaný text přímo. Tento jednoduchý tok vám umožní ověřit funkčnost API před vytvořením složitější logiky.

Copycurl https://api.apiaicharacter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the current API rate limit status?"}]
  }'

Základní URL a ověření

Připojte se pomocí vyhrazené základní URL pro toto API. Nahraďte výchozí endpoint naší adresou hostovaného serveru. To zajišťuje, že vaše požadavky dosáhnou přímo uncensored modelu. Autentizace spoléhá na jeden API klíč na účet.

Vygenerujte svůj klíč přes dashboard. Předáte jej v záhlaví Authorization jako Bearer token. Tato metoda je kompatibilní se standardními SDK OpenAI. Poskytovatele můžete změnit pouze změnou základní URL a klíče.

"Chraňte svůj klíč. Poskytuje plný přístup k vašemu předplacenému kreditu. Klíč nahrazuje jakýkoli předchozí aktivní klíč okamžitě po vygenerování."

Koncové body: Chat Completions

Interagujte s modelem prostřednictvím koncového bodu dokončování chatu. To je jediný dostupný koncový bod pro generování textu. Přijímá zprávy a vrací vygenerovaný text. Nepodporují se vložení, obrázky ani audio.

Odešlete požadavek POST na trasu chat. Do těla zahrňte své systémové a uživatelské zprávy. Model zpracuje kontext a vygeneruje odpověď. Pro strukturovaný výstup můžete použít režim JSON.

Volání funkcí je také podporováno. Definujte nástroje a nechte model rozhodnout, kdy je použít. Tato flexibilita umožňuje komplexní pracovní postupy agentů. Odpověď obsahuje vygenerovaný obsah i využití tokenů.

Copyfrom openai import OpenAI

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

Parametry: Teplota, Top P a Stop

Ovládejte styl výstupu pomocí standardních parametrů. Upravte teplotu pro změnu kreativity. Nižší hodnoty činí odpovědi více deterministickými. Vyšší hodnoty přinášejí větší rozmanitost.

Použijte top P k filtrování nepravděpodobných slov. To pomáhá udržet koherenci při zachování kreativity. Nastavte sekvence stop pro ukončení generování na specifických značkách. To je užitečné pro řízení struktury dialogu.

Parametr seed umožňuje reprodukovatelné výsledky. Použijte jej při ladění svých promptů. Tyto parametry vám poskytují přesnou kontrolu nad chováním modelu. Upravte je tak, aby odpovídaly potřebám vaší aplikace.

Copyimport OpenAI from "openai";

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

Streamování a využití tokenů

Přijímejte odpovědi v reálném čase pomocí server-sent events. Streamování snižuje vnímanou latenci pro uživatele. API odesílá tokeny okamžitě po jejich vygenerování. To vytváří plynulejší čtecí zážitek.

Spotřeba tokenů je hlášena v posledním bloku. To vám umožňuje přesně sledovat náklady. Fakturace vychází ze skutečně spotřebovaných tokenů. Chyby a odmítnutí neznamenají náklady.

Implementujte obslužnou rutinu streamu pro zpracování dat. Aktualizujte své UI, jak přicházejí tokeny. Tento přístup je ideální pro chatová rozhraní. Model podporuje streamování pro všechny typy požadavků.

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)

Limity rychlosti a omezení

Chápejte limity, abyste předešli přerušení služby. Můžete provést 300 požadavků za minutu na klíč. Souběžné požadavky jsou omezeny na osm současně. Tělo požadavku nesmí překročit 8 MB.

Chyby zpracovávejte elegantně. Stav 401 znamená, že je váš klíč neplatný. Stav 402 indikuje nedostatek kreditu. Stav 429 signalizuje, že jste dosáhli limitu rychlosti.

Okno kontextu podporuje celkem 100 000 tokenů. To zahrnuje jak prompt, tak completion. Maximální výstup je 16 000 tokenů na požadavek. Nastavte max_tokens pro ovládání délky výstupu. Chyby jsou zdarma, takže logika opakování je bezpečná.