راهنمای شروع سریع دروازه OpenAI

نصب SDK استاندارد OpenAI

ابتدا کتابخانه کلاینت رسمی را به محیط پروژه خود اضافه کنید. این کار سازگاری با نقاط پایانی استانداردی که ارائه می‌دهیم را تضمین می‌کند. SDK سریال‌سازی و هدرهای احراز هویت را به‌طور خودکار مدیریت کرده و کدهای تکراری را در پیاده‌سازی شما کاهش می‌دهد.

• پایتون: pip install openai
• Node.js: npm install openai

بررسی کنید که نصب بدون تعارض وابستگی‌ها کامل می‌شود. دروازه ما به بسته‌های JSON استاندارد نیاز دارد، بنابراین هر نسخه از SDK که از /v1/chat/completions اندپوینت به درستی کار خواهد کرد.

base_url و کلید API خود را پیکربندی کنید

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

درخواست‌های شما اکنون هدف https://api.gatewayopenai.com/v1 به جای ارائه‌دهنده استاندارد. این تغییر تضمین می‌کند که به مدل uncreserved اختصاصی دسترسی دارید بدون اینکه منطق اصلی خود را تغییر دهید.

Copyfrom openai import OpenAI

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

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

اولین درخواست تکمیل چت

یک تماس ساده متن-ورودی، متن-خروجی را اجرا کنید تا اتصال و کیفیت پاسخ را بررسی کنید. از شناسه مدل uncensored برای اطمینان از اتصال به سرور صحیح. این تست تأیید می‌کند که کلید API شما اعتبار کافی دارد و مسیر شبکه شما پاک است.

یک شی پیام استاندارد ارسال کنید. پاسخ شامل متن تولید شده بدون رد محتوای معمول خواهد بود. بررسی کنید choices آرایه برای محتوای تولید شده.

Copycurl https://api.gatewayopenai.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List 5 Linux commands for disk usage"}]
  }'

زمان پاسخ و مصرف توکن را مرور کنید. این درخواست پایه اعتماد به اتصال را قبل از مقیاس‌دهی به پرامپت‌های پیچیده‌تر ایجاد می‌کند.

استریمینگ را فعال کنید و داده‌های مصرف را تجزیه کنید

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

تکه‌های استریم را تجزیه کنید تا آمار نهایی مصرف توکن استخراج شود. آخرین تکه شامل شمارش کامل توکن‌ها برای ورودی و خروجی است. این داده‌ها برای تأیید دقیق صورت‌حساب حیاتی هستند، زیرا ما بر اساس توکن هزینه دریافت می‌کنیم.

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)

پاسخ‌های ناقص را به‌صورت ایمن مدیریت کنید. مطمئن شوید که کلاینت شما اتصال را پس از دریافت آخرین قطعه به‌خوبی می‌بندد تا از نشت منابع جلوگیری شود.

از ابزارها، حالت JSON و پارامترها استفاده کنید

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

پارامترهایی مانند temperature و top_p برای کنترل خ creativite. تنظیم max_tokens برای محدود کردن طول خروجی؛ پیش‌فرض 2,048 است، اما می‌توانید تا 16,000 را مشخص کنید. پنجره زمینه 100,000 توکن را به طور کلی پشتیبانی می‌کند.

Copyimport OpenAI from "openai";

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

تعریف‌های ابزار را با مثال‌های ساده آزمایش کنید. بررسی کنید که مدل به طرحواره ارائه‌شده در درخواست شما پایبند است. این امر قابلیت اطمینان را در جریان‌های کاری خودکار تضمین می‌کند.

Limits, errors, and context window

محدودیت‌های نرخ و کدهای خطا را پایش کنید تا یکپارچه‌سازی پایدار حفظ شود. دروازه 300 درخواست در دقیقه به ازای هر کلید را اعمال می‌کند و 8 درخواست همزمان را مجاز می‌داند. تجاوز از این محدودیت‌ها منجر به خطای 429 می‌شود.

خطاهای احراز هویت (401) و اعتبار ناکافی (402) را به‌سرعت مدیریت کنید. 401 نشان‌دهنده کلید API نامعتبر یا منقضی‌شده است. 402 به این معنی است که اعتبار پیش‌پرداخت شما تمام شده است؛ برای ادامه سرویس از طریق ارز دیجیتال شارژ کنید. محدودیت حجم بدنه درخواست 8 مگابایت است.

پنجره زمینه شما ۱۰۰,۰۰۰ توکن شامل هم پرامپت و هم تکمیل پوشش می‌دهد. بودجه توکن خود را مطابق برنامه‌ریزی کنید تا از برش جلوگیری کنید. خطاها اعتبار مصرف نمی‌کنند و از موجودی شما در طول تلاش مجدد محافظت می‌کنند.