API dokumentáció & Gyors kezdés

Base URL és Hitelesítés

Használja bázis URL-ünket és egyetlen API-kulcsot a csatlakozáshoz. A végpont elfogadja a szabványos fejléceket. Cserélje YOUR_API_KEY a műszerfalán szereplő stringgel.

• Base URL: https://api.ollamaopenaicompatibleapi.com/v1
• Modell ID: uncensored

A hitelesítés egy bearer tokenre támaszkodik. Adja át a Authorization header. Ez biztosítja a kompatibilitást bármely OpenAI SDK-kompatibilis klienssel. Azonnal generálhat új kulcsot Google-fiókkal vagy e-mail címmel. Nincs szükség telefonszámra.

Chat Completions végpont

Küldj egy POST kérést a /v1/chat/completions. Tartalmazza üzenetek tömbjét és a modell nevét. Az API szöveges kimenetet ad vissza a promptja alapján. Ez bármelyik olyan szolgáltatóval működik, amely szabványos paramétereket használ.

Állítsa be a temperature értéket a kreativitás érdekében, vagy tartsa alacsonyan a pontosság érdekében. Megadhat leállítási szekvenciákat (stop sequences) is. A szerver feldolgozza a kérést, és visszaadja a kiegészítést. Ez a leggyakoribb integrációk alapvető interakciója.

Emlékezzen, hogy a hibák nem fogyasztják az előre fizetett hitelt. Csak a sikeres befejezéseket számlázzák. Ez védi a költségvetését hibakeresési fázisban.

Copycurl https://api.ollamaopenaicompatibleapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 10 Linux kernel security patches from 2023"}]
  }'

Streamelési válaszok SSE-n keresztül

Engedélyezze a streamelést úgy, hogy stream: true. A szerver darabokat küld, ahogy azok generálódnak. Ez jelentősen csökkenti a felfogott késleltetést. Valós időben kapod a részleges válaszokat.

Elemzés a Server-Sent Events streamet. A végső darab tartalmazza a használati statisztikákat. Ez tartalmazza a bemeneti és kimeneti token számokat. Dinamikusan nyomon követheti a költségeket generálás közben.

Ez a megközelítés jól működik chatfelületekhez. A felhasználók szóról szóra látják a szöveg megjelenését. Reaktívabbnak tűnik, mint a teljes válaszra várás. Az API automatikusan kezeli a kapcsolatstabilitást.

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)

Függvényhívás és JSON mód

Határozza meg az eszközöket a kérés törzsében. A modell strukturált adatokat adhat vissza. Használja a response_format valamivel {"type": "json_object"} a szigorú JSON-hoz. Ez biztosítja az elemzhető kimenetet minden alkalommal.

A tool definíciók tartalmaznak nevet, leírást és paramétereket. A modell dönti el, melyik eszközt hívja meg. Ön végzi el a függvényt, és visszajuttatja az eredményeket. Ez lehetővé teszi a komplex agent munkafolyamatokat.

A JSON mód letiltja a szabad szövegű generálást. Kikényszeríti, hogy a modell betartsa a sémádat. Használd ezt adatbázisok vagy API-k integrálásakor. Csökkenti a hallucinációt a strukturált mezőkben.

Copyfrom openai import OpenAI

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

Sebességkorlátok és kérelemtörzsek

300 kérelmet percenként kulcsonként kaphatsz. A párhuzamosság 8 egyidejű kérésben van korlátozva. A maximális kérelemtörzs mérete 8 MB. Ez a legtöbb szövegközpontú alkalmazáshoz megfelelő.

A kontextus ablak 100,000 token összesen. Ez tartalmazza a promptot és a kiegészítést. Max kimenet kéréstenként 16,000 token. Ha kihagyod max_tokens, alapértelmezetten 2 048-ra áll.

Kezelje gracefully a HTTP 429-es hibákat. Ezek azt jelzik, hogy elérte a sebességkorlátot. Implementáljon exponenciális backoff-ot az ügyfélkódjában. Ez megakadályozza a szerver túlterhelését csúcsidőszakokban.

Copyimport OpenAI from "openai";

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

Hitelesítési hibák és limit

A 401-es státusz azt jelenti, hogy a kulcs érvénytelen. Ellenőrizd az elgépeléseket vagy a lejárt munkameneteket. A 402-es státusz elégtelen hitelt jelez. Töltsd fel a számládat kriptovalutával a szolgáltatás folytatásához.

A 429-es státusz a sebességkorlátozást jelzi. Túllépte a percenkénti 300 kérést. Csökkentse a forgalmat, vagy frissítsen kulcsot. Az API egyértelmű hibaüzeneteket ad vissza.

A hitel nem jár le. Bármikor tölthet fel. A minimális feltöltés $20. Nagyobb összegek esetén bónusz hitelt kap. Ez biztosítja a projekt zökkenőmentes futtatását.