תיעוד API & Quickstart Guide

הגדרת כתובת URL בסיסית ואימות

נקודת הקצה של ה-API היא HTTPS://api.unrestrictedaitools.com/v1. השתמש ב-SDKs הסטנדרטיים של OpenAI על ידי שינוי ה-base_url וספק את מפתח ה-API שלך. ניתן להירשם עם Google או אימייל כדי לקבל את המפתח שלך מיד.

Copycurl https://api.unrestrictedaitools.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "what is the capital of france"}]
  }'

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

בקשה ראשונה: POST /v1/chat/completions

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

Copyfrom openai import OpenAI

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

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

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

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

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

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

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

Copyimport OpenAI from "openai";

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

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

מצב JSON וקריאת פונקציות

השתמשו בפרמטר response_format json_object לתפוקה מבנית. הפעילו קריאת פונקציות עם כלים ו-tool_choice. זה מאפשר למודל לבצע פעולות או להחזיר נתונים בפורמט ספציפי.

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

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

אתה מקבל 300 בקשות לדקה ו-8 בקשות מקבילות. חלון ההקשר הוא 100,000 טוקנים. הפלט המקסימלי הוא 16,000 טוקנים. גופי בקשות חייבים להיות מתחת ל-8 MB.

אם תפגע ב-429, המתן רגע. 401 אומר מפתח לא תקף. 402 אומר אין אשראי. מגבלות אלו מבטיחות שימוש הוגן לכל המפתחים.