תיעוד API

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

מפתח ה-API שלך מאמת כל בקשה. השתמש ב- https://api.whatisabliteration.com/v1 ככתובת הבסיס שלך. העבר את המפתח שלך ב- Authorization כותרת כטוקן Bearer. הגדרה זו עובדת עם כל לקוח תואם OpenAI.

Copycurl https://api.whatisabliteration.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Show me last 5 requests"}]
  }'

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

נקודת קצה להשלמות צ'אט

שלח טקסט ל POST /v1/chat/completions. מזהה המודל הוא uncensored. נקודת הקבלה הזו מטפלת בכל יצירת הטקסט. היא אינה תומכת בתמונות, אודיו או וידאו. אתה משלם רק עבור טוקנים ששימשו. שגיאות הן בחינם. סירובים הם בחינם.

Copyfrom openai import OpenAI

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

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

תמיכה ב-SSE וסטרימינג

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

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)

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

פקודות פונקציה וכלים

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

Copyimport OpenAI from "openai";

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

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

פורמט תגובה במצב JSON

הגדר response_format אל {"type": "json_object"}. המודל פולט רק JSON תקין. זה מבטיח נתונים מבניים לניתוח. השתמש בזה ל-APIs שמצפים לפורמטים קפדניים. זה משפר את האמינות למערכות זרועות.

השתמשו במצב זה כשמשלבים עם שירותים אחרים. פנצו את הפלט ישירות. הימנעו מפיתוני regex למבנה.

פרמטרים ואילוצים

פלט מקסימלי הוא 16,000 טוקנים. ברירת המחדל המקסימלית היא 2,048 טוקנים. חלון ההקשר הוא 100,000 טוקנים. מגבלת הקצב היא 300 בקשות לדקה. בקשות מקבילות הן 8 לכל מפתח. גוף הבקשה המקסימלי הוא 8 MB. טפל ב-401 למפתחות לא חוקיים. טפל ב-402 לחוסר אשראי. טפל ב-429 למגבלות קצב.