مستندات API برای تکمیل‌های چت Uncensored

شروع سریع: اتصال در Python یا JavaScript

اتصال به API با به‌روزرسانی URL پایه و تنظیم کلید API خود. اندپوینت درخواست‌های تکمیل چت استاندارد را می‌پذیرد و متن برمی‌گرداند. اگر از SDKهای رسمی OpenAI استفاده می‌کنید، نیازی به نصب کتابخانه‌های سفارشی ندارید، زیرا رابط دقیقاً با مشخصات آن‌ها مطابقت دارد.

با یک درخواست HTTP ساده برای بررسی اتصال شروع کنید. از دستور curl زیر برای ارسال یک پرس‌وجوی پایه به uncensored مدل. جایگزین YOUR_API_KEY با کلید تولید شده در داشبورد خود.

Copycurl https://api.aiplayrolebest.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Set the character persona to a grumpy detective"}]
  }'

برای توسعه‌دهندگان Python، فرآیند تقریباً یکسان است. کلاینت را با کلید و URL پایه صحیح مقداردهی اولیه کنید. این تضمین می‌کند که تمام درخواست‌ها از سرورهای بدون سانسور ما عبور کنند، در حالی که سازگاری با ابزارهای موجود حفظ می‌شود.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.aiplayrolebest.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 به دست آورند. مقدار baseURL property به endpoint ما. این رویکرد به شما امکان می‌دهد API را در سرورهای وب یا سرویس‌های بک‌اند با حداقل تغییرات کد ادغام کنید.

Copyimport OpenAI from "openai";

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

مدیریت احراز هویت و کلید API

احراز هویت به یک کلید API واحد متکی است که در هدر ارسال می‌شود. این کلید را در Authorization هدر برای هر درخواست. اگر کلید موجود نباشد یا نامعتبر باشد، API بلافاصله خطای 401 برمی‌گرداند. این دسترسی امن به اعتبار پیش‌پرداخت شما را تضمین می‌کند.

کلید خود را در داشبورد ایجاد کنید. کلید تنها یک‌بار هنگام ایجاد نمایش داده می‌شود. آن را به‌طور امن در متغیرهای محیطی (environment variables) خود ذخیره کنید. آن را به‌طور عمومی به اشتراک نگذارید. هر حساب در هر زمان فقط می‌تواند یک کلید فعال داشته باشد. ایجاد کلید جدید، بلافاصله کلید قبلی را نامعتبر می‌کند.

کلید را در درخواست‌های خود به این صورت استفاده کنید: Authorization: Bearer YOUR_API_KEY. این قالب هدر استاندارد با تمام SDKهای بزرگ کار می‌کند. کلید خود را برای تکرار سریع در طول توسعه در دسترس نگه دارید.

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

درخواست‌ها را به /v1/chat/completions نقطه پایانی. آرایه پیام‌های خود را شامل کنید و مدل را روی uncensored. می‌توانید پارامترهایی مانند temperature و top_p برای کنترل خ creativite. مقادیر بالاتر پاسخ‌های متنوع‌تری تولید می‌کنند.

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

از stop پارامتر برای توقف تولید در عبارات خاص. این به اعمال ساختار مکالمه کمک می‌کند. The seed پارامتر خروجی‌های قابل تکرار را برای تست فراهم می‌کند. این ابزارها کنترل دقیقی بر رفتار مدل به شما می‌دهند.

پاسخ‌های استریم‌شده و داده‌های استفاده

استریمینگ را با تنظیم stream: true در درخواست شما. API قطعاتی از متن را همان‌طور که تولید می‌شوند برمی‌گرداند. این امر تأخیر ادراک‌شده را برای کاربران نهایی کاهش می‌دهد. هر قطعه حاوی متن جزئی و داده‌های متا است.

داده‌های مصرف در قطعه نهایی ظاهر می‌شود. این شامل تعداد توکن‌های ورودی و خروجی است. بررسی کنید usage field in the last response object. This allows accurate billing verification without separate API calls. Track token consumption in real-time.

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

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 محدودیت ۳۰۰ درخواست در دقیقه به ازای هر کلید را اعمال می‌کند. درخواست‌های همزمان برای هر کلید به هشت محدود شده‌اند. بدنه درخواست نباید از ۸ مگابایت تجاوز کند. تجاوز از این محدودیت‌ها خطای 429 را برمی‌گرداند. برای مدیریت نوسانات گذرا، بازگشت نمایی را پیاده‌سازی کنید.

خطاهای رایج شامل 401 برای کلیدهای نامعتبر و 402 برای اعتبار ناکافی است. پاسخ 402 نشان می‌دهد که موجودی پیش‌پرداخت شما تمام شده است. حساب خود را شارژ کنید تا سرویس ادامه یابد. خطاها توکن مصرف نمی‌کنند، بنابراین تلاش مجدد پس از رفع مشکل رایگان است.

بدنه پاسخ را برای پیام‌های خطای دقیق بررسی کنید. API یک شیء JSON با نوع خطا و پیام برمی‌گرداند. از این اطلاعات برای رفع سریع مشکلات استفاده کنید. مدیریت خطای مناسب تجربه‌ای روان برای کاربران شما در دوره‌های ترافیک بالا تضمین می‌کند.

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

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

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

حالت JSON را با فراخوانی تابع برای یکپارچه‌سازی‌های مقاوم ترکیب کنید. خروجی JSON را در سمت کلاینت اعتبارسنجی کنید. از tool_choice پارامتری برای کنترل زمان فراخوانی توابع. این انعطاف‌پذیری از معماری‌های برنامه متنوع پشتیبانی می‌کند. مطمئن شوید ابزارهای شما برای عملکرد بهینه به خوبی تعریف شده‌اند.

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

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

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

مصرف زمینه (Context) را پایش کنید تا در حدود مجاز بمانید. API مصرف توکن را به‌دقت ردیابی می‌کند. خطاها و رد شدن‌ها توکن مصرف نمی‌کنند. این مدل صورتحساب شفاف به شما کمک می‌کند هزینه‌ها را پیش‌بینی کنید. پنجره‌های زمینه خود را برای بیشینه‌سازی ارزش برنامه‌ریزی کنید.