شروع سریع API

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

ابتدا کلاینت خود را به URL پایه ما اشاره دهید و کلید خود را در هدر ارسال کنید. ما از طرح استاندارد Authorization استفاده می‌کنیم، بنابراین هر SDK یا کلاینت سازگار با OpenAI بلافاصله کار می‌کند. نیازی به مدیریت جریان‌های پیچیده OAuth یا انتظار برای تأیید ندارید. فقط با گوگل یا ایمیل ثبت‌نام کنید، کلید را کپی کنید و آماده باشید. نقطه پایانی https://api.aiohnezensur.com/v1 و Authorization: Bearer YOUR_API_KEY هدر در هر درخواست.

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

یک درخواست تکمیل چت ساده برای آزمایش مدل uncensored ارسال کنید. این درخواست یک پرامپت ارسال کرده و یک پاسخ متنی بدون محافظ‌های معمول شرکتی دریافت می‌کند. می‌توانید از هر ابزاری که از پروتکل OpenAI پشتیبانی می‌کند استفاده کنید، اما یک تماس مستقیم curl دقیقاً نشان می‌دهد که در پشت صحنه چه اتفاقی می‌افتد. جایگزین YOUR_API_KEY با کلید واقعی خود از داشبورد.

Copycurl https://api.aiohnezensur.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list 5 free open source image generators"}]
  }'

پاسخ شامل متن تولید شده و آمار مصرف توکن است. اگر پاسخی دریافت کنید، یکپارچه‌سازی شما به درستی کار می‌کند. اکنون می‌توانید به ساخت تعاملات پیچیده‌تر بپردازید یا به کلاینت‌های برنامه‌نویسی شده تغییر دهید.

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

از بسته رسمی پایتون OpenAI برای تعامل بی‌درنگ با API ما استفاده کنید. URL پایه را به نقطه پایانی ما تنظیم کنید و کلید خود را به عنوان توکن API ارائه دهید. این به شما اجازه می‌دهد از کدهای موجود بدون بازنویسی منطق HTTP بهره‌مند شوید. شناسه مدل uncensored, که مدل بزرگ زبانی خاص ما را که برای خروجی نامحدود بهینه‌سازی شده است، فعال می‌کند.

Copyfrom openai import OpenAI

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

این قطعه کد یک تبادل پیام پایه را نشان می‌دهد. می‌توانید آرایه messages را برای شامل کردن پرامپت‌های سیستمی یا تاریخچه مکالمه تنظیم کنید. SDK تجزیه و خطاها را برای شما انجام می‌دهد.

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

API را به برنامه‌های JavaScript یا TypeScript خود با استفاده از SDK Node ادغام کنید. URL پایه و کلید API را دقیقاً مانند مثال Python پیکربندی کنید. این رویکرد برای رندرینگ سمت سرور یا میکروسرویس‌های بک‌اند خوب کار می‌کند. SDK لایه شبکه را انتزاع می‌کند، بنابراین می‌توانید بر منطق پرامپت تمرکز کنید.

Copyimport OpenAI from "openai";

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

این کد را اجرا کنید تا ببینید مدل به ورودی شما پاسخ می‌دهد. می‌توانید با تغییر محتوای پرامپت به سرعت تکرار کنید. ساختار پاسخ با فرمت استاندارد OpenAI مطابقت دارد، که سازگاری با سایر ابزارهای استک شما را تضمین می‌کند.

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

پخش زنده را فعال کنید تا توکن‌ها به محض تولید دریافت شوند و تأخیر ادراک‌شده کاهش یابد. این ویژگی برای رابط‌های کاربری که متن را به صورت بلادرنگ نمایش می‌دهند، حیاتی است. مقدار stream پارامتر روی true در درخواست شما. API یک سری رویدادهای ارسالی سرور (SSE) به جای یک شیء JSON واحد ارسال می‌کند. هر قطعه حاوی یک تغییر جزئی از پاسخ است.

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)

این تغییرات را در سمت کلاینت به هم بچسبانید تا پیام کامل بازسازی شود. این روش برای کاربر آنی به نظر می‌رسد، حتی برای خروجی‌های طولانی. قطعه نهایی شامل کل استفاده از توکن است، که به شما امکان می‌دهد دقیقاً صورت‌حساب صادر کنید.

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

محدودیت‌های فنی را درک کنید تا از شکست درخواست‌ها در محیط تولید جلوگیری کنید. شما مجاز به 300 درخواست در دقیقه به ازای هر کلید هستید و می‌توانید 8 درخواست همزمان داشته باشید. بدنه درخواست نباید از 8 مگابایت تجاوز کند. اگر از این محدودیت‌ها تجاوز کنید، API کد وضعیت 429 را برمی‌گرداند. باید در کلاینت خود بازگشت نمایی (exponential backoff) را پیاده‌سازی کنید تا این نوسانات را به آرامی مدیریت کنید. پنجره متن 100,000 توکن در مجموع است، با حداکثر خروجی 16,000 توکن در هر درخواست. خطاها و رددها اعتبار مصرف نمی‌کنند، بنابراین می‌توانید با اطمینان تلاش مجدد کنید. خطاهای احراز هویت 401 و کمبود موجودی 402 را برمی‌گردانند.