مستندات API & Quickstart Guide

تنظیم URL پایه و احراز هویت

نقطه پایانی API HTTPS://api.unrestrictedaitools.com/v1 است. از SDKهای استاندارد OpenAI با تغییر base_url و ارائه کلید API خود استفاده کنید. می‌توانید با حساب Google یا ایمیل خود ثبت‌نام کنید تا کلید خود را به‌طور فوری دریافت نمایید.

Copycurl https://api.unrestrictedaitools.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "what is the capital of france"}]
  }'

هر درخواست باید هدر Authorization را شامل شود. کلید شما دسترسی به مدل بدون سانسور را بدون مراحل پیکربندی اضافی فراهم می‌کند.

اولین درخواست: POST /v1/chat/completions

درخواست POST را به /v1/chat/completions ارسال کنید و پیام‌های خود را وارد کنید. شناسه مدل 'uncensored' است. ورودی متن است و خروجی متن. اینجا ورودی/خروجی امبدینگ یا تولید تصویر وجود ندارد.

Copyfrom openai import OpenAI

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

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

پاسخ‌های استریم و مصرف توکن

با تنظیم stream به true، پخش زنده (streaming) را فعال کنید. توکن‌ها را از طریق 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)

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

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

دما را برای خلاقیت تنظیم کنید. top_p را برای نمونه‌گیری هسته تنظیم کنید. از توالی‌های توقف برای توقف خروجی استفاده کنید. این پارامترها به شما کنترل بر سبک تولید می‌دهند.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.unrestrictedaitools.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 و فراخوانی تابع

از response_format json_object برای خروجی ساختاریافته استفاده کنید. فراخوانی تابع را با ابزارها و tool_choice فعال کنید. این به مدل اجازه می‌دهد اقدامات را اجرا کند یا داده‌ها را در قالب خاصی بازگرداند.

ابزارها را به وضوح تعریف کنید. مدل از طرحواره (Schema) پیروی خواهد کرد. این موضوع برای ساخت عامل‌ها (Agents) یا پایپ‌لاین‌های استخراج داده مفید است.

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

شما ۳۰۰ درخواست در دقیقه و ۸ درخواست همزمان دریافت می‌کنید. پنجره زمینه ۱۰۰,۰۰۰ توکن است. حداکثر خروجی ۱۶,۰۰۰ توکن است. بدنه‌های درخواست باید کمتر از ۸ مگابایت باشند.

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