תיעוד API

התחלה מהירה: בקשה ראשונה עם Python או JS

שלחו prompt ראשון וקבלו פלט טקסט גולי מיד. ה-API מקבל פיי-לואדים סטנדרטיים של chat-completion, כך שתוכלו להחליף לכתובת הבסיס שלנו ולמפתח כדי להתחיל לייצר תוכן un-censored ללא כתיבת לוגיקה מחדש. השתמשו בפקודת ה-cURL הבאה כדי לאמת חיבוריות וזמינות המודל לפני אינטגרציה לקוד.

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

Copycurl https://api.chatunrestricted.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the three main endpoints for user authentication"}]
  }'

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

אימות על ידי העברת מפתח ה-API שלך בכותרת ה-HTTP. כל הבקשות חייבות לפנות לכתובת ה-URL הבסיסית https://api.chatunrestricted.com/v1 כדי להבטיח תאימות עם SDKs של OpenAI. אתה יכול ליצור את המפתח שלך מיד דרך לוח הבקרה באמצעות אישורי Google או דוא"ל, ללא צורך במספר טלפון.

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

POST /v1/chat/completions

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

נקודת הקצה הזו תומכת בזרימת נתונים (streaming), קריאה לפונקציות ותגובות בפורמט JSON. היא אינה תומכת בהטמעות (embeddings), תמונות או אימון עדין (fine-tuning). השתמשו ב-SDK של Python לטיפול בבקשה בצורה אסינכרונית לשיפור הביצועים באפליקציות ווב.

Copyfrom openai import OpenAI

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

GET /v1/models

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

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

Copyimport OpenAI from "openai";

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

פרמטרים: טמפרטורה, Top P, Seed

שלוץ באקראיות ובדטרמיניזם של הפלט שלך באמצעות פרמטרי דגימה סטנדרטיים. הגדר temperature בין 0 ל-2 כדי להתאים יצירתיות, והשתמש top_p לצמצם את דגימת הליבה. ה seed פרמטר מאפשר לכם לשחזר פלט ספציפי לניפוי באגים או לתרחישי משחק תפקידים עקביים.

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

זרימה, כלים ומצב JSON

זרום תגובות בזמן אמת באמצעות אירועים מוגדרים על ידי השרת (SSE) לזמן תגובה נמוך יותר. הפעל מצב JSON על ידי הגדרת response_format אל json_object לחילוץ נתונים מבניים. קריאה לכלים נתמכת לביצוע פונקציות, המאפשרת למודל להפעיל ממשקי API חיצוניים.

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

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)

מגבלות קצב ותמחור

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

החיוב הוא מוקדם ומבוסס על שימוש אמיתי בטוקנים. שגיאות ודחיות לא צורכות קרדיט. אם אתה נתקל בשגיאת 401, מפתח ה-API שלך לא תקין. שגיאת 402 מציינת קרדיט לא מספיק, בעוד ששגיאת 429 פירושה שחרגת ממגבלת הקצב. חלון ההקשר תומך ב-100,000 טוקנים עבור prompt ו-completion משולבים.