תיעוד API

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

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

• השתמשו בראש: Authorization: Bearer YOUR_API_KEY
• הגדר את כתובת ה-URL הבסיסית של הלקוח שלך לנקודת הקצה שסופקה.

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

Copycurl https://api.topuncensored.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate a list of ten distinct UI layout patterns."}]
  }'

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

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

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

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

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

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

Copyfrom openai import OpenAI

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

קריאת כלים ומצב JSON

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

קריאת כלים עובדת עם הסכמה הסטנדרטית של OpenAI. מצב JSON מכריח JSON תקף. השתמש באלו לשילובי API או חילוץ נתונים. גמישות זו תומכת בזרימות עבודה מורכבות.

Copyimport OpenAI from "openai";

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

פרמטרים ומגבלות

התאם temperature, top_p, וכן stop רצפים. הגדר max_tokens ל-16,000. ברירת המחדל היא 2,048 אם מושמט. שלוט בחזרתיות עם presence_penalty וגם frequency_penalty. השתמש ב seed לפלט דטרמיניסטי. פרמטרים אלה מכוונים עדין את איכות היצירה. יש לך שליטה מלאה על סגנון הפלט.

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

שגיאות וחלון ההקשר

טפלו בשגיאות בצורה חכמה. 401 אומר מפתח לא חוקי. 402 מציינת חוסר בזכות. 429 מציין מגבלות קצב. חלון ההקשר הוא 100,000 טוקנים בסך הכל. הפלט המקסימלי הוא 16,000 טוקנים. נהל את הטוקנים שלך בחוכמה. שגיאות לא צורכות זכות. זה חוסך כסף במהלך ניפוי באגים. השתמש במקטע האחרון לסטטיסטיקות שימוש.

מעקב אחר שימוש באסימונים. הימנעו מהגעה למגבלות קצב. נסו שוב עם החזרה אקספוננציאלית. זה מבטיח פעולה אמינה. ה-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)