مستندات API Queen

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

احراز هویت از یک توکن Bearer استاندارد که در Authorization header. این رویکرد سازگاری با SDKهای موجود OpenAI را بدون نیاز به منطق سفارشی تضمین می‌کند. کلاینت API_KEY بلافاصله پس از ثبت‌نام از طریق Google یا ایمیل تولید می‌شود. تمام درخواست‌ها باید به URL پایه خاصی که برای سرویس ارائه شده است اشاره کنند.

• URL پایه: https://api.apiqueen.cc/v1
• هدر: Authorization: Bearer API_KEY

Copycurl https://api.apiqueen.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Return current status for service api queen"}]
  }'

ارسال درخواست‌ها به /v1/chat/completions

ارسال داده‌های متنی به نقطه پایانی برای دریافت پاسخ‌های مستقیم مدل. شناسه مدل همیشه uncensored, که موضوعات متنوع را بدون ردپذیری‌های استاندارد مدیریت می‌کند. می‌توانید پارامترهایی مانند temperature و top_p برای کنترل خ creativite. سیستم یک لیست از پیام‌ها را در قالب چت استاندارد انتظار دارد.

Copyfrom openai import OpenAI

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

Copyimport OpenAI from "openai";

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

پارامترهای مدل: دما، Top-P و Stop

تولید پاسخ را با پارامترهای استاندارد LLM کنترل کنید. تنظیم temperature بین 0 و 2 برای تنوع در تصادفی بودن. از top_p برای فیلتر کردن کلمات با احتمال کم. تعریف stop sequences برای توقف خروجی در محرک‌های خاص. این تنظیمات اجازه می‌دهند تنظیم دقیق برای وظایف نوشتن خلاقانه یا بازیابی حقایق.

API پارامترهای پشتیبانی‌نشده را به‌طور شایسته نادیده می‌گیرد. بر روی temperature, top_p، و stop برای نتایج دقیق. این مقادیر را بر اساس تحمل نویز برنامه خود تنظیم کنید.

پاسخ‌های استریم و مصرف توکن

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

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

از فراخوانی تابع برای استخراج داده‌های ساختاریافته استفاده کنید. ابزارها را در tools پارامتر. مدل JSON معتبر را زمانی بازگردانی می‌کند که response_format تنظیم شده بر {"type": "json_object"}. این اطمینان حاصل می‌کند که تجزیه‌ی یکسانی در برنامه‌های downstream وجود دارد.

تنظیم tool_choice برای اجبار به فراخوانی‌های تابع خاص. این برای جریان‌های کاری خودکار که فرمت‌های خروجی سخت‌گیرانه نیاز دارند مفید است.

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

کدهای وضعیت HTTP را برای مشکلات رایج مانیتور کنید. خطای 401 به این معنی است که کلید API شما نامعتبر است. خطای 402 نشان‌دهنده اعتبار پیش‌پرداخت ناکافی است. خطاها موجودی توکن شما را مصرف نمی‌کنند. محدودیت‌های نرخ 300 درخواست در دقیقه به ازای هر کلید را اعمال می‌کنند. درخواست‌های همزمان به 8 محدود شده‌اند. پنجره زمینه از 100,000 توکن در کل پشتیبانی می‌کند.

خطاها را با تأخیر نمایی (exponential backoff) مدیریت کنید. بررسی کنید error object در پاسخ‌های JSON برای جزئیات.