תיעוד API & מדריך התחלה מהיר

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

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

• כתובת בסיס: https://api.ollamaopenaicompatibleapi.com/v1
• מזהה מודל: uncensored

האימות מסתמך על טוקן bearer. העבירו אותו ב- Authorization header. זה מבטיח תאימות עם כל לקוח תואם SDK של OpenAI. אתה יכול ליצור מפתח חדש מיד דרך Google או אימייל. אין צורך במספר טלפון.

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

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

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

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

Copycurl https://api.ollamaopenaicompatibleapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 10 Linux kernel security patches from 2023"}]
  }'

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

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

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

גישה זו עובדת היטב לממשקי צ'אט. משתמשים רואים טקסט מופיע מילה במילה. זה מרגיש יותר רספונסיבי מלחכות לתגובה המלאה. ה-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)

פקודות פונקציה ומצב JSON

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

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

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

Copyfrom openai import OpenAI

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

מגבלות קצב וגופי בקשה

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

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

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

Copyimport OpenAI from "openai";

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

שגיאות אימות ומגבלות

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

סטטוס 429 מעיד על הגבלת קצב. חרגת מ-300 בקשות לדקה. הפחת את קצב העבודה או שדרג את המפתח שלך. ה-API מחזיר הודעות שגיאה ברורות.

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