شروع سریع API

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

API از احراز هویت سازگار با OpenAI استفاده می‌کند. شما بلافاصله پس از ثبت‌نام با گوگل یا ایمیل، یک کلید API دریافت می‌کنید. از این کلید در Authorization هدر برای تمام درخواست‌ها. URL پایه روی https://api.mistralabliterated.com/v1. برای مسیر انتهای نقطه نیازی به پیکربندی اضافی نیست.

Copycurl https://api.mistralabliterated.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the first five prime numbers"}]
  }'

کلید شما حساب کاربری شما را شناسایی کرده و استفاده را ردیابی می‌کند. اگر کلید خود را گم کردید، یکی جدید تولید کنید؛ کلید قبلی نامعتبر می‌شود.

POST /v1/chat/completions

پیام‌ها را به مدل با استفاده از نقطه پایانی تکمیل چت استاندارد ارسال کنید. شناسه مدل همیشه uncensored. این انتهای‌بند، تعاملات متن-ورودی و متن-خروجی را بدون نیاز به ساختارهای پیچیده payload مدیریت می‌کند. می‌توانید پیام‌های system، user و assistant را در یک درخواست ارسال کنید.

Copyfrom openai import OpenAI

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

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

GET /v1/models

مدل‌های موجود را جستجو کنید تا اتصال و پیکربندی را تأیید نمایید. این endpoint لیستی از مدل‌های موجود را برمی‌گرداند که تأیید می‌کند احراز هویت و URL پایه شما صحیح است. این موضوع برای تست یکپارچه‌سازی شما پیش از ارسال پیکربندی‌های سنگین مفید است.

Copyimport OpenAI from "openai";

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

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

جریان‌سازی و ابزارها

استریمینگ را با تنظیم 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 را برای خروجی‌های ساختاریافته زمانی که تنظیم می‌کنید پشتیبانی می‌کند response_format به {"type": "json_object"}. انتخاب ابزارها انعطاف‌پذیر است، اجازه انتخاب خاص یا خودکار را می‌دهد.

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

پنجره زمینه (context window) از ۱۰۰,۰۰۰ توکن برای ورودی (prompt) و خروجی (completion) ترکیبی پشتیبانی می‌کند. حداکثر خروجی در هر درخواست ۱۶,۰۰۰ توکن است، یا ۲,۰۴۸ اگر مشخص نکنید max_tokens. می‌توانید تولید را با temperature, top_p, stop، و seed پارامترها. جریمه‌های تکرار و حضور نیز برای تنظیم دقیق در دسترس هستند.

محدودیت‌های نرخ اجازه ۳۰۰ درخواست در دقیقه به ازای هر کلید و ۸ درخواست همزمان را می‌دهند. حداکثر اندازه بدنه درخواست ۸ مگابایت است. این محدودیت‌ها عملکرد پایدار را برای برنامه‌های با تراکم بالای درخواست تضمین می‌کنند. استراتژی دسته‌بندی خود را تنظیم کنید تا در این حدود بمانید.

خطاها و قیمت‌گذاری

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

قیمت‌گذاری ۰.۱۵ دلار به ازای هر میلیون توکن ورودی و ۰.۵۰ دلار به ازای هر میلیون توکن خروجی است. اعتبار منقضی نمی‌شود و هزینه ماهانه‌ای وجود ندارد. شارژ حساب از ۲۰ دلار شروع می‌شود و برای مبالغ بزرگ‌تر پاداش دارد. بازپرداخت امکان‌پذیر نیست، اما پشتیبانی می‌تواند هزینه‌های دوبرابر شده را اصلاح کند.