مستندات API

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

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

• از هدر زیر استفاده کنید: Authorization: Bearer YOUR_API_KEY
• URL پایه کلاینت خود را به نقطه پایانی ارائه شده تنظیم کنید.

این پیکربندی تضمین می‌کند که می‌توانید کتابخانه‌ها را بدون تغییر منطق اصلی خود جابجا کنید.

Copycurl https://api.topuncensored.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate a list of ten distinct UI layout patterns."}]
  }'

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

پرامپت‌های متنی را به /v1/chat/completions اندپوینت. شناسه مدل uncensored. این انتهای‌بند، قالب‌بندی چت استاندارد را با پیام‌ها مدیریت می‌کند. پاسخ‌های متنی را مستقیماً برمی‌گرداند. لایه‌ها یا بسته‌های اضافی وجود ندارد. شما پنجره زمینه ۱۰۰,۰۰۰ توکن را کنترل می‌کنید. درخواست‌های زیر ۸ مگابایت به‌خوبی کار می‌کنند. از این برای تولید متن مستقیم استفاده کنید.

درخواست خود را با یک پرامپت system و پیام user ساختار دهید. مدل بدون فیلتر کردن محتوای بزرگسالان قانونی پاسخ می‌دهد. خطاهایی مانند کلیدهای گمشده 401 برمی‌گردانند. اعتبار تمام شد؟ خطای 402 دریافت می‌کنید. این‌ها سیگنال‌های واضح هستند.

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

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

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

Copyfrom openai import OpenAI

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

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

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

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

Copyimport OpenAI from "openai";

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

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

تنظیم temperature, top_p، و stop توالی‌ها. تنظیم max_tokens to 16,000. Default is 2,048 if omitted. Control repetition with presence_penalty و frequency_penalty. از seed برای خروجی‌های قطعی. این پارامترها کیفیت تولید را دقیق‌تر می‌کنند. شما کنترل کاملی بر سبک خروجی دارید.

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

خطاها و پنجره زمینه

خطاها را به شیوه‌ای مناسب مدیریت کنید. ۴۰۱ یعنی کلید نامعتبر است. ۴۰۲ نشان‌دهنده اعتبار ناکافی است. ۴۲۹ نشان‌دهنده محدودیت نرخ است. پنجره زمینه ۱۰۰,۰۰۰ توکن در مجموع است. حداکثر خروجی ۱۶,۰۰۰ توکن است. توکن‌های خود را هوشمندانه مدیریت کنید. خطاها اعتبار مصرف نمی‌کنند. این در زمان اشکال‌زدایی صرفه‌جویی در هزینه دارد. از آخرین قطعه برای آمار مصرف استفاده کنید.

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

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)