Kimicode api dokumentáció

Base URL és Hitelesítés

Csatlakozzon az API-hez a megadott alap URL és egy előlegesen fizetett token kulcs segítségével. Az API-kulcsát a kérés fejlécében adva adja meg a hitelesítéshez, így csak a fiókja fér hozzá a krediteihez. Regisztráljon Google-fiókkal vagy e-mail címmel, hogy azonnal megkapja a kulcsát telefonos ellenőrzés nélkül.

Copycurl https://api.kimicodeapi.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 rate limit for free tier users?"}]
  }'

A kéréseid a szabványos OpenAI-kompatibilis végpontot célozzák meg. Ez a kialakítás lehetővé teszi, hogy cseréld be a szolgáltatásunkat meglévő kliens kódod átírása nélkül, feltéve, hogy frissíted az alap URL-t és a hitelesítő adatokat.

Chat Completions végpont

Küldjön üzeneteket a modellnek a POST /v1/chat/completions endpoint. A model ID-t meg kell adnod mint: uncensored optimalizált nagy nyelvi modellhez, amely a szervereinkön fut. A rendszer elfogadja a szabványos üzenetszerepeket, mint például a felhasználó vagy a segéd a többfordulatos beszélgetésekhez.

Copyfrom openai import OpenAI

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

Ez a végpont szöveg bemenetet fogad és generált szöveget ad vissza. Nem támogat embeddéseket, képeket vagy hangot. Fókuszáljon a prompt struktúrájára a legjobb eredmények érdekében az uncensored modelltől.

Streamelési válaszok (SSE)

Engedélyezze a valós idejű token-kiszállítást úgy, hogy a kérésben a stream paramétert true értékre állítja. Az API Server-Sent Events (SSE) darabokat ad vissza, lehetővé téve, hogy az alkalmazása megjelenítse a szöveget generálás közben. Az utolsó darab tartalmazza a teljes token-felhasználási statisztikákat a számlázáshoz.

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 streamelés csökkenti az észlelt késleltetést a végfelhasználók számára. Feldolgozhatja minden tokent érkezésekor, ami ideális chat felületekhez. Ne felejtse el, hogy a streamelés nem változtatja meg az alapvető modell viselkedését vagy a token árazást.

Függvényhívás és eszközök

Határozza meg az eszközöket a kérésben, hogy lehetővé tegye a modell számára a strukturált függvényhívások kimenetét. Az API támogatja a tool_choice paramétereket, amelyek lehetővé teszik, hogy kikényszerítse a modell számára egy adott eszköz használatát, vagy hagyja, hogy autonóm döntson. Ez a funkció a szabványos OpenAI eszközformátumokkal működik, így az integráció egyszerű.

Copyimport OpenAI from "openai";

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

Használjon függvényhívást adatok kinyeréséhez vagy műveletek indításához az alkalmazásaiban. A modell értelmezi az eszköz-definíciókat, és JSON objektumokat ad vissza a szükséges argumentumokkal. Ez a képesség kibővíti az API-t a egyszerű szöveggeneráláson túl.

JSON mód és paraméterek

Erőszakolja meg a szigorú JSON kimenetet a beállításokkal response_format a {"type": "json_object"}. Ez biztosítja, hogy a modell érvényes JSON-t adjon vissza, ami kritikus a programozott feldolgozáshoz. A kreativitás és a kimeneti hosszúság vezérléséhez beállíthat paramétereket, mint például a temperature, top_p és stop szekvenciák.

A modell 100,000 tokenes kontextusablakot támogat. Ez lehetővé teszi nagy mennyiségű kontextus átadását egyetlen kérésben. A maximális kimenet kérésenként 16,000 token, vagy 2,048, ha nem adja meg a max_tokens értéket.

Korlátok, hibák és kontextus

Kövesse a kérelemkorlátokat a szolgáltatás megszakításainak elkerülése érdekében. Az API kulcsonként percenként 300 kérelmet és akár 8 párhuzamos kérelmet engedélyez. A kérelemtörzsnek 8 MB alatt kell maradnia. Ha túllépi ezeket a korlátokat, 429-es átfolyási korlát hibát kap.

A hitelesítési kudarcok 401-es hibát adnak vissza, ha a kulcs érvénytelen. A 402-es hiba elégtelen előre fizetett kreditet jelez. A generálás során fellépő hibák nem fogyasztják a tokenjeit. A kontextusablak mind a prompt, mind a completion tokeneket tartalmazza. A fel nem használt kredit sosem jár le, így az előre fizetett egyenlege későbbi projektekre is elérhető marad.