مستندات API

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

درخواست‌های خود را به URL پایه ما با یک کلید API معتبر در هدر ارسال کنید.

• URL پایه: https://api.unlockedaimodels.com/v1
• هدر: Authorization: Bearer YOUR_API_KEY

شناسه مدل به سادگی uncensored. یک کلید فعال به ازای هر حساب کاربری دریافت می‌کنید که با تولید، هر کلید قبلی را جایگزین می‌کند.

Copycurl https://api.unlockedaimodels.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate the standard HTTP headers for a POST request."}]
  }'

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

The POST /v1/chat/completions نقطه پایانی متن شما را پردازش کرده و تکمیل را برمی‌گرداند.

این تنها نقطه پایانی متنی است که ارائه می‌دهیم. ما تولید تصویر، صوت یا جاسازی ارائه نمی‌دهیم. مدل یک آرایه پیام استاندارد شامل نوبت‌های سیستم، کاربر و دستیار را می‌پذیرد.

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

پاسخ‌های استریم (SSE)

استریمینگ را با تنظیم stream: true در بدنه درخواست خود.

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

این روش تأخیر ادراک‌شده را برای پاسخ‌های طولانی کاهش می‌دهد که هنگام تولید بیش از 16,000 توکن حیاتی است.

Copyfrom openai import OpenAI

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

فراخوانی تابع و ابزارها

ابزارها را در درخواست خود تعریف کنید تا فراخوانی تابع ساختاریافته را فعال کنید.

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

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

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.unlockedaimodels.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 و خروجی‌های ساختاریافته

مدل را مجبور به بازگشت JSON معتبر با تنظیم response_format: {"type": "json_object"}.

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

ترکیب با فراخوانی تابع، یک پایپ‌لاین مقاوم برای وظایف خودکار بدون لایه‌های اعتبارسنجی خارجی ایجاد می‌کند.

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

خلاقیت را با temperature و تنوع را با top_p.

استفاده stop sequences برای توقف تولید در نشانگرهای خاص. پنجره زمینه ۱۰۰,۰۰۰ توکن در مجموع است، با حداکثر خروجی ۱۶,۰۰۰ توکن مگر اینکه مقدار کمتری مشخص کنید max_tokens مقدار (پیش‌فرض 2,048 است).

محدودیت‌های نرخ ۳۰۰ درخواست در دقیقه و ۸ درخواست همزمان به ازای هر کلید است.