תיעוד API

התחלה מהירה: חיבור הבקשה הראשונה שלך

התחל על ידי יצירת המפתח שלך בדשבורד. כתובת הבסיס לכל הבקשות היא HTTPS://api.filterno.cc/v1. העבר את המפתח שלך בכותרת Authorization כ-bearer token. הגדרה זו עובדת עם כל לקוח OpenAI-compatible סטנדרטי.

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

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

נקודת קצה: POST /v1/chat/completions

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

מזהה המודל הוא "uncensored". הוא מעבד קלט טקסט ומחזיר פלט טקסט. אל צפה ליצירת תמונות או אודיו כאן.

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

נקודת קצה: GET /v1/models

אמת מודלים זמינים עם בקשת GET ל-/v1/models. נקודת פעולה זו מחזירה רשימה של זיהויי מודלים נתמכים. עליך לראות "uncensored" בתגובה.

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

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

פרמטרים: טמפרטורה, Top-P, וכלים

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

השתמש ב-calling פונקציות לאינטראקציות מבניות. הגדר כללים בגוף הבקשה. המודל יכול לקרוא לפונקציות אלו. העבר tool_choice כדי לכפות התנהגות ספציפית.

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

תגובות בסטרימינג (SSE) וצריכת טוקנים

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

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

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

מגבלות, שגיאות וחשבון טוקנים

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

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

טפול בשגיאות על ידי בדיקת קודי סטטוס. 401 אומר מפתח לא חוקי. 402 מציין אין אשראי. 429 מסמן הגבלת קצב. נסה שוב עם Exponential Backoff עבור 429.

cURL

Copycurl https://api.filterno.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top five risks in a standard React application."}]
  }'

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

זרימה

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)