مستندات API

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

کلید API شما هر درخواست را احراز هویت می‌کند. آن را در Authorization هدر به عنوان یک توکن bearer. URL پایه به نقطه پایگاه سازگار با OpenAI ما اشاره دارد. از SDKهای رسمی یا هر کتابخانه کلاینت سازگار استفاده کنید. URL پایه را به دامنه ما تغییر دهید و کلید خود را تزریق کنید. برای ثبت‌نام نیازی به شماره تلفن نیست. فقط یک آدرس ایمیل برای دریافت کلید نیاز است. کلید بلافاصله پس از ایجاد نمایش داده می‌شود. از این کلید برای تمام تماس‌های بعدی استفاده کنید. تا زمانی که آن را لغو یا جایگزین نکنید معتبر باقی می‌ماند.

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

یک درخواست POST به نقطه پایانی تکمیل چت ارسال کنید. شناسه مدل را به عنوان uncensored. پیام‌های سیستم و کاربر را در بدنه درخواست قرار دهید. پاسخ شامل متن تولید شده است. خطاها کدهای وضعیت HTTP استاندارد را برمی‌گردانند. از این ساختار ساده برای بررسی اتصال استفاده کنید. شیء پاسخ را برای محتوا و استفاده توکن بررسی کنید. این تأیید می‌کند که تنظیمات شما به درستی کار می‌کند.

Copycurl https://api.cheapestgptmodel.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Convert this python function to async"}]
  }'

یکپارچه‌سازی SDK Python

پکیج OpenAI Python را از طریق pip نصب کنید. کلید API و URL پایه را در پیکربندی کلاینت تنظیم کنید. پیام‌ها را به صورت لیستی از دیکشنری‌ها ارسال کنید. کلاینت serialisation و retryها را به‌طور خودکار مدیریت می‌کند. پیام دستیار را از شیء پاسخ دریافت کنید. این روش ادغام در اسکریپت‌های موجود را ساده می‌کند. با هر دو جریان کاری synchronous و asynchronous کار می‌کند. پارامترهایی مانند temperature را برای کنترل تصادفی‌سازی تنظیم کنید. streaming نیز در Python در دسترس است.

Copyfrom openai import OpenAI

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

یکپارچه‌سازی Node SDK

پکیج OpenAI Node.js را با npm یا yarn نصب کنید. کلاینت را با URL پایه و کلید خود پیکربندی کنید. متد chat.completions.create را فراخوانی کنید. نام مدل و آرایه پیام‌ها را ارائه دهید. شیء پاسخ محتوای تولید شده را شامل می‌شود. خطاها را به صورت مناسب مدیریت کنید با بررسی ویژگی خطا. این روش به راحتی با Express یا توابع serverless ادغام می‌شود. از هر دو الگوی مبتنی بر promise و async/await پشتیبانی می‌کند. آن را برای وظایف تولید با حجم بالا استفاده کنید.

Copyimport OpenAI from "openai";

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

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

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

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)

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

پنجره زمینه ۱۰۰,۰۰۰ توکن به‌طور کلی است. حداکثر خروجی ۱۶,۰۰۰ توکن در هر درخواست است. محدودیت‌های نرخ اجازه ۳۰۰ درخواست در دقیقه را می‌دهند. درخواست‌های همزمان برای هر کلید به ۸ محدود می‌شود. خطای 401 به معنای نامعتبر بودن کلید API شما است. خطای 402 نشان‌دهنده اعتبار پیش‌پرداخت ناکافی است. خطای 429 نشان می‌دهد که شما از محدودیت نرخ فراتر رفته‌اید. موجودی پیش‌پرداخت خود را افزایش دهید تا به استفاده ادامه دهید. خطاها توکن مصرف نمی‌کنند. این تضمین می‌کند که شما فقط برای تولید موفق پرداخت می‌کنید.