توثيق واجهة برمجة التطبيقات

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات الخاص بك في Authorization قيمة التوكن كـ Bearer token. تحصل على هذا المفتاح فوراً بعد التسجيل باستخدام Google أو البريد الإلكتروني في احصل على مفتاح API صفحة. إذا ولّيت مفتاحاً جديداً، فإنه يستبدل المفتاح القديم على الفور. تُرجع الأخطاء مثل المفاتيح غير الصالحة رمز 401 الحالة. يتم إصلاح الأخطاء مثل الشحن المزدوج من خلال صفحة الدعم.

نقطة نهاية إكمال الدردشة

أرسل JSON إلى POST /v1/chat/completions للحصول على استجابات نصية. هذا هو الطرف النهائي الوحيد لتوليد النص. لا يدعم التضميمات أو الصور أو الصوت.

اضبط model field إلى "uncensored". يجيب النموذج دون رفضات محتوى للاستخدام القانوني للبالغين. إنه نموذج مفتوح الوزن مضبوط للإخراج غير المقيد. إنه ليس GPT أو Claude أو أي نموذج من مزود آخر.

Models Endpoint

استدعاء GET /v1/models لعرض النماذج المتاحة. تتضمن الاستجابة الـ uncensored معرف النموذج. استخدم هذا للتحقق من الاتصال أو تصحيح مشاكل التكوين في العميل الخاص بك.

تعيد نقطة النهاية تنسيق بيانات OpenAI القياسي. يساعدك هذا على تأكيد أن عنوان URL الأساسي والمصادقة يعملان بشكل صحيح قبل إرسال حمولات ثقيلة.

المعاملات & الخيارات

يدعم المعايير القياسية مثل temperature, top_p, stop, seed, presence_penalty، و frequency_penalty. تعيين max_tokens للتحكم في طول المخرجات. تكون القيمة الافتراضية هي 2,048 رمزاً إذا حذفت هذا الحقل.

نافذة السياق هي 100,000 رمز للنص البرمجي والإكمال معاً. قد تفشل الطلبات التي تتجاوز حجم جسم 8 ميجابايت. استدعاء الوظائف ووضع JSON مدعومان أيضاً عبر الحقول القياسية.

استجابات البث

فعّل البث عن طريق تعيين stream: true. تتلقى أحداث Server-Sent (SSE) بينما يتم توليد الرموز. هذا يقلل من زمن الانتظار المُدرَك للتطبيقات التفاعلية.

تظهر إحصائيات استهلاك الرمز في الشريحة الأخيرة من التدفق. يتيح لك ذلك تتبع التكاليف بدقة في الوقت الفعلي. لا تزال الأخطاء أثناء التدفق تعيد رموز حالة HTTP المناسبة.

استدعاء الوظائف ووضع JSON

استخدام response_format مع {"type": "json_object"} لإخراج JSON صارم. هذا مفيد لتحليل البيانات الهيكلية من نموذج اللغة. يعمل استدعاء الوظائف مع تعريفات الأدوات القياسية.

تعيين 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"}]
  }'

Python

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)