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

پیش‌نیازها: SDK و URL پایه

ابتدا کتابخانه مورد علاقه خود را نصب کنید و آن را به اندپوینت ما اشاره دهید. این base_url است https://api.apicompatible.com/v1. مستندات API سازگار با OpenAI تأیید می‌کند که کتابخانه‌های استاندارد بلافاصله کار می‌کنند. به یک روتر یا پیکربندی دروازه پیچیده نیاز ندارید. URL و کلید را تغییر دهید، سپس کد موجود خود را اجرا کنید.

احراز هویت: فرمت هدر و کلید

کلید خود را در Authorization header. از فرمت Bearer your_api_key. API ما از ساختار کلید استاندارد OpenAI-compatible استفاده می‌کند. کلیدها به صورت فوری از طریق ورود با گوگل یا ایمیل تولید می‌شوند. کلید خود را امن نگه دارید، زیرا دسترسی به اعتبار پیش‌پرداخت شما را فراهم می‌کند.

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

درخواست‌ها را به /v1/chat/completions. مدل را به عنوان uncensored. API پاسخ‌های متنی را مستقیماً برمی‌گرداند. برای بررسی اتصال از دستور curl زیر استفاده کنید:

Copycurl https://api.apicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List available models"}]
  }'

این رویکرد سازگار با SDK openai تضمین می‌کند که شما تولید متن بدون محدودیت دریافت می‌کنید. مدل پرامپت‌های پیچیده را بدون ردی‌های غیرضروری برای محتوای قانونی مدیریت می‌کند.

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

استریمینگ را با تنظیم stream: true. پاسخ‌ها از طریق رویدادهای ارسالی سرور (SSE) دریافت می‌شوند. جزئیات مصرف توکن در قطعه نهایی ظاهر می‌شود. مستندات API سازگار با OpenAI از پروتکل‌های استریم استاندارد پشتیبانی می‌کند. از این روش برای تجربه‌های کاربری بلادرنگ استفاده کنید:

Copyfrom openai import OpenAI

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

استریمینگ تأخیر ادراک‌شده را به شدت کاهش می‌دهد. این قابلیت به صورت یکپارچه با کتابخانه‌های استاندارد سمت کلاینت کار می‌کند.

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

تولید را با پارامترهای استاندارد کنترل کنید. تنظیم temperature برای تصادفی بودن یا top_p برای نمونه‌گیری هسته. Enable tools برای فراخوانی تابع. حالت JSON از طریق response_formatThe uncensored مدل این محدودیت‌ها را به‌خوبی رعایت می‌کند:

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.apicompatible.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 سخت‌گیرانه را برای موارد استفاده برنامه‌نویسی اعمال کنید.

Limits: Rate Limits and Body Size

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

جریان‌سازی

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)