תיעוד ה-API של Ollama: רשימת נקודות קצה

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

כתובת הבסיס לכל הבקשות היא https://api.ollamaapidocumentation.com/v1. אתה מאשר באמצעות אסימון נושא (bearer token) המועבר ב Authorization header. המפתח שלך נוצר בדשבורד ועובד מיד.

• השתמשו ב-SDKs הרשמיים של OpenAI או בכל לקוח תואם.
• הגדר את כתובת הבסיס לערך למעלה.
• כלול את מפתח ה-API שלך בראש.

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

נקודת קצה להשלמות צ'אט: POST /v1/chat/completions

שלח הודעות למודל דרך POST /v1/chat/completions. נקודת הקצה מקבלת גוף JSON עם model field set to "uncensored" and a messages מערך.

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

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

רשימת מודלים: GET /v1/models

שחזר מודלים זמינים באמצעות GET /v1/models. זה מחזיר רשימה של אובייקטי מודל. מזהה המודל הזמין היחיד הוא "uncensored".

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

השתמשו בזה כדי לפתור בעיות חיבור לפני שליחת מטענים כבדים.

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

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

הגדר temperature בין 0 ל-2. ערכים נמוכים הופכים את התשובות ליותר צפויות. ערכים גבוהים מגבירים אקראיות. ה- top_p פרמטר מסנן טוקנים על פי הסתברות מצטברת.

פרמטרים אלו עובדים בדיוק כמו ב-OpenAI API. ניתן לשלב אותם לשליטה מדויקת בסגנון.

תגובות בסטרימינג וצריכת טוקנים

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

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

Streaming reduces perceived latency. It is ideal for chat interfaces. The server pushes data until the response is complete.

מגבלות, שגיאות וחלון ההקשר

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

מגבלות הקצב הן 300 בקשות לדקה. ניתן לבצע 8 בקשות מקבילות. גודל גוף הבקשה מוגבל ל-8 MB.

שגיאות כוללות 401 למפתחות לא חוקיים ו-429 למגבלות קצב. שגיאות אשראי מחזירות 402. שגיאות אלו ברורות וניתנות לפעולה.

cURL

Copycurl https://api.ollamaapidocumentation.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list files in the current directory"}]
  }'

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

זרימה

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)