תיעוד API

התחלה מהירה: הבקשה הראשונה שלכם

שלחו את ההודעה הראשונה למודל ה-un-censored מיד. השתמשו בנקודת הקצה הסטנדרטית של chat-completions כדי לייצר טקסט. המודל מגיב ל-prompt בשפה טבעית ללא סירובי תוכן לשימוש בוגר חוקי. תצורה זו עובדת עם כל לקוח תואם OpenAI.

התחל על ידי התקנת ה-SDK לשפה המועדפת עליך. לאחר מכן הגדר את מפתח ה-API שלך. הדוגמה הבאה מציגה בקשת curl בסיסית לבדיקת חיבור.

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

Copycurl https://api.apiaicharacter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the current API rate limit status?"}]
  }'

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

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

צור את המפתח שלך דרך לוח הבקרה. העבר אותו בכותרת ה-Authorization כטוקן Bearer. שיטה זו תואמת ל-SDKs סטנדרטיים של OpenAI. ניתן להחליף ספקים על ידי שינוי כתובת הבסיס והמפתח בלבד.

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

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

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

שלח בקשת POST לנקודת הקצה של הצ'אט. כלול את הנחיות המערכת והמשתמש בגוף הבקשה. המודל מעבד את ההקשר ויוצר תגובה. ניתן להשתמש במצב JSON לפלט מבני.

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

Copyfrom openai import OpenAI

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

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

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

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

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

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.apiaicharacter.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 שולח טוקנים כפי שנוצרים. זה יוצר חווית קריאה חלקה יותר.

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

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

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)

מגבלות קצב ואילוצים

הבן את המגבלות כדי להימנע מהפרעות בשירות. ניתן לבצע 300 בקשות לדקה לכל מפתח. בקשות מקבילות מוגבלות ל-8 בו זמנית. גוף הבקשה לא יכול לעלות על 8 MB.

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

חלון ההקשר תומך ב-100,000 טוקנים בסך הכל. זה כולל גם את הפלט וגם את ההשלמה. ההפלט המרבי הוא 16,000 טוקנים לכל בקשה. הגדר max_tokens כדי לשלוט באורך ההפלט. שגיאות הן ללא תשלום, כך שלוגיקת ניסיון חוזר בטוחה.