תיעוד API

התחלה מהירה לבקשה הראשונה שלך

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

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

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

• כתובת בסיס: https://api.nsfwlocalllm.com/v1
• כותרת Auth: Authorization: Bearer YOUR_API_KEY

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

שלח בקשת השלמת צ'אט

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

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

Copycurl https://api.nsfwlocalllm.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Send me the server uptime stats"}]
  }'

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

אפשרו זרימת נתונים לפלט בזמן אמת

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

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

Copyfrom openai import OpenAI

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

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

השתמשו במצב JSON לנתונים מבניים

כפה על המודל להפיק JSON תקין לצריכה תכנותית. הגדר response_format אל {"type": "json_object"} בקשתך. זה מפחית שגיאות ניתוח ומבטיח מבני נתונים עקביים.

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

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.nsfwlocalllm.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 בצד הלקוח כדי ללכוד מקרי קצה.

ממש קריאה לפונקציה

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

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

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

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)