راهنمای شروع سریع API Opensfw

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

ابتدا کلید خود را از داشبورد تولید کنید. از https://api.opensfw.com/v1 URL پایه و کلید API خود را در Authorization header. این پیکربندی با هر کلاینت SDK استاندارد OpenAI کار می‌کند.

انجام اولین درخواست تکمیل چت

یک درخواست POST به /v1/chat/completions با شناسه مدل و پیام‌ها. مدل بدون سانسور ورودی شما را پردازش کرده و متن تولید شده را برمی‌گرداند. از مثال curl زیر برای بررسی اتصال استفاده کنید.

Copycurl https://api.opensfw.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the current release version of the model?"}]
  }'

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

استریمینگ را با تنظیم stream: true در درخواست خود. شما قطعاتی از متن را همان‌طور که تولید می‌شوند دریافت می‌کنید. قطعه نهایی شامل آمار کامل مصرف توکن برای صورت‌حساب است. از مثال پایتون برای مدیریت جریان استفاده کنید.

Copyfrom openai import OpenAI

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

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

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

Copyimport OpenAI from "openai";

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

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

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

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)

درک پنجره‌های زمینه و محدودیت‌ها

مدل بدون سانسور، پنجره زمینه‌ای ۱۰۰,۰۰۰ توکنی را پشتیبانی می‌کند. حداکثر خروجی ۱۶,۰۰۰ توکن در هر درخواست است. بدنه درخواست خود را زیر ۸ مگابایت نگه دارید. این موضوع عملکرد ثابتی برای ورودی‌های بزرگ تضمین می‌کند.