תיעוד API

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

ה-API דורש אסימון bearer לכל בקשה. צור את המפתח שלך בדף קבלת מפתח API על ידי כניסה עם Google או סיסמת אימייל. המפתח מופיע מיד ללא אימות טלפון. השתמש בכתובת ה-URL הבסיסית https://api.uncensoredaigithub.com/v1 עם ספריות ה-API הרשמיות של OpenAI על ידי עדכון ה base_url וגם api_key ערכים. תצורה זו עובדת עם כל לקילנט תואם OpenAI.

נקודת קצה: https://api.uncensoredaigithub.com/v1

כותרת Auth: Authorization: Bearer YOUR_API_KEY

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

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

שלח בקשות טקסט ל- /v1/chat/completions נקודת קצה (endpoint) באמצעות מזהה המודל uncensored. ה-API מקבל הודעות צ'אט סטנדרטיות ומחזיר תגובות טקסט ללא מסנני תוכן לשימוש חוקי בבוגרים. אתה יכול להגדיר פרמטרים כמו temperature, top_p, וכן stop כדי לשלוט ביצירתיות ובאורך הפלט.

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

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

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

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

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

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

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

מצב JSON ופרמטרים

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

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

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

ה-API קובע מגבלת קצב של 300 בקשות לדקה ו-8 בקשות מקבילות לכל מפתח. גוף הבקשה לא יכול לעלות על 8 MB. אם תחרגו ממגבלות אלו, תקבלו קוד סטטוס 429. כשלים באימות מחזירים שגיאת 401. חוסר מספיק אשראי יגרום לשגיאת 402.

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

cURL

Copycurl https://api.uncensoredaigithub.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Run the unit tests for the new auth module."}]
  }'

Python

Copyfrom openai import OpenAI

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