مستندات API

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

URL پایه API برابر است با HTTPS://api.llmfornsfw.com/v1. شما با افزودن کلید API منحصر‌به‌فرد خود در هدر درخواست، احراز هویت می‌کنید. این کلید بلافاصله پس از ثبت‌نام از طریق گوگل یا ایمیل در صفحه Get API key تولید می‌شود.

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

Copycurl https://api.llmfornsfw.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate a 200 word summary of the provided technical documentation."}]
  }'

• کلید خود را امن نگه دارید.
• یک کلید فعال برای هر حساب.
• کلیدهای جدید را به راحتی تولید کنید.

اولین درخواست

یک درخواست POST به /v1/chat/completions ارسال کنید تا متن تولید شود. شناسه مدل "uncensored" است. این مدل بدون رد محتوای قانونی برای استفاده بزرگسالان پاسخ می‌دهد که آن را برای سناریوهای چت‌بات NSFW ایده‌آل می‌کند.

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

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.llmfornsfw.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 توکن‌زنی را به صورت داخلی مدیریت می‌کند. شما فقط زبان طبیعی ارسال می‌کنید. پاسخ شامل متن تولید شده است. این را برای RP یا تولید داستان استفاده کنید.

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

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

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

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

از قابلیت فراخوانی تابع (function calling) برای تعریف ابزارها استفاده کنید. مدل شما می‌تواند توابع را فراخوانی کند. این قابلیت استخراج داده‌های ساختاریافته را امکان‌پذیر می‌کند. ابزارها را در آرایه پیام‌ها تعریف کنید.

این API از tool_choice پشتیبانی می‌کند. می‌توانید فراخوانی تابع را مجبور یا مجاز کنید. این برای یکپارچه‌سازی‌های NSFW LLM API که به خروجی ساختاریافته نیاز دارند مفید است. مدل را برای استفاده از ابزارها تنظیم کنید.

Copyimport OpenAI from "openai";

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

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

حالت JSON

response_format را روی json_object تنظیم کنید. مدل JSON معتبری تولید می‌کند. این کار تجزیه‌ی سازگار را تضمین می‌کند. این کار را برای پردازش داده‌های NSFW استفاده کنید.

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

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

Copycurl https://api.llmfornsfw.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate a 200 word summary of the provided technical documentation."}]
  }'

با پرامپت‌های ساده تست کنید. ساختار JSON را بررسی کنید. دما را برای پایداری تنظیم کنید. دمای پایین ثبات را تضمین می‌کند.

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

پنجره زمینه ۱۰۰,۰۰۰ توکن است. این مقدار شامل متن ورودی و پاسخ می‌شود. حداکثر خروجی ۱۶,۰۰۰ توکن است. max_tokens را تنظیم کنید تا طول را کنترل نمایید.

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

خطاهایی مانند ۴۰۲ به این معنی است که اعتباری ندارید. با ارزهای دیجیتال اعتبار خود را افزایش دهید. USDT یا USDC کار می‌کنند. اعتبار هرگز منقضی نمی‌شود. موجودی خود را به طور منظم بررسی کنید.