תיעוד API תואם OpenAI

התחלה מהירה: חיבור עם SDK של OpenAI

התחל באימות עם המפתח שלך והגדר את הלקוח לכתובת ה-URL הבסיסית שלנו. תצורה זו עובדת עם ה-SDKים הרשמיים של OpenAI עבור Python ו-Node.js, ומבטיחה שניתן להריץ את אותו קוד לקוח מול השירות שלנו. אתה צריך מפתח API תקף מהלוח ובקונפיגורציה נכונה של נקודת הקצה.

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

Copyfrom openai import OpenAI

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

Copyimport OpenAI from "openai";

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

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

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

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)

זרימה עם SSE

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

Tool Calling & JSON Mode

שלב כלים וקבל פלט מבני לאינטראקציות תוכנית אמינות. השתמש בפרמטר הכלים להגדרת סכמות פונקציות והגדר response_format ל-json_object לצייתנות קפדנית ל-JSON. המודל ללא הצנזורה שלנו מטפל בהוראות מורכבות ומקרי קצה ללא סירוב לבקשות פונקציונליות תקפות.

מגבלות קצב & פרמטרים

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

חלון ההקשר & אילוצים

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