תיעוד API

כתובת URL בסיסית ואימות

כתובת הבסיס (Base URL) לכל הבקשות היא HTTPS://api.aiobliterated.com/v1. נדרש מפתח API לאימות. צרו מפתח על ידי הרשמה באמצעות Google או דוא"ל וסיסמה בדף קבלת מפתח API. העבירו את המפתח בראש ה-Authorization כטוקן Bearer. כל בקשה דורשת ראש זה לזיהוי החשבון שלך ולמעקב אחר השימוש.

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

הבקשה הראשונה שלך

שלח בקשת POST ל-/v1/chat/completions כדי ליצור טקסט. הגדר את המודל ל-"uncensored" וכלול את הנחית המערכת שלך. ה-API מחזיר את תגובת המודל בשדה content. זוהי הפורמט הסטנדרטי שמשמש את רוב לקוחות LLM.

Copyfrom openai import OpenAI

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

שימוש ב-SDK Node

התקן את ה-SDK הרשמי של OpenAI עבור Node.js. הגדר אותו עם מפתח ה-API שלך וכתובת הבסיס. קרא לשיטת chat.completions.create עם ההודעות שלך. ה-SDK מטפל ברצף ובריצוף אוטומטית.

Copyimport OpenAI from "openai";

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

תגובות בסטרימינג

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

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)

חלון ההקשר ומגבלות

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

טיפול בשגיאות ומגבלות

נטר קודי סטטוס HTTP לשגיאות. תגובת 401 אומרת שמפתח ה-API שלך לא חוקי. תגובת 402 מציינת קרדיט לא מספיק. תגובת 429 מציינת שחרגת ממגבלת הקצב של 300 בקשות לדקה. טפל בשגיאות אלו בעדינות באפליקציה שלך כדי לשמור על אמינות.