مستندات API

احراز هویت

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

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

JSON را به POST /v1/chat/completions برای دریافت پاسخ‌های متنی. این تنها اندپوینت برای تولید متن است. از امبدینگ‌ها، تصاویر یا صوت پشتیبانی نمی‌کند.

تنظیم model field to "uncensored"مدل بدون ردیابی‌های محتوایی برای استفاده بزرگسالان قانونی پاسخ می‌دهد. این یک مدل وزن‌باز است که برای خروجی نامحدود تنظیم شده است. این مدل GPT، Claude یا هر مدل دیگری از سایر فروشندگان نیست.

نقطه پایانی مدل‌ها

فراخوانی GET /v1/models برای لیست کردن مدل‌های موجود. پاسخ شامل uncensored شناسه مدل. از این برای بررسی اتصال یا اشکال‌زدایی از مشکلات پیکربندی در کلاینت خود استفاده کنید.

اندپوینت متادیتای استاندارد OpenAI را برمی‌گرداند. این به شما کمک می‌کند تأیید کنید که URL پایه و احراز هویت شما به‌درستی کار می‌کنند، پیش از ارسال بارهای سنگین.

پارامترها & گزینه‌ها

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

پنجره زمینه ۱۰۰,۰۰۰ توکن برای ورودی و خروجی ترکیبی است. درخواست‌هایی که بیش از ۸ مگابایت حجم بدنه دارند ممکن است شکست بخورند. فراخوانی تابع و حالت JSON نیز از طریق فیلدهای استاندارد پشتیبانی می‌شوند.

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

استریمینگ را با تنظیم stream: true. رویدادهای سر-ارسال (SSE) را دریافت می‌کنید در حالی که توکن‌ها تولید می‌شوند. این برای برنامه‌های تعاملی، تأخیر ادراک‌شده را کاهش می‌دهد.

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

Function Calling & JSON Mode

استفاده response_format با {"type": "json_object"} برای خروجی JSON دقیق. این برای تجزیه داده‌های ساختاریافته از LLM مفید است. فراخوانی تابع با تعاریف استاندارد ابزار کار می‌کند.

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

cURL

Copycurl https://api.mistralaiapikey.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "what is the api limit for this service"}]
  }'

پایتون

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

جریان‌سازی

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)