תיעוד ממשק API של Ollama למפתחים

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

שימוש https://api.ollamaendpointurl.com/v1 ככתובת הבסיס שלך והוסף את מפתח ה-API שלך ל- Authorization כותרת.

• כתובת URL בסיסית: https://api.ollamaendpointurl.com/v1
• כותרת: Authorization: Bearer YOUR_API_KEY

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

בקשה ראשונה

שלחו בקשת POST ל /v1/chat/completions עם מזהה המודל uncensored וההודעות שלך.

Copycurl https://api.ollamaendpointurl.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the default port for Ollama?"}]
  }'

זה מחזיר תגובת JSON המכילה את הטקסט שנוצר. אם אתה מקבל שגיאה 401, מפתח ה-API שלך לא תקין. שגיאה 402 מציינת חוסר באשראי מזומן.

אינטגרציית SDK Python

אתחל את הלקוח עם המפתח וכתובת הבסיס המותאמת אישית כדי לשלוח בקשות בתכנות.

Copyfrom openai import OpenAI

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

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

שילוב Node SDK

הגדר את לקוח Node.js להצביע על נקודת הקצה שלנו לשילוב חלק בתסריטים שלך.

Copyimport OpenAI from "openai";

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

ה-SDK מטפל ברצף (serialization) באופן אוטומטי. ודא שאתה משתמש בגרסה עדכנית של ה-SDK של OpenAI התומכת ב-base URLs מותאמים אישית. שגיאות מוזרקות כחריגי API סטנדרטיים.

תגובות בסטרימינג

אפשרו זרימה על ידי הגדרת stream: true לקבל טוקנים באמצעות Server-Sent Events (SSE).

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 סטנדרטי התואם לרוב ספריות הלקוח.

מגבלות קצב וחלון ההקשר

כל מפתח API מוגבל ל-300 בקשות לדקה ו-8 בקשות מקבילות. חלון ההקשר הוא 100,000 טוקנים בסך הכל. הפלט המקסימלי לבקשה הוא 16,000 טוקנים. בקשות שגוף הבקשה שלהן עולה על 8 MB יידחו. שגיאת 429 מציינת שהגעת למגבלת הקצב. המתן זמן קצר לפני ניסיון חוזר. שגיאות ודחייות אינן צורכות אשראי. האשראי לא פג תוקף. השתמש בקריפטו להוספת אשראי. התחל עם אשראי ניסיון של $0.50. קבל את המפתח שלך עכשיו.