תיעוד API

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

אימות כל בקשה על ידי העברת מפתח ה-API שלך ב- Authorization header. כתובת הבסיס לכל הנקודות הקצה היא https://api.notfilter.cc/v1. מבנה זה מבטיח תאימות עם ה-SDKs הקיימים של OpenAI ללא שינויי תצורה מורכבים.

Copycurl https://api.notfilter.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "what is the capital of france"}]
  }'

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

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

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

Copyfrom openai import OpenAI

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

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

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

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

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)

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

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

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

Copyimport OpenAI from "openai";

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

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

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

מגבלות קצב וחלון ההקשר

כל מפתח API תומך ב-300 בקשות לדקה ו-8 בקשות מקבילות. חלון ההקשר הוא 100,000 טוקנים לשילוב של פלט ושלם משולב. הפלט המקסימלי הוא 16,000 טוקנים.

A 401 שגיאה מצביעה על מפתח לא תקין. A 402 שגיאה משמעותה שאין לך אשראי ששולם מראש. A 429 שגיאה מציינת שחרגת ממגבלת הקצב. שגיאות הן בחינם, כך שלא תיגבה תשלום עבור בקשות שנכשלו. אשראי לא פג תוקף.