مستندات API: نقاط پایانی OpenAI-Compatible

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

API را با تنظیم کلید منحصر‌به‌فرد خود و URL پایه در متغیرهای محیطی خود دسترسی پیدا کنید. نقطه پایانی در https://api.apikeykimi.com/v1. باید هدر Authorization: Bearer YOUR_API_KEY در هر درخواست. این کلید بلافاصله پس از ثبت‌نام از طریق گوگل یا ایمیل ایجاد می‌شود. این تنها اعتبار مورد نیاز برای احراز هویت است. نیازی به پیکربندی اسکوپ‌ها یا مجوزها نیست.

Copycurl https://api.apikeykimi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "convert this json object to python dictionary syntax"}]
  }'

نقطه پایانی تکمیل چت

پیام‌ها را به مدل با استفاده از استاندارد /v1/chat/completions نقطه پایانی. شناسه مدل را به عنوان uncensored در بدنه درخواست. API متن تولید شده را بر اساس تاریخچه پرامپت شما برمی‌گرداند. می‌توانید پارامترهایی مانند دما و top_p را برای کنترل خلاقیت تنظیم کنید. مدل از فراخوانی تابع و حالت JSON برای خروجی‌های ساختاریافته پشتیبانی می‌کند.

Copyfrom openai import OpenAI

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

پاسخ‌های استریم (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)

Function Calling & JSON Mode

ابزارها را تعریف کنید یا خروجی JSON را با استفاده از response_format پارامتر. تنظیم json_object برای اطمینان از دریافت پاسخ‌های JSON معتبر. همچنین می‌توانید تعریف ابزارها را برای فراخوانی تابع ارسال کنید. مدل این محدودیت‌ها را به‌شدت رعایت می‌کند. این امر یکپارچه‌سازی قابل اعتماد با سرویس‌های خارجی را امکان‌پذیر می‌سازد. از tool_choice برای کنترل اینکه چگونه ابزارها فراخوانی می‌شوند.

محدودیت‌ها و محدودیت‌های توکن

پنجره زمینه تا ۱۰۰,۰۰۰ توکن برای مجموع ورودی و خروجی پشتیبانی می‌کند. حداکثر خروجی در هر درخواست ۱۶,۰۰۰ توکن است. اگر تنظیم نکنید max_tokens, محدودیت به طور پیش‌فرض ۲,۰۴۸ توکن است. درخواست‌ها در اندازه بدنه به ۸ مگابایت محدود هستند. شما به ۳۰۰ درخواست در دقیقه محدود هستید. فقط ۸ درخواست می‌توانند همزمان به ازای هر کلید اجرا شوند.

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

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

Node.js

Copyimport OpenAI from "openai";

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