مستندات API: مدل uncensored

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

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

کلید را در Authorization header. قالب نیازمند Bearer prefix. کلیدهای نامعتبر فوراً کد وضعیت 401 برمی‌گردانند. فرمت توکن را حدس نزنید. از کلیدی که پس از ثبت‌نام نشان داده می‌شود استفاده کنید.

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

پیام‌ها را برای تولید پاسخ‌های متنی ارسال کنید. نقطه پایانی پیکربندی‌های JSON استاندارد را می‌پذیرد. نقش‌های system و user خود را به وضوح تعریف کنید.

درخواست خود را با model field set to uncensored. API ورودی را پردازش کرده و متن تولید شده را برمی‌گرداند. خطاها وضعیت 402 را در صورت عدم کافی بودن اعتبار برمی‌گردانند. محدودیت‌های نرخ پاسخ 429 را فعال می‌کنند.

پارامترهای پشتیبانی‌شده

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

همچنین می‌توانید seed برای نتایج تکرارپذیر. از stop sequences برای توقف تولید زودهنگام. API از presence_penalty و frequency_penalty برای کنترل سبک.

استریمینگ و SSE

فعال‌سازی خروجی بلادرنگ با تنظیم stream به true. سرور هنگام تولید توکن‌ها، رویدادهای ارسالی سرور (SSE) را ارسال می‌کند. این موضوع تأخیر ادراک‌شده را برای پاسخ‌های طولانی کاهش می‌دهد.

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

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

ابزارها را در درخواست خود تعریف کنید تا قابلیت‌های فراخوانی تابع را فعال کنید. مدل بر اساس زمینه تصمیم می‌گیرد چه زمانی از ابزار استفاده کند. تعاریف ابزار را با name, description، و parameters.

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

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

پنجره زمینه (Context Window) در مجموع ۱۰۰,۰۰۰ توکن پشتیبانی می‌کند. این شامل توکن‌های ورودی (Prompt) و خروجی (Completion) است. درخواست‌هایی که از این محدودیت تجاوز کنند، شکست می‌خورند. حداکثر اندازه بدنه درخواست ۸ مگابایت است.

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

cURL

Copycurl https://api.toolcallingllms.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate 200 tokens of safe text"}]
  }'

پایتون

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

جریان‌سازی

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)