مستندات API & شروع سریع

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

ابتدا URL پایه را روی HTTPS://api.uncensoredal.com/v1 تنظیم کنید و کلید API خود را در هدر Authorization ارسال کنید. شما یک کلید فعال به ازای هر حساب دریافت می‌کنید و ایجاد کلید جدید، کلید قبلی را بلافاصله نامعتبر می‌سازد. این راه‌اندازی ساده با هر کلاینت سازگار با OpenAI بدون منطق مسیریابی پیچیده کار می‌کند.

Copycurl https://api.uncensoredal.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate the next 50 lines of a python script"}]
  }'

اندپوینت صرفاً برای تکمیل مکالمات (chat completions) است، بنابراین نیازی به مدیریت مسیریابی مدل ندارید. هر درخواست باید شامل شناسه مدل "uncensored" باشد تا مطمئن شوید به سرور استنتاج صحیح متصل می‌شوید. خطاهای احراز هویت وضعیت 401 را برمی‌گردانند اگر کلید موجود نباشد یا نامعتبر باشد.

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

درخواست POST را به /v1/chat/completions ارسال کنید و تاریخچه پیام‌های خود را در آرایه messages قرار دهید. سیستم ورودی متنی را پردازش کرده و متن تولیدشده را بدون رد محتوا برای استفاده بزرگسالان قانونی برمی‌گرداند. باید شناسه مدل را در پیکربندی خود روی "uncensored" تنظیم کنید تا سازگاری تضمین شود.

Copyfrom openai import OpenAI

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

درخواست‌ها بر اساس استفاده واقعی توکن‌ها محاسبه می‌شوند، و خطاها و ردشدگی‌ها رایگان باقی می‌مانند. این مدل پیش‌پرداخت به این معنی است که شما فقط بابت آنچه مصرف می‌کنید پرداخت می‌کنید. endpoint از پارامترهای استاندارد مانند temperature و top_p برای کنترل تصادفی بودن خروجی پشتیبانی می‌کند.

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

استریمینگ را با تنظیم stream به true در بدنه درخواست فعال کنید تا توکن‌ها را از طریق رویدادهای Server-Sent دریافت کنید. هر قطعه شامل آمار مصرف توکن در قطعه نهایی است که به شما امکان می‌دهد هزینه‌ها را به صورت بلادرنگ ردیابی کنید. این رویکرد تأخیر ادراک‌شده را برای تولیدهای طولانی کاهش می‌دهد.

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 رویدادهای پخش زنده استاندارد OpenAI-compatible را برمی‌گرداند که ادغام با کتابخانه‌های موجود رابط کاربری را آسان می‌کند. می‌توانید پخش زنده را زودتر متوقف کنید اگر کاربر ورودی خود را تغییر دهد.

فراخوانی تابع و حالت JSON

ابزارها را در درخواست خود تعریف کنید تا قابلیت‌های فراخوانی تابع را فعال کنید یا با استفاده از response_format خروجی JSON را اجباری کنید. API از tool_choice برای کنترل دقیق زمان فراخوانی تابع توسط مدل پشتیبانی می‌کند. این ویژگی با طرحواره استاندارد OpenAI کار می‌کند، بنابراین می‌توانید تعاریف ابزار موجود را مجدداً استفاده کنید.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.uncensoredal.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 تضمین می‌کند که خروجی JSON معتبر است که برای تجزیه داده‌های ساختاریافته به صورت برنامه‌نویسی مفید است. می‌توانید این مورد را با تنظیمات temperature ترکیب کنید تا تعادلی بین خلاقیت و قابلیت اطمینان ساختاری ایجاد کنید. API منطق اجرای ابزار را با بازگرداندن جزئیات فراخوانی تابع برای پردازش توسط کد شما مدیریت می‌کند.

پیکربندی پارامترهای مدل

پارامترهایی مانند دما، top_p، دنباله‌های توقف و Seed را برای کنترل رفتار تولید تنظیم کنید. پنجره زمینه از ۱۰۰,۰۰۰ توکن برای هم Prompt و هم Completion پشتیبانی می‌کند. حداکثر خروجی در هر درخواست به ۱۶,۰۰۰ توکن محدود است، یا ۲,۰۴۸ اگر max_tokens را مشخص نکنید.

می‌توانید از presence_penalty و frequency_penalty برای کاهش تکرار در متون طولانی استفاده کنید. این پارامترها امکان تنظیم سبک مدل را بدون تغییر وزن‌های زیرین فراهم می‌کنند. آن‌ها را به تدریج تنظیم کنید تا تعادل مناسب برای مورد استفاده خاص خود را پیدا کنید.

محدودیت‌ها، خطاها و زمینه

محدودیت نرخ درخواست‌ها روی ۳۰۰ درخواست در دقیقه و ۸ درخواست همزمان به ازای هر کلید تنظیم شده است. بدنه درخواست‌ها به 8 MB محدود شده است، بنابراین پنجره‌های متن بزرگ باید با دقت مدیریت شوند. خطاها شامل 401 برای کلیدهای نامعتبر، 402 برای اعتبار ناکافی و 429 برای محدودیت نرخ درخواست است.

اعتبار شما منقضی نمی‌شود، بنابراین می‌توانید استفاده را بین دوره‌های پرتلاش متوقف کنید بدون از دست دادن وجوه. اگر به محدودیت همزمانی برسید، با بازگشت نمایی (exponential backoff) مجدداً تلاش کنید. پنجره زمینه ۱۰۰,۰۰۰ توکنی اجازه تاریخچه گسترده می‌دهد، اما برای جلوگیری از بریده شدن خروجی، به محدودیت‌های خروجی توجه کنید.