התחלה מהירה לאינטגרציה של Character api
מדריך ההתחלה המהיר הזה מפעיל את ה-API של הדמות שלך עם SDKs סטנדרטיים של OpenAI תוך דקות. תגדיר את כתובת ה-URL הבסיסית, תזריק את מפתח ה-API שלך, ותשלח את הבקשה הראשונה שלך ללא הגבלות.
התקן את ה-SDK
התחל בהתקנת ספריית הלקוח הרשמית לשפתך. הדבר מבטיח תאימות לנקודת הקצה התואמת ל-OpenAI שאנו מספקים. הספרייה מטפלת עבורך בנטרול ולוגיקת נסיונות חזרה.
ל-Python, השתמש ב-pip. ל-Node.js, השתמש ב-npm. שלב זה לוקח שניות ומגדיר את הסביבה לדוגמאות הקוד הבאות.
הגדר את כתובת הבסיס שלך
כוון את לקוח ה-SDK שלך לנקודת הקצה שלנו כדי לגשת למודל ללא צנזורה. כתובת הבסיס היא HTTPS://api.apicharacter.com/v1. זה מחליף את כתובת ה-OpenAI המוגדרת כברירת מחדל בתצורה שלך.
ללא שינוי זה, הבקשות ייכשלו או יפגעו בשירות הלא נכון. עליך להגדיר זאת רק פעם אחת בעת אתחול מופע הלקוח שלך.
הגדר את מפתח ה-API שלך
הזן את המפתח שלך למשתנה הסביבה או לתצורת הלקוח. אימות נדרש לכל בקשה כדי לעקוב אחר שימוש באשראי ששולם מראש. המפתח שלך מעניק גישה לנקודת הקצה של LLM ללא צנזורה.
שמרו על הערך הזה מאובטח. הוא משמש כאישור היחיד שלכם לחשבון. אין צורך במספר טלפון או אימות נוסף לגישה בסיסית.
בצעו את הבקשה הראשונה שלכם
שלח השלמת צ'אט פשוטה כדי לאמת חיבוריות. מזהה המודל הוא "uncensored". זה מאשר שהאימות וה-URL הבסיסי שלך נכונים לפני שאתה בונה את האפליקציה שלך.
ראו את הדוגמה להלן לבקשת cURL סטנדרטית.
curl https://api.apicharacter.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "set my name to Alex"}]
}'
טפול בתגובות סטרימינג
אפשרו זרימת נתונים לזמן אחזור נמוך יותר בממשקי הצ'אט שלכם. הגדירו את הפרמטר stream לערך true בבקשה שלכם. ה-SDK יחזיר אסימונים כפי שהם נוצרים.
זה קריטי לחוויות משתגבבות. אתה מטפל בפלחים חלקיים כפי שהם מגיעים באמצעות אירועים שנשלחו על ידי השרת (Server-Sent Events).
stream = 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 טוקנים אלא אם כן תציין אחרת.
גבול הקצב הוא 300 בקשות לדקה. שגיאת 401 מציינת מפתח לא חוקי. שגיאת 402 מציינת אפס יתרה. שגיאת 429 מציינת שחרגתם מגבול הקצב. קחו זאת בחשבון בעת סקאלת ייצור.
Python
from openai import OpenAI
client = OpenAI(base_url="https://api.apicharacter.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.js
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.apicharacter.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 של הדמויות שלי?
הירשמו באמצעות Google או דוא"ל בדשבורד. מפתח ה-API שלכם מופיע מיד ללא אימות טלפון. תוכלו ליצור מפתח חדש אם צריך, ולהחליף את הישן.
האם זהו ממשק API תואם openAI?
כן, הוא עוקב אחר פורמט ה-chat-completions הסטנדרטי. עליך רק לשנות את כתובת ה-base URL ואת מפתח ה-API. רוב ה-SDKs של OpenAI עובדים מהקופסה עם שינויי תצורה מינוריים.
מה קורה אם אקבל שגיאת 402?
משמעות הדבר היא שהקרדיט שלך שולם מראש והתאזז. הוסף כסף באמצעות קריפטו כדי להמשיך בשירות. שגיאות וסירוזים לא צורכים קרדיט, כך שאתה משלם רק על שימוש בפועל.
קבלו את המפתח מיד
הירשם, קבל את המפתח שלך, עדכן את כתובת ה-URL הבסיסית. זהו.