תיעוד ה-API של Grock

התחלה מהירה: בקשה ראשונה

התחל על ידי הפניית הלקוח שלך לכתובת הבסיס שלנו. השתמש ב- https://api.grockapi.com/v1 וקבע את מפתח ה-API שלך בכותרת. מזהה המודל הוא תמיד uncensored. זה עובד עם כל SDK התואם ל-OpenAI.

האימות דורש טוקן Bearer תקף. העבירו אותו כ- Authorization: Bearer YOUR_API_KEY. אם המפתח חסר או לא חוקי, תקבל שגיאת 401 מיד.

בצעו את השימה הראשונה שלך כדי לאמת חיבור. גוף הבקשה חייב לכלול את שם המודל ומערך ה-messages.

פרמטרים ומצבים נתמכים

הגדר התנהגות יצירה באמצעות פרמטרים סטנדרטיים. אתה יכול להתאים את הטמפרטורה ליצירתיות או את top_p לדגימת גרעין. השתמש בפרמטר stop כדי להגדיר רצפים ספציפיים שיעצרו את היצירה.

הגדר seed לפלטים דטרמיניסטיים במהלך ניפוי באגים. נוכחות ותדירות עוזרות להפחית חזרתיות. המודל תומך בעד 100,000 אסימונים בחלון ההקשר.

פלט מקסימלי מוגבל ל-16,000 טוקנים לכל בקשה. השאירו את max_tokens ללא הגדרה כדי להשתמש במגבלת הפלט המוגדרת כברירת מחדל של 2,048. שגיאות ודחייות אינן צורכות אשראי.

שימוש בטוקנים וסטרימינג

אפשרו זרימה על ידי הגדרת stream: true. ה-API מחזיר מקטעים באמצעות אירועים מוכוונים-שרת (SSE). כל מקטע מכיל תוכן חלקי ומטא-נתונים.

פרטי צריכת הטוקנים מופיעים בפסגה האחרונה. זה מאפשר לך לעקוב אחר עלויות במדויק בזמן אמת. הפסגה האחרונה כוללת את סטטיסטיקות הצריכה המלאות לבקשה.

טפלו בסגירת הסטרים כראוי כדי למנוע דליפת משאבים. תמיד עבדו על הנתח הסופי כדי לקבל נתוני חיוב מדויקים.

Tool Calling (כלים)

הגדירו כלים בגוף הבקשה. ציינו שמות כלים, תיאורים וסכמות פרמטרים. המודל מגיב עם קריאות לכלים כאשר מתאים.

השתמשו בפרמטר tool_choice כדי לכפות או לאפשר התנהגויות ספציפיות. ניתן להגדיר אותו ל-auto, required, או לזהויות כלי ספציפיות.

עבדו קריאות כלים בלוגיקה של האפליקציה שלכם. שלחו את פלט הכלים חזרה למודל כדי להמשיך את השיחה. זה מאפשר זרימות עבודה מורכבות רב-שלבים ללא פיענוח חיצוני.

מצב JSON ואילוצים

כף פלט מבני על ידי הגדרת response_format ל- json_object. המודל יחזיר JSON ללא בלוקי קוד markdown.

מצב זה אידיאלי לפיענוח נתונים לתוך יישומים. ודא שהסקימה שלך ברורה כדי לשפר את הדיוק. מבני JSON לא תקפים עלולים לגרום לשגיאות פיענוח בלקוח שלך.

שלבו מצב JSON עם בקרות טמפרטורה לפורמט עקבי. השתמשו ברצפי עצירה כדי למנוע תווים נלווים אח {}:.

מגבלות קצב ומכסות

כל מפתח API מוגבל ל-300 בקשות לדקה. ניתן להפעיל עד 8 בקשות מקבילות בו-זמנית. גודל גוף הבקשה המקסימלי הוא 8 MB.

שגיאת 429 מציינת שחרגת ממגבלת הקצב. המתן לפני ניסיון חוזר או הפחית את הסינכרון. מפתח פעיל אחד קיים לכל חשבון; יצירת מפתח חדש מחליפה את הישן.

עקבו אחר השימוש שלכם דרך פיסת הזרם הסופית או כותרות התגובה. שגיאות כמו 402 (אין אשראי) או 401 (מפתח לא חוקי) הן ללא תשלום ואינן נספרות מול המכסה שלכם.

cURL

Copycurl 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

Copyfrom 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

Copyimport 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);

זרימה

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)