مستندات توسعه‌دهنده برای API gapgpt

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

API gapgpt از ساختار endpoint سازگار با OpenAI استاندارد استفاده می‌کند. کلاینت خود را به https://api.gapgptapi.com/v1 و کلید API خود را در Authorization header. سیستم برای هر درخواست یک کلید معتبر نیاز دارد. این کلید را بلافاصله از طریق داشبورد با استفاده از اعتبارنامه‌های گوگل یا ایمیل تولید می‌کنید.

شروع سریع: اولین درخواست با cURL

ارسان اولین پرامپت به مدل uncensored با هر کلاینت HTTP. این مثال یک پاسخ JSON را درخواست می‌کند تا خروجی ساختاریافته برای منطق برنامه شما تضمین شود.

Copycurl https://api.gapgptapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list the top five python libraries for async web scraping"}]
  }'

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

ادغام با پایتون

از رسمی openai پکیج پایتون برای تعامل با API. باید URL پایه را برای اشاره به سرورهای ما تغییر دهید. این به شما اجازه می‌دهد تا از روش‌های آشنا SDK بدون تغییر ساختار کد به طور قابل توجهی استفاده کنید.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.gapgptapi.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. SDK فرآیند جریان‌یافتگی (streaming) و تجزیه را به‌طور خودکار مدیریت می‌کند. اطمینان حاصل کنید که آخرین نسخه بسته نصب شده است.

ادغام با Node.js

کلاینت را با URL پایه صحیح مقداردهی دهید. این تضمین می‌کند که برنامه Node.js شما درخواست‌ها را به مدل uncensored ما به جای OpenAI هدایت می‌کند. بقیه کد الگوهای استاندارد OpenAI را تقلید می‌کند.

Copyimport OpenAI from "openai";

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

Pass the uncensored شناسه مدل. این روش با هر دو پیکربندی CommonJS و ES module کار می‌کند. می‌توانید بلافاصله شروع به ارسال prompt کنید.

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

استریمینگ را با تنظیم stream: true در درخواست شما. 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)

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

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

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

پنجره زمینه (context window) از مجموعاً ۱۰۰,۰۰۰ توکن پشتیبانی می‌کند. می‌توانید تا ۱۶,۰۰۰ توکن خروجی درخواست دهید. اگر مشخص نکنید max_tokens, پیش‌فرض ۲,۰۴۸ توکن است. برای محدودیت‌های نرخ، از بازگشت نمایی (exponential backoff) استفاده کنید. اعتبار شما هرگز منقضی نمی‌شود، بنابراین می‌توانید بعداً دوباره تلاش کنید.