MiniMax api: راهنمای شروع سریع و SDK

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

از کلید API ارائه‌شده استفاده کنید و کلاینت خود را به URL پایه اختصاصی هدایت کنید. نقطه پایانی برای تولید پاسخ‌ها https://api.minimaxaiapi.com/v1/chat/completions. کلید را در Authorization هدر به از یک توکن bearer. این با هر SDK استاندارد OpenAI کار می‌کند زیرا ما از همان پروتکل پیروی می‌کنیم.

• نام هدر: Authorization
• مقدار هدر: Bearer YOUR_API_KEY
• URL پایه: https://api.minimaxaiapi.com/v1

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

Copycurl https://api.minimaxaiapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "return json with keys name and age"}]
  }'

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

یک درخواست POST به نقطه پایانی تکمیل چت ارسال کنید تا پاسخ متنی دریافت کنید. شناسه مدل uncensored. باید یک آرایه پیام‌ها (messages) شامل تاریخچه مکالمه خود ارائه دهید. سیستم ورودی را پردازش می‌کند و متن تولید شده را بر اساس پرامپت شما برمی‌گرداند.

این اندپوینت، تمام نیازهای تولید متن شما را مدیریت می‌کند. از embeddings، صدا یا ویدیو پشتیبانی نمی‌کند. می‌توانید پاسخ‌ها را streaming کنید یا منتظر بلوک کامل بمانید. مدل تا 100,000 توکن در مجموع را مدیریت می‌کند.

Copyfrom openai import OpenAI

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

استریمینگ و استفاده از توکن

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

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

Copyimport OpenAI from "openai";

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

فراخوانی تابع و حالت JSON

از tools پارامتری برای فعال‌سازی فراخوانی تابع. توابع خود را در بدنه درخواست تعریف کنید و اجازه دهید مدل انتخاب کند کدام را فراخوانی کند. The tool_choice پارامتر به شما اجازه می‌دهد یک تابع خاص را مجبور کنید یا به‌طور خودکار انتخاب کنید. برای خروجی JSON دقیق، مقدار response_format به {"type": "json_object"}. این امر تضمین می‌کند که پاسخ JSON معتبر است.

فراخوانی تابع برای استخراج داده‌های ساختاریافته یا فعال‌سازی اقدامات مفید است. حالت JSON برای یکپارچه‌سازی‌های 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)

پارامترها و محدودیت‌های مدل

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

استفاده seed برای نتایج تکرارپذیر. مقدار presence_penalty و frequency_penalty برای کنترل تکرار. این پارامترها کنترل دقیقی بر خلاقیت و ثبات مدل به شما می‌دهند. همیشه با مورد استفاده خاص خود تست کنید تا تعادل مناسب را پیدا کنید.

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

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

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