مستندات API سازگار با OpenAI

شروع سریع: اتصال با SDK OpenAI

ابتدا با کلید خود احراز هویت کنید و کلاینت را به URL پایه ما پیکربندی کنید. این پیکربندی با SDKهای رسمی OpenAI برای Python و Node.js کار می‌کند و تضمین می‌کند که می‌توانید همان کد کلاینت را روی سرویس ما اجرا کنید. شما به یک کلید API معتبر از داشبورد و پیکربندی نقطه پایانی صحیح نیاز دارید.

Copycurl https://api.openaiapicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Return the current UTC timestamp in ISO 8601 format"}]
  }'

Copyfrom openai import OpenAI

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

Copyimport OpenAI from "openai";

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

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

متن را به نقطه پایانی چت واحد ما برای خروجی متنی مستقیم ارسال کنید. ما از POST /v1/chat/completions برای پردازش پرامپت‌های شما و بازگرداندن متن تولید شده استفاده می‌کنیم. این تعامل اصلی برای اکثر برنامه‌های LLM است و نیاز به مسیریابی پیچیده یا فراخوانی‌های خدمات اضافی ندارد.

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)

استریم با SSE

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

Function Calling & JSON Mode

ابزارها را یکپارچه کنید و خروجی‌های ساختاریافته را برای تعاملات برنامه‌ای قابل اعتماد اعمال نمایید. از پارامتر tools برای تعریف طرح‌واره‌های تابع و تنظیم response_format روی json_object برای انطباق دقیق با JSON استفاده کنید. مدل بدون سانسور ما دستورالعمل‌های پیچیده و موارد حاشیه‌ای را بدون رد درخواست‌های تابعی معتبر مدیریت می‌کند.

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

مصرف خود را در برابر محدودیت‌های سخت‌گیرانه به ازای هر کلید پایش کنید تا از اختلال در سرویس جلوگیری کنید. شما مجاز به ۳۰۰ درخواست در دقیقه و هشت درخواست همزمان به ازای هر کلید هستید، با محدودیت بدنه ۸ مگابایت. خطاهایی مانند ۴۰۱ (کلید نامعتبر)، ۴۰۲ (عدم موجودی) و ۴۲۹ (محدودیت نرخ) وضعیت‌های خاص حساب کاربری را نشان می‌دهند.

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

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