مستندات API

شروع سریع: اتصال در 3 خط

API ما دقیقاً مانند رابط استاندارد chat-completions که قبلاً می‌شناسید کار می‌کند. به سادگی کلاینت خود را به base_url ما اشاره دهید و کلید API خود را ارائه دهید. هیچ مسیریابی پیچیده یا ویژگی‌های خاص فروشنده‌ای وجود ندارد. بقیه کار را ما انجام می‌دهیم.

آدرس پایه برای تمام درخواست‌ها https://api.toolsaiuncensored.com/v1. می‌توانید از هر کتابخانه یا SDK رسمی OpenAI با به‌روزرسانی پیکربندی URL پایه استفاده کنید. احراز هویت بر اساس یک توکن bearer واحد ارائه شده از طریق Authorization header. این یکپارچه‌سازی روان با استک موجود شما را تضمین می‌کند.

Copycurl https://api.toolsaiuncensored.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "run unit tests on the legacy auth module"}]
  }'

نقاط پایانی: تکمیل گفتگو و مدل‌ها

ما فقط نقاط پایانی ضروری برای تولید متن را ارائه می‌دهیم. The POST /v1/chat/completions نقطه پایانی متن‌های ورودی شما را پردازش کرده و متن تولید شده را برمی‌گرداند. از GET /v1/models به بررسی شناسه مدل موجود. ما خدمات تعبیه‌سازی، تولید تصویر، پردازش صدا یا تنظیم دقیق ارائه نمی‌دهیم. زیرساخت خود را ساده نگه دارید.

شناسه مدلی که باید ارسال کنید uncensored. این مدل با وزن باز اختصاصی ماست، نه یک نمونه GPT یا Claude فروش مجدد. این مدل مستقیماً بدون فیلترهای محتوا برای استفاده قانونی بزرگسالان پاسخ می‌دهد. برای ساختارهای پیکربندی خاص، مستندات نقطه پایانی را بررسی کنید.

Copyfrom openai import OpenAI

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

پارامترها: دما، Top P و Seed

خلاقیت و قطعیت خروجی‌های خود را با پارامترهای استاندارد کنترل کنید. تنظیم temperature به تغییر تصادفی‌سازی. تنظیم top_p برای محدود کردن نمونه‌گیری هسته (nucleus sampling). از seed برای نتایج تکرارپذیر. این ابزارها کنترل دقیقی بر فرآیند تولید متن به شما می‌دهند.

همچنین می‌توانید presence_penalty و frequency_penalty برای تأثیر بر تکرار توکن‌ها. مدل stop پارامتر به شما امکان تعریف توالی‌های پایان سفارشی را می‌دهد. این سطح از کنترل تضمین می‌کند که خروجی با مورد استفاده خاص شما مطابقت دارد. این مقادیر را در بدنه درخواست خود پیکربندی کنید.

Copyimport OpenAI from "openai";

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

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

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

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)

پشتیبانی فراخوانی تابع

ابزارها را در درخواست خود تعریف کنید تا به مدل اجازه فراخوانی پویای توابع را بدهید. مشخص کنید tools و tool_choice برای کنترل اجرا. مدل فراخوانی‌های ابزار را در جریان پاسخ برمی‌گرداند. این کار کارهای پیچیده و رفتار شبیه به عامل را امکان‌پذیر می‌کند.

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

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

کلید API شما اجازه ۳۰۰ درخواست در دقیقه را می‌دهد. می‌توانید ۸ درخواست همزمان را همزمان اجرا کنید. حداکثر اندازه بدنه درخواست ۸ مگابایت است. هر کلید به یک حساب مرتبط است؛ تولید کلید جدید کلید قبلی را جایگزین می‌کند.

پنجره زمینه (Context Window) در مجموع ۱۰۰,۰۰۰ توکن پشتیبانی می‌کند، شامل هم ورودی و هم خروجی. حداکثر خروجی در هر درخواست ۱۶,۰۰۰ توکن است. اگر مشخص نکنید max_tokens, محدودیت پیش‌فرض ۲,۰۴۸ توکن است. مصرف خود را پایش کنید تا در این حدود بمانید.