GitHub Uncensored AI API Reference

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

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

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

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

תצורת Base

• כתובת בסיס: https://api.githubuncensoredai.com/v1
• כותרת Auth: Authorization: Bearer YOUR_API_KEY
• מזהה מודל: uncensored

Copycurl https://api.githubuncensoredai.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Fix the syntax error in this python loop"}]
  }'

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

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

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

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

Copyfrom openai import OpenAI

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

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

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

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

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

Copyimport OpenAI from "openai";

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

Tool Calling & JSON Mode

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

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

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

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)

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

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

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

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

שימוש וחיוב טוקנים

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

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

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