Gyors beállítások: Első kérés
Kezdje azzal, hogy az ügyfélklienst a bázis URL-címünkre irányít. Használja https://api.grockapi.com/v1 és állítsa be az API kulcsot a fejlécben. A modell azonosítója mindig uncensored. Ez bármely OpenAI-kompatibilis SDK-val működik.
A hitelesítés érvényes Bearer tokent igényel. Adja át azt mint Authorization: Bearer YOUR_API_KEY. Ha a kulcs hiányzik vagy érvénytelen, azonnal 401-es hibát kapsz.
Tegye meg az első hívást a kapcsolódás teszteléséhez. A kérés törzsének tartalmaznia kell a modell nevét és egy messages tömböt.
Támogatott paraméterek és módok
Konfigurálja a generálási viselkedést standard paraméterekkel. A kreativitás szabályozásához állítsa a hőmérsékletet, a nucleus mintázáshoz a top_p értéket. Használja a stop paramétert a generálás leállításához meghatározott szekvenciákkal.
Állítsa be a seed értéket a determinisztikus kimenetekhez hibakeresés közben. A presence és frequency penalities segítenek csökkenteni az ismétlést. A modell 100 000 token támogatásával rendelkezik a kontextusablakban.
A kimenet maximum 16 000 tokenre van korlátozva kérésenként. Hagyja üresen a max_tokens értéket a 2 048-as alapértelmezett kimeneti korlát használatához. A hibák és elutasítások nem fogyasztanak kreditet.
Streaming és Token Használat
Engedélyezze a streamelést úgy, hogy stream: true. Az API chunkokat ad vissza Server-Sent Events (SSE) formátumban. Minden chunk részleges tartalmat és metaadatokat tartalmaz.
A tokenhasználati részletek az utolsó darabban jelennek meg. Ez lehetővé teszi a költségek pontos valós idejű nyomon követését. Az utolsó darab tartalmazza a kéréshez tartozó teljes használati statisztikát.
Kezelje megfelelően a stream lezárását a erőforrás-nyomkodás elkerülése érdekében. Mindig feldolgozza az utolsó darabot a pontos számlázási adatok érdekében.
Funkcióhívás (Eszközök)
Határozza meg az eszközöket a kérés törzsében. Adja meg az eszközök nevét, leírását és paraméter-sémáit. A modell megfelelő esetben eszközhívásokkal válaszol.
Használja a tool_choice paramétert a viselkedés kényszerítéséhez vagy engedélyezéséhez. Beállíthatja auto, required vagy konkrét eszközazonosítókra.
Feldolgozza az eszközhívásokat az alkalmazás logikájában. Küldje vissza az eszköz kimenetét a modellnek a beszélgetés folytatásához. Ez lehetővé teszi a komplex, több lépéses munkafolyamatokat külső elemzés nélkül.
JSON mód és korlátok
Strukturált kimenet kényszerítése a response_format beállításával json_object. A modell érvényes JSON-t ad vissza markdown kódblokkok nélkül.
Ez a mód ideális adatok alkalmazásokba való beolvasásához. Győződj meg róla, hogy a sémád egyértelmű a pontosság javítása érdekében. Az érvénytelen JSON struktúrák parsing hibákat okozhatnak az ügyfélnél.
Kombinálja a JSON módot a temperature vezérléssel a konzisztens formázás érdekében. Használjon stop szekvenciákat a záró kapcsos zárójel utáni karakterek megelőzésére.
Sebességkorlátok és kvóták
Minden API-kulcs percenként 300 kérésre van korlátozva. Egyidejűleg legfeljebb 8 kérés futtatható. A kérés törzsének maximális mérete 8 MB.
A 429-es hiba azt jelzi, hogy átlépte az átfogási limitet. Várjon az újrapróbálás előtt, vagy csökkentse a párhuzamosságot. Fiontonként egy aktív kulcs létezik; egy új kulcs generálása felváltja a régit.
Az API végén érkező streaming válasz utolsó darabjában vagy a válaszfejlécekben nyomon követheted a felhasználásodat. A 402 (nincs kredit) vagy 401 (érvénytelen kulcs) hibák ingyenesek, és nem számítanak bele a kvótádba.
cURL
curl https://api.grockapi.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "calculate the sum of two and three"}]
}'Python
from openai import OpenAI
client = OpenAI(base_url="https://api.grockapi.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
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.grockapi.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
stream = 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)