תיעוד ממשק API תואם ל-OpenAI

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

התחל בהתקנת הספרייה המועדפת עליך וצביע אותה לנקודת הקצה שלנו. ה- base_url הוא https://api.apicompatible.com/v1. תיעוד ה-API התואם ל-OpenAI מאשר שספריות סטנדרטיות עובדות מיד. אינך צריך מנתב או הגדרת שערה מורכבת. שנה את ה-URL והמפתח, ואז הרץ את הקוד הקיים שלך.

אימות: פורמט ראש ומפתח

שלחו את המפתח שלכם ב- Authorization header. השתמש בפורמט Bearer your_api_key. ה-API שלנו משתמש במבנה מפתח ה-API הסטנדרטי התואם ל-OpenAI. מפתחות נוצרים מיידית באמצעות כניסה באמצעות Google או דוא"ל. שמור על המפתח שלך מאובטח, שכן הוא מעניק גישה לקרדיט ששולם מראש.

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

שלח בקשות אל /v1/chat/completions. ציינו את המודל כ- uncensored. ה-API מחזיר תגובות טקסט ישירות. השתמש בפקודת ה-curl הבאה כדי לאמת חיבור:

Copycurl https://api.apicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List available models"}]
  }'

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

תגובות בסטרימינג עם SSE

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

Copyfrom openai import OpenAI

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

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

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

שלוו יצירה באמצעות פרמטרים סטנדרטיים. הגדירו temperature לאקראיות או top_p לדגימת ליבה. הפעל tools לקריאת פונקציות. מצב JSON זמין דרך response_format. ה uncensored המודל מכבד אילוצים אלו ביעילות:

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.apicompatible.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 קפדניים למקרי שימוש תכנותיים.

מגבלות: מגבלות קצב וגודל גוף הבקשה

כל מפתח מאפשר 300 בקשות לדקה. בקשות מקבילות מוגבלות ל-8 למפתח. גודל הגוף המקסימלי של הבקשה הוא 8 MB. חלון ההקשר תומך ב-100,000 טוקנים בסך הכל. טפלו בשגיאות 401 על ידי בדיקת המפתח שלכם. פתרו שגיאות 402 על ידי טעינת קרדיט. נהל שגיאות 429 על ידי יישום לוגיקת backoff.

זרימה

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)