مستندات API

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

کلید API شما هر درخواست را احراز هویت می‌کند. از https://api.whatisabliteration.com/v1 به‌عنوان آدرس پایه (base URL). کلید خود را در Authorization هدر به عنوان یک توکن Bearer. این پیکربندی با هر کلاینت سازگار با OpenAI کار می‌کند.

Copycurl https://api.whatisabliteration.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Show me last 5 requests"}]
  }'

کلید خود را امن نگه دارید. یک کلید برای هر حساب کاربری. کلیدهای قدیمی را در صورت نفوذ جایگزین کنید.

نقطه پایانی تکمیل چت

متن را به POST /v1/chat/completionsشناسه مدل uncensored. این انتهای‌بند، تمام تولید متن را مدیریت می‌کند. از تصویر، صوت یا ویدیو پشتیبانی نمی‌کند. شما فقط بابت توکن‌های مصرفی پرداخت می‌کنید. خطاها رایگان هستند. رد شدن‌ها رایگان هستند.

Copyfrom openai import OpenAI

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

پرامپت سیستم خود را برای تعریف شخصیت پیکربندی کنید. مدل مستقیماً بدون تعارف پاسخ می‌دهد. پنجره زمینه 100,000 توکن در مجموع است.

استریمینگ و پشتیبانی SSE

استریمینگ را با تنظیم stream: true. 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)

توکن‌های ناقص را با دقت مدیریت کنید. آن‌ها را برای تشکیل پاسخ کامل به هم بچسبانید. این روش برای رابط‌های چت بلادرنگ ایده‌آل است.

فراخوانی تابع و ابزارها

ابزارها را در درخواست خود تعریف کنید. مدل می‌تواند در صورت لزوم توابع را فراخوانی کند. از tool_choice برای کنترل رفتار. تنظیم temperature برای خلاقیت. پارامترهایی مانند top_p و stop. این اجازه می‌دهد تا workflowهای پیچیده عامل‌ها را بسازید.

Copyimport OpenAI from "openai";

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

تنظیم response_format به {"type": "json_object"}مدل فقط JSON معتبر را خروجی می‌دهد. این برای تجزیه داده‌های ساختاریافته تضمین می‌کند. این را برای APIهایی که فرمت‌های سختگیرانه را انتظار دارند استفاده کنید. این قابلیت اطمینان را برای سیستم‌های downstream بهبود می‌بخشد.

از این حالت هنگام یکپارچه‌سازی با سایر سرویس‌ها استفاده کنید. خروجی را مستقیماً تجزیه کنید. از ترفندهای regex برای ساختار اجتناب کنید.

پارامترها و محدودیت‌ها

حداکثر خروجی 16,000 توکن است. پیش‌فرض حداکثر 2,048 توکن است. پنجره زمینه 100,000 توکن است. محدودیت نرخ 300 درخواست در دقیقه است. درخواست‌های همزمان 8 به ازای هر کلید است. حداکثر بدنه درخواست 8 مگابایت است. برای کلیدهای نامعتبر 401 را مدیریت کنید. برای اعتبار ناکافی 402 را مدیریت کنید. برای محدودیت نرخ 429 را مدیریت کنید.