API dokumentáció

Gyors bevezetés: Az első kérés

Küldje el az első üzenetet az uncensored modellhez azonnal. Használja a szabványos chat-completions végpontot szöveg generálásához. A modell természetes nyelvű lekérdezésekre válaszol tartalom-elutasítások nélkül, jogszerű felnőtt felhasználás esetén. Ez a beállítás bármely OpenAI-kompatibilis klienssel működik.

Kezdje a SDK telepítésével a választott nyelvhez. Ezután konfigurálja az API kulcsot. A következő példa egy alap curl kérést mutat a kapcsolódás teszteléséhez.

Beállíthatod a hőmérsékletet a véletlenszerűség szabályozására. A válasz közvetlenül generált szöget ad vissza. Ez az egyszerű folyamat lehetővé teszi az API működésének ellenőrzését komplex logika építése előtt.

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

Base URL és Hitelesítés

Csatlakozzon a dedikált alap URL-hez ehhez az API-hoz. Cserélje ki a alapértelmezett végpontot a hosztolt szervercímünkre. Ez biztosítja, hogy a kérései közvetlenül az uncensored modellhez érjenek. A hitelesítés egy fiókra szóló API-kulcon alapul.

Generálja le a kulcsát a műszerfalon. Adja meg az Authorization fejlécben Bearer tokenként. Ez a módszer kompatibilis a szabványos OpenAI SDK-kkal. Szolgáltatót váltani csak az alap URL-cím és a kulcs megváltoztatásával lehet.

Tartsa a kulcsot biztonságban. Teljes hozzáférést biztosít az előre fizetett hitelhez. A kulcs azonnal helyettesíti a korábbi aktív kulcsot generáláskor.

Végpontok: Chat Completions

A modellhez a chat completions végpont segítségével férhetsz hozzá. Ez az egyetlen elérhető szöveggeneráló végpont. Üzeneteket fogad és generált szöveget ad vissza. Az embeddingek, képek vagy hang nem támogatottak.

Küldjön egy POST kérést a chat útvonalra. Tartalmazza a rendszer- és felhasználói üzeneteket a törzsben. A modell feldolgozza a kontextust, és választ generál. Használhat JSON módot a strukturált kimenethez.

A function calling is támogatott. Definiáljon eszközöket, és hagyja, hogy a modell eldöntse, mikor használja őket. Ez a rugalmasság lehetővé teszi az összetett ügynök munkafolyamatokat. A válasz tartalmazza a generált tartalmat és a token-felhasználást.

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)

Paraméterek: Hőmérséklet, Top P és Stop

A kimenet stílusának szabályozása standard paraméterekkel. Állítsa be a temperature paramétert a kreativitás módosításához. Az alacsonyabb értékek determinisztikusabb válaszokat eredményeznek. A magasabb értékek nagyobb változatosságot hoznak.

Használja a top P-t a valószínűtlen szavak szűréséhez. Ez segít megőrizni a koherenciát, miközben lehetővé teszi a kreativitást. Állítsa be a stop szekvenciákat a generálás leállítására meghatározott jelzőknél. Ez hasznos a párbeszédstruktúra szabályozásához.

A seed paraméter lehetővé teszi a reprodukálható eredményeket. Használd hibakeresés közben a promptjaidon. Ezek a paraméterek pontos kontrollt adnak a modell viselkedése felett. Finomhangold őket az alkalmazásod igényeihez igazítva.

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

Streaming és Token Használat

Valós idejű válaszok fogadása server-sent events segítségével. A streamelés csökkenti az észlelt késést a felhasználók számára. Az API tokeneket küld generálás közben. Ez simább olvasási élményt biztosít.

A tokenfelhasználás a végső tömbben kerül jelentésre. Ez lehetővé teszi a költségek pontos nyomon követését. A számlázás a ténylegesen felhasznált tokeneken alapul. A hibák és a visszautasítások nem vonnak díjat.

Implementáljon egy stream kezelőt az adatok feldolgozásához. Frissítse a felhasználói felületet, ahogy a tokenek érkeznek. Ez a megközelítés ideális chat felületekhez. A modell támogatja a streamelést minden kéréstípushoz.

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)

Sebességkorlátok és korlátok

Értsd meg a korlátokat a szolgáltatásmegszakítások elkerülése érdekében. Per perc 300 kérést küldhetsz kulcsonként. A párhuzamos kérések száma nyolcra van korlátozva egyszerre. A kérés törzse nem haladhatja meg a 8 MB-ot.

Kezeld gracefully a hibákat. A 401-es állapot azt jelenti, hogy a kulcs érvénytelen. A 402-es állapot elégtelen hitelt jelez. A 429-es állapot azt jelzi, hogy elérted a sebességkorlátot.

A kontextusablak összesen 100 000 token támogatását nyújtja. Ez magában foglalja a promptot és a kiegészítést is. A maximális kimenet 16 000 token kérésenként. Állítsa be a max_tokens paramétert a kimeneti hossz vezérléséhez. A hibák ingyenesek, így a retry logika biztonságos.