مستندات توسعه‌دهنده

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

کلید API شما هر درخواستی را به chat-completions نقطه پایانی. این کلید بلافاصله پس از ثبت‌نام از طریق گوگل یا ایمیل روی دریافت کلید API صفحه. نیازی به شماره تلفن نیست. کلید خود را به‌طور ایمن ذخیره کرده و آن را در Authorization هدر.

URL پایه: https://api.cheapllm.cc/v1. تمام درخواست‌ها باید این هدر را شامل شوند: Authorization: Bearer YOUR_API_KEY. خطاهایی مانند 401 نشان‌دهنده کلید نامعتبر یا فاقد کلید است. هر زمان می‌توانید کلید قدیمی خود را جایگزین کنید تا یک کلید جدید تولید کنید؛ برای هر حساب کاربری فقط یک کلید فعال وجود دارد.

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

ارسان اولین پرامپت با استفاده از استاندارد chat/completions اندپوینت. شناسه مدل uncensored. این مدل وزن‌باز بدون رد محتوای بزرگسالان قانونی، از جمله موضوعات داستانی یا جنجالی، پاسخ می‌دهد. ورودی متن، خروجی متن. اینجا ورودی برد یا تولید تصویر وجود ندارد.

در زیر یک مثال cURL پایه آورده شده است. جایگزین YOUR_API_KEY با کلید خود. بدنه درخواست پیام کاربر را تعریف می‌کند. ما پنجره زمینه ۱۰۰,۰۰۰ توکنی (پرامپت + تکمیل) را پردازش می‌کنیم. خطاها و رد شدن‌ها رایگان هستند، پس آزادانه آزمایش کنید.

• تنظیم model به uncensored.
• شامل messages آرایه.
• هدر کلید API خود را اضافه کنید.

Copycurl https://api.cheapllm.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Set timezone to UTC for all logs"}]
  }'

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

از SDK رسمی Python OpenAI برای تعامل با API ما استفاده کنید. URL پایه را به نقطه پایانی ما تنظیم کنید و کلید خود را ارائه دهید. این روش با هر کتابخانه کلاینت سازگار با OpenAI کار می‌کند. پارامترهایی مانند را پیکربندی کنید temperature و top_p به عنوان نیاز. استریم از طریق رویدادهای ارسالی سرور (SSE) پشتیبانی می‌شود. این روش برای برنامه‌های زمان واقعی ایده‌آل است که می‌خواهید توکن‌ها را همانطور که تولید می‌شوند نمایش دهید.

کتابخانه را با pip install openai. کلاینت را با URL پایه ما مقداردهی اولیه کنید. کد زیر یک درخواست تکمیل ساده را نشان می‌دهد. محتوای پیام را متناسب با مورد استفاده خود تنظیم کنید. API ما مسیریابی را به مدل صحیح به صورت داخلی انجام می‌دهد.

Copyfrom openai import OpenAI

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

برای توسعه‌دهندگان Node.js، بسته npm OpenAI به طور یکپارچه کار می‌کند. URL پایه را به نقطه پایدار API ما تنظیم کنید. این به شما امکان می‌دهد از الگوهای آشنا از سایر ارائه‌دهندگان استفاده کنید. شناسه مدل را تنظیم کنید تا uncensored. همچنین می‌توانید حالت JSON یا فراخوانی تابع را فعال کنید اگر برنامه شما به خروجی ساختاریافته نیاز دارد. SDK احراز هویت را به‌طور خودکار هنگامی که به‌درستی پیکربندی شده است مدیریت می‌کند.

پکیج را با npm install openaimax_tokens برای کنترل طول خروجی. خطاها به عنوان کدهای وضعیت HTTP استاندارد برمی‌گردند. این را برای نمونه‌سازی سریع یا یکپارچه‌سازی‌های تولید استفاده کنید.

Copyimport OpenAI from "openai";

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

پاسخ‌های استریم از طریق SSE

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

رویدادهای استریم را در کد کلاینت خود مدیریت کنید. اتصال را هنگام پایان استریم ببندید. 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 ما محدودیت‌های دقیقی برای تضمین پایداری دارد. می‌توانید ۳۰۰ درخواست در دقیقه به ازای هر کلید ارسال کنید. درخواست‌های همزمان به ۸ محدود می‌شوند. بدنه درخواست نمی‌تواند از ۸ مگابایت بیشتر باشد. پنجره زمینه ۱۰۰,۰۰۰ توکن به طور کلی است. حداکثر خروجی ۱۶,۰۰۰ توکن در هر درخواست است (۲,۰۴۸ اگر max_tokens تنظیم نشده است). خطاها کدهای خاصی را برمی‌گردانند: 401 برای کلیدهای نامعتبر، 402 برای اعتبار کافی و 429 برای محدودیت نرخ. اعتبار هرگز منقضی نمی‌شود. اشتباهاتی مانند شارژ مجدد از طریق پشتیبانی رفع می‌شوند. حریم خصوصی حفظ می‌شود؛ پرامپت‌ها برای آموزش استفاده نمی‌شوند. محتوای جنسی شامل کودکان مجاز نیست.