תיעוד API: מדריך התחלה מהירה

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

ממשק ה-API של Heretic AI הוא תואם ל-OpenAI לחלוטין. אתם מתקשרים איתו על ידי הפניית הלקוח שלכם לכתובת הבסיס שלנו: https://api.hereticai.cc/v1. האישור מסתמך על מפתח API יחיד לכל חשבון, שנוצר מיד עם ההרשמה דרך Google או אימייל. העבר מפתח זה ב Authorization כותרת כטוקן Bearer. מזהה המודל הוא פשוט uncensored. מודל יחיד זה מטפל בכל הבקשות שלך ללא מורכבות ניהול. שגיאות כמו 401 מציינות מפתח לא חוקי, בעוד ש-402 אומר שאתה צריך יותר קרדיט קריפטו ששולם מראש.

Copycurl https://api.hereticai.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "generate twenty test cases"}]
  }'

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

שלח בקשות יצירת טקסט באמצעות ה- POST /v1/chat/completions נקודת קצה. ה-API מצפה למערך הודעות סטנדרטי המכיל את היסטוריית השיחה או את הפרומפט שלך. הוא מחזיר טקסט מיוצר ב- choices מערך. זהו API תועלת טהור: טקסט נכנס, טקסט יוצא. אתה משלם רק על טוקנים שצרכת. אשראי מקדים לא פג תוקף לעולם, וסירובים או שגיאות לא עולים טוקנים. גישה זו מבטלת נעילות מנוי ורמות חינם בלתי צפויות.

Copyfrom openai import OpenAI

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

תגובות בסטרימינג (SSE)

אפשרו זרימת אסימונים בזמן אמת על ידי הגדרת stream: true בבקשה שלך. ה-API מחזיר אירועים שנשלחים מהשרת (SSE) עבור כל טוקן שנוצר. זה מאפשר לך להציג פלט בהדרגה, מה שחיוני לאפליקציות רגישות לזמן. סטטיסטיקות שימוש בטוקנים מופיעות בקטע הסופי של הזרם. תכונה זו עובדת בצורה חלקה עם SDKs סטנדרטיים של OpenAI שמטפלים ב-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)

פקודות פונקציה וכלים

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

מצב JSON

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

פרמטרים ומגבלות

שלוו יצירה באמצעות פרמטרים סטנדרטיים כמו temperature, top_p, וכן seed. חלון ההקשר הוא 100,000 טוקנים עבור קלט פלוס השלמה. פלט מקסימלי הוא 16,000 טוקנים לבקשה, או 2,048 אם max_tokens לא מוגדר. מגבלות הקצב הן 300 בקשות לדקה ו-8 בקשות מקבילות לכל מפתח. גוף הבקשה חייב להיות מתחת ל-8 MB. מגבלות אלו מבטיחות שימוש יציב בנפח גבוה עבור מפתחים.

Node.js

Copyimport OpenAI from "openai";

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