API Dokumentáció

Base URL és Hitelesítés

Az API a következő helyen érhető el: https://api.ollamaapidoc.com/v1. Hitelesítse magát egy Bearer token segítségével a Authorization header. Azonnal hozza létre kulcsát Google-fiókkal vagy e-maillel a műszerfalon. A telefonszám megadása nem kötelező. A kulcs a szabványos OpenAI SDK-kkal működik a base URL beállításával.

Az első kérésed

Küldj egy POST kérést a /v1/chat/completions a modell azonosítóval uncensored. Ez a végpont szövegbemenetet és szövegkimenetet kezel. Támogatja a streamelést, a JSON módot és a function callingot. A kapcsolódást a credit felhasználása nélkül tesztelheti az első lépésben a models végpont ellenőrzésével.

Copycurl https://api.ollamaapidoc.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list all installed models"}]
  }'

A válasz szabványos OpenAI formátumot ad vissza. A hibák megfelelő HTTP kódokat adnak vissza. Ellenőrizze a törzset a error részletek, ha valami elromlik. A streamelő válaszok Server-Sent Events-t használnak.

Python SDK Integráció

Telepítse a hivatalos OpenAI könyvtárat. Állítsa be a klienst a bázis URL-csonttal és az API-kulccsal. Hívja meg a chat completions végpontot. A kód azonos marad a szabványos OpenAI használattal. Ez biztosítja a könnyű migrálást a meglévő projektekhez. Paramétereket, mint például a temperature és top_p, közvetlenül a hívásban állíthat be.

Copyfrom openai import OpenAI

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

Kezelje a kivételeket a sebességkorlátok vagy az érvénytelen kulcsok miatt. A könyvtár tokeneket streamel, ha a stream paramétert true-ra állítja. Ez a megközelítés tiszta és kompatibilis kódbázist biztosít.

Node.js SDK beállítása

Használja a openai npm csomagot. Inicializáld az ügyfelet a testreszabott bázis URL-lel. Add meg API kulcsodat. A szintaxis másolja a Python példát. Ez a konzisztencia csökkenti a hibakeresés idejét. Több üzenetet is küldhetsz egy beszélgetési előzmények tömbjében.

Copyimport OpenAI from "openai";

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

Elemzés a válasz alaposan. Az API strukturált JSON-t ad vissza. A hibakezelés kritikus a termelési alkalmazásokhoz. Fogja el a hálózati hibákat és az API-specifikus hibákat külön-külön. Ez biztosítja, hogy az alkalmazása reszponzív maradjon nagy forgalom alatt.

Streaming és JSON Mód

A streamelés engedélyezéséhez állítsa a stream paramétert állítsa true-ra. Az API Server-Sent Events formátumban küld tokeneket. Valós időben részkap válaszokat. Ez javítja a felhasználói élményt hosszú kimenetek esetén. JSON kimenetet is kikényszeríthet response_format. Ez hasznos a strukturált adatok kinyeréséhez.

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)

A function calling hasonlóan működik. Definiáljon eszközöket a kérésben. A modell eszközhívásokat ad vissza. Elemezze ezeket a hívásokat a kódjában. Hajtson végre őket, és adja vissza az eredményeket a modellnek. Ez a hurok komplex munkafolyamatokat tesz lehetővé.

Korlátok, hibák és kontextus

A kontextusablak 100 000 token. A maximális kimenet 16 000 token kérésenként. A hibák között szerepel a 401 az érvénytelen kulcsoknál és a 402 a elégtelen kreditnél. A sebességkorlát percenként 300 kérésre van korlátozva. Kezelje ezeket gracefully az alkalmazásában. Az API soha nem használja a promptjait tanításhoz. A magánélet megmarad. A kredit nem jár le.