תיעוד API

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

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

• כתובת בסיס: https://api.unlockedaimodels.com/v1
• כותרת: Authorization: Bearer YOUR_API_KEY

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

Copycurl https://api.unlockedaimodels.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate the standard HTTP headers for a POST request."}]
  }'

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

ה POST /v1/chat/completions נקודת קמע מעבדת את הטקסט שלך ומחזירה השלמה.

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

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

תגובות בסטרימינג (SSE)

אפשרו זרימה על ידי הגדרת stream: true בגוף הבקשה שלך.

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

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

Copyfrom openai import OpenAI

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

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

הגדירו כלים בבקשה כדי לאפשר קריאה לפונקציות מבנית.

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

ודא שהגדרות הכלים שלך עוקבות אחר סכמת OpenAI לתאימות.

Copyimport OpenAI from "openai";

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

מצב JSON ופלט מבני

כפה על המודל להחזיר JSON תקין על ידי הגדרת response_format: {"type": "json_object"}.

זה מבטיח פיענוח צפוי לאפליקציות שלך. השתמשו במצב זה בעת חילוץ נתונים או יצירת קבצי תצורה.

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

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, ו-Stop

שלו על יצירתיות עם temperature וגווון עם top_p.

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

מגבלות הקצב הן 300 בקשות לדקה ו-8 בקשות מקבילות לכל מפתח.