תיעוד API

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

התחל על ידי עדכון תצורת הלקוח שלך עם מפתח ה-API הייחודי שלך וכתובת הבסיס הספציפית שלנו. אינך צריך לשנות את לוגיקת הקוד שלך, רק את מחרוזת החיבור. נקודת הקצה היא https://api.gatewayllm.cc/v1 ומחייב את ה Authorization: Bearer <key> header. תצורה זו עובדת עם כל SDK התואם ל-OpenAI שיש לך כבר מותקן.

בקשה ראשונה

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

Copycurl https://api.gatewayllm.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Check server health status"}]
  }'

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

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

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

Copyfrom openai import OpenAI

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

הספרייה מטפלת ביישור ופירוק נתונים באופן אוטומטי. כעת ניתן להשתמש בשיטות סטנדרטיות כמו chat.completions.create עם השרת שלנו.

הגדרת SDK Node.js

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

Copyimport OpenAI from "openai";

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

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

סטרימינג ו-SSE

אפשרו זרם (streaming) כדי לקבל אסימונים (tokens) ככל שהם נוצרים, וכן להפחית את תחומת הזמן המוחשית עבור פלט ארוך. הגדירו stream: true בפרמטרי הבקשה שלך כדי להפעיל אירועים שנשלחים מהשרת. הדוגמה הבאה מראה כיצד לצרוך את הזרם בנתחים.

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)

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

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

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