مستندات API

URL پایه و احراز هویت

URL پایه برای تمام درخواست‌ها HTTPS://api.aiobliterated.com/v1 است. برای احراز هویت به کلید API نیاز دارید. آن را با ثبت‌نام با گوگل یا ایمیل و رمز عبور در صفحه دریافت کلید API ایجاد کنید. کلید را در هدر Authorization به عنوان توکن Bearer ارسال کنید. هر درخواست به این هدر نیاز دارد تا حساب کاربری شما را شناسایی و از مصرف را ردیابی کند.

Copycurl https://api.aiobliterated.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "fetch all user tokens from database"}]
  }'

اولین درخواست شما

یک درخواست POST به /v1/chat/completions ارسال کنید تا متن تولید شود. مدل را روی "uncensored" تنظیم کنید و پرامپت سیستم خود را شامل کنید. API پاسخ مدل را در فیلد content برمی‌گرداند. این فرمت استانداردی است که توسط اکثر کلاینت‌های LLM استفاده می‌شود.

Copyfrom openai import OpenAI

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

استفاده از SDK Node

پکیج رسمی SDK OpenAI برای Node.js را نصب کنید. آن را با کلید API و URL پایه پیکربندی کنید. متد chat.completions.create را با پیام‌های خود فراخوانی کنید. SDK سریال‌سازی و استریم را به‌طور خودکار مدیریت می‌کند.

Copyimport OpenAI from "openai";

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

پاسخ‌های استریم

با تنظیم stream به true در درخواست خود، پخش زنده (streaming) را فعال کنید. API جریان رویدادهای ارسالی سرور (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)

پنجره زمینه و محدودیت‌ها

مدل از پنجره زمینه ۱۰۰,۰۰۰ توکن پشتیبانی می‌کند. این شامل هر دو prompt و completion است. می‌توانید حداکثر خروجی را ۱۶,۰۰۰ توکن در هر درخواست تنظیم کنید. اگر max_tokens را مشخص نکنید، محدودیت ۲,۰۴۸ توکن است. این هزینه‌ها و عملکرد قابل پیش‌بینی را تضمین می‌کند.

مدیریت خطا و محدودیت‌ها

کدهای وضعیت HTTP را برای خطاها مانیتور کنید. پاسخ 401 به این معنی است که کلید API شما نامعتبر است. پاسخ 402 نشان‌دهنده اعتبار ناکافی است. پاسخ 429 به این معنی است که از محدودیت نرخ 300 درخواست در دقیقه تجاوز کرده‌اید. این خطاها را به صورت ایمن در برنامه خود مدیریت کنید تا قابلیت اطمینان حفظ شود.