מדריך התחלה מהירה: ממשק API של מודל לא צנזורה

דרישות מוקדמות וכתובת בסיס

ה-API שלנו עובד עם כל לקוח תואם OpenAI סטנדרטי על ידי עדכון ה-base URL ומפתח ה-API. ציינו את ה-SDK שלכם ל- https://api.modeluncensored.com/v1 ושלח בקשות אל הסטנדרטי /v1/chat/completions נקודת קצה. אין צורך להתקין ספריות פרופריטאריות; כלי קיימים כמו ה-SDK הרשמי של OpenAI ל-Python או Node.js עובדים מיד. פשוט הגדר את כתובת הבסיס כדי להעביר תעבורה דרך השרתים שלנו במקום התשתית הסטנדרטית של OpenAI.

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

אימות עם מפתח ה-API שלך

כלול את מפתח ה-API ב Authorization header של כל בקשה כדי לאמת את זהותכם. השתמשו בפורמט Authorization: Bearer YOUR_API_KEY לאמת בקשות מיד. אם המפתח חסר או לא חוקי, ה-API מחזיר שגיאת 401 Unauthorized מיד. זה מבטיח שרק חשבונות חוקיים יצרכו אסימונים מהאשראי שלך בתשלום מראש.

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

שליחת השלמת הצ'אט הראשונה שלך

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

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

טיפול בתגובות זרם (SSE)

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

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

הגדרת פרמטרים: טמפרטורה, Top-p וזרע

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

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

שימוש בכלים ובמצב JSON

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

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

cURL

Copycurl https://api.modeluncensored.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Return the current system time in ISO format"}]
  }'

Python

Copyfrom openai import OpenAI

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