תיעוד API

אימות

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

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

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

Copycurl https://api.ollamauncensoredmodel.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Run the python script and show output"}]
  }'

SDK Python

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

Copyfrom openai import OpenAI

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

אתחל את הלקוח עם כתובת ה-URL הנכונה. זה מבטיח שהאפליקציה שלך ב-Node.js תנתב בקשות למודל ה-uncensored שלנו במקום ל-OpenAI. שאר הקוד משקף את הדפוסים הסטנדרטיים של OpenAI. uncensored. ניתן לזרום תשובות או לעבד אותן באופן סינכרוני. גישה זו מבטלת את הצורך בניתוב פרוקסי או בהגדרות מקומיות מורכבות.

Copyimport OpenAI from "openai";

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

זרימה & שימוש בטוקנים

אפשרו זרימה על ידי הגדרת stream: true. השרת שולף אירועים מוכוונים שרת (SSE). פרטי שימוש בטוקנים מופיעים בחלק הסיום של הזרם. זה מאפשר לך לעקוב אחר עלויות בזמן אמת. ניתן גם להשתמש ב temperature, top_p, וכן stop פרמטרים לשליטה בפלט.

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 טוקנים לכל בקשה, או 2,048 אם max_tokens לא מוגדר. מגבלות הקצב הן 300 בקשות לדקה לכל מפתח. שגיאת 429 מציינת שהגעת למגבלה זו. שמור על בקשות מתחת ל-8 MB וצמצם חיבורים מקבילים ל-8 לכל מפתח.