مستندات API

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

درخواست‌ها را به https://api.uncensoredaicharacter.com/v1 با کلید API خود در Authorization header. کلید بلافاصله پس از ثبت‌نام از طریق گوگل یا ایمیل صادر می‌شود. از شناسه مدل uncensored برای تمام تکمیل‌ها.

Copycurl https://api.uncensoredaicharacter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the current server uptime status"}]
  }'

هر حساب یک کلید فعال دارد. اگر کلید را چرخش دهید، کلید قبلی بلافاصله از کار می‌افتد. محدودیت‌ها به ازای هر کلید اعمال می‌شود تا خدمات عادلانه باقی بماند. بدنه درخواست‌ها باید زیر ۸ مگابایت باشد. این کار عملکرد ثابت برای برنامه شما را تضمین می‌کند.

اولین درخواست: SDK Python

کلاینت را با کلید خود مقداردهی اولیه کنید و آن را به URL پایه ما اشاره دهید. نام مدل و پیام‌های کاربر را برای دریافت پاسخ متنی ارسال کنید. این کار با کتابخانه‌های سازگار با OpenAI استاندارد کار می‌کند. پاسخ شامل مصرف توکن و محتوا است.

Copyfrom openai import OpenAI

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

می‌توانید پارامترهایی مانند temperature برای کنترل تصادفی‌سازی. API بسته پاسخ JSON یا متن را بر اساس تنظیمات شما برمی‌گرداند. خطاها کدهای وضعیت HTTP استاندارد را برمی‌گردانند. کد وضعیت را بررسی کنید تا مشکلات را به صورت شایسته مدیریت کنید.

اولین درخواست: SDK Node

مشتری Node.js را پیکربندی کنید تا از نقطه پایانی ما استفاده کند. تنظیم کنید apiKey و baseURL properties به درستی. فراخوانی chat.completions.create() با شناسه مدل. کتابخانه سریال‌سازی و تلاش مجدد را به صورت خودکار مدیریت می‌کند.

Copyimport OpenAI from "openai";

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

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

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

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

استریمینگ تأخیر ادراک‌شده را برای کاربران نهایی کاهش می‌دهد. می‌توانید توکن‌ها را به صورت بلادرنگ پردازش کنید و منتظر پاسخ کامل نمانید. بافرینگ توسط کتابخانه کلاینت مدیریت می‌شود. تعداد توکن‌ها را برای ماندن در اعتبار پیش‌پرداخت خود پایش کنید.

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

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

پنجره زمینه 100,000 توکن برای ورودی و خروجی ترکیبی اجازه می‌دهد. حداکثر خروجی 16,000 توکن در هر درخواست است. تنظیم max_tokens برای کنترل طول خروجی. خطاها اعتبار مصرف نمی‌کنند اگر قبل از پردازش تشخیص داده شوند. این از موجودی شما در برابر حلقه‌های تصادفی محافظت می‌کند.

پیکربندی و محدودیت‌ها

پارامترهایی مانند top_p, seed، و stop توالی‌ها برای شکل‌دهی به خروجی. از response_format برای حالت JSON. فراخوانی تابع از طریق tools پشتیبانی می‌شود. تمام پارامترها از طرح استاندارد OpenAI پیروی می‌کنند. این مهاجرت را برای پروژه‌های موجود آسان می‌کند.

درخواست‌ها به ۸ اتصال همزمان به ازای هر کلید محدود می‌شوند. محدودیت اندازه بدنه ۸ مگابایت است. این محدودیت‌ها عملکرد پایدار را تضمین می‌کنند. مدل uncensored موضوعات متنوع را بدون رد شدن مدیریت می‌کند. تنظیمات را برای تطبیق کامل با مورد استفاده خود تنظیم کنید.