תיעוד API: נקודות קצה תואמות-OpenAI

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

גישה ל-API על ידי הגדרת המפתח הייחודי שלך וכתובת הבסיס במשתני הסביבה שלך. נקודת הקצה נמצאת ב- https://api.apikeykimi.com/v1. עליך לכלול את הכותרת Authorization: Bearer YOUR_API_KEY עם כל בקשה. מפתח זה נוצר מיד עם ההרשמה באמצעות Google או אימייל. זהו האישור היחיד הנדרש לאימות. אין צורך להגדיר סקופים או הרשאות.

Copycurl https://api.apikeykimi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "convert this json object to python dictionary syntax"}]
  }'

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

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

Copyfrom openai import OpenAI

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

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

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

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)

Tool Calling & JSON Mode

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

מגבלות טוקנים & אילוצים

חלון ההקשר תומך עד 100,000 טוקנים עבור קלט ופלט משולבים. מקסימום הפלט לכל בקשה הוא 16,000 טוקנים. אם לא מגדירים max_tokens, ברירת המחדל למגבלה היא 2,048 טוקנים. בקשות מוגבלות ל-8 MB בגודל הגוף. אתם מוגבלים ל-300 בקשות לדקה. רק 8 בקשות יכולות לרוץ במקביל למפתח.

טיפול בשגיאות & מגבלות שימוש

טפול בשגיאות על ידי בדיקת קוד הסטטוס של HTTP. 401 מצביע על מפתח API לא חוקי או פג תוקף. שגיאה 402 אומרת שהאשראי המקדים שלך אזל. תגובת 429 מסמנת שחרגת מגבול הקצב של 300 בקשות לדקה. שגיאות וסירובים לא צורכים טוקנים. בדוק את האשראי שלך בדשבורד כדי למנוע הפסקות.

Node.js

Copyimport OpenAI from "openai";

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