API תיעוד

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

ה-API נמצא ב https://api.ollamaapidoc.com/v1. אתה מאשר באמצעות אסימון נושא (Bearer token) ב Authorization כותרת. צור את המפתח שלך מיד באמצעות Google או דוא"ל בלוח הבקרה. אין צורך במספר טלפון. המפתח עובד עם ספריות ה-SDK הסטנדרטיות של OpenAI על ידי הגדרת כתובת הבסיס.

הבקשה הראשונה שלך

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

Copycurl https://api.ollamaapidoc.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list all installed models"}]
  }'

התגובה מחזירה פורמט OpenAI סטנדרטי. שגיאות מחזירות קודי HTTP מתאימים. בדוק את הגוף עבור error פרטים אם משהו נכשל. תגובות בזרם נתונים משתמשות ב-Server-Sent Events.

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

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

Copyfrom openai import OpenAI

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

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

הגדרת SDK Node.js

השתמשו ב openai חבילת npm. אתחל את הלקוח עם כתובת ה-URL הבסיסית המותאמת. העבר את מפתח ה-API שלך. הסינטקס משקף את דוגמת Python. עקביות זו מפחיתה זמן ניפוי באגים. אתה יכול לשלוח הודיות מרובות במערך היסטוריית שיחה.

Copyimport OpenAI from "openai";

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

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

מצב JSON וסטרימינג

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

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)

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

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

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