Ollama API dokumentáció: Végpont referencia

Base URL és Hitelesítés

Az összes kérés alap URL-je https://api.ollamaapidocumentation.com/v1. Hitelesítse magát egy Bearer token segítségével, amelyet a Authorization header. A kulcsa a műszerfalon generálódik és azonnal működik.

• Használja a hivatalos OpenAI SDK-kat vagy bármely kompatibilis klienst.
• Állítsa be a bázis URL-t a fenti értékre.
• Tartalmazza API-kulcsát a fejlécben.

A hitelesítés szigorú. Ha a kulcs hiányzik vagy érvénytelen, az API 401-es hibát ad vissza. Ez biztosítja, hogy a felhasználás pontosan nyomon követhető legyen a számlázás érdekében.

Chat Completions végpont: POST /v1/chat/completions

Küldjön üzeneteket a modellnek a POST /v1/chat/completions. A végpont egy JSON törzset fogad el a model field set to "uncensored" and a messages tömb.

Ez a végpont szöveggenerálást kezel. Nem támogat képeket, hangot vagy videót. Streamelheti a válaszokat vagy várhat a teljes eredményre.

A 402 a nem elegendő kreditet jelzi. A kéréseket a tényleges tokenfelhasználás alapján számítják el. A kredit miatti visszautasítások ingyenesek.

Modell lista: GET /v1/models

Elérhető modellek lekérése GET /v1/models.Ez egy modellobjektumok listáját ad vissza. Az egyetlen elérhető modell ID a "uncensored".

Ez a végpont segít a kapcsolódás ellenőrzésében. Megerősíti, hogy az alap URL helyes. Megjeleníti a modell nevét és az objektum típusát is.

Használja ezt a kapcsolódási problémák hibakeresésére nehéz terhek küldése előtt.

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

Generálás szabályozása temperature, top_p, és seedA seed parameter ensures deterministic outputs. Use it for debugging or consistent results.

Beállítás temperature 0 és 2 között. Az alacsonyabb értékek kiszámíthatóbb válaszokat eredményeznek. A magasabb értékek növelik a véletlenszerűséget. A top_p paraméter a tokeneket a kumulatív valószínűség alapján szűri.

Ezek a paraméterek pontosan úgy működnek, mint az OpenAI API. Kombinálhatod őket a stílus precíz kontrolljához.

Streamelési válaszok és tokenfelhasználás

Engedélyezze a streamelést úgy, hogy stream: true. Az API Server-Sent Events (SSE)-t ad vissza. Minden chunk részleges szöveget tartalmaz.

A végleges darab tartalmazza a token-használati statisztikákat. Ez lehetővé teszi a költségek pontos kiszámítását. Tokeneket dolgozhat fel azok megérkezésekor.

A streamelés csökkenti az észlelt késleltetést. Ideális chat felületekhez. A szerver addig küldi az adatokat, amíg a válasz be nem fejeződik.

Korlátok, hibák és kontextus ablak

A kontextusablak 100 000 token. Ez az input és output együttesét fedi. Kérésenként akár 16 000 token generálható. Az alapértelmezett maximális kimenet 2 048 token.

A kérelemezési korlát percenként 300 kérelem. 8 párhuzamos kérést indíthat. A kérelem törzsének mérete 8 MB-ban van korlátozva.

A hibák közé tartozik a 401 az érvénytelen kulcsok esetén és a 429 a sebességkorlátoknál. A kredit-hibák 402-es kóddal térnek vissza. Ezek egyértelműek és cselekvésre ösztönöznek.

cURL

Copycurl https://api.ollamaapidocumentation.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list files in the current directory"}]
  }'

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

Streamelés

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)