توثيق واجهة برمجة تطبيقات Mistral: دليل البدء السريع

ثبّت SDK واضبط عنوان URL الأساسي الخاص بك

ابدأ بتثبيت الحزمة الرسمية للغة المفضلة لديك وتوجيهها إلى نقطة النهاية الخاصة بنا. عنوان URL الأساسي هو HTTPS://api.mistralapidoc.com/v1. يوجه هذا التغيير الوحيد جميع المكالمات إلى بنية تحتية غير خاضعة للرقابة دون تغيير منطقك الحالي. يمكنك استخدام أي عميل قياسي يدعم التوافق مع OpenAI. تستغرق الإعداد ثوانٍ ولا تتطلب ملفات تكوين معقدة.

تأكد من تمرير مفتاح API الفريد الخاص بك في رأس Authorization. يتحقق نظامنا من صحة هذا المفتاح مقابل رصيدك المدفوع مسبقاً قبل معالجة أي رموز. يضمن هذا النهج أن تدفع فقط مقابل ما تستخدمه. احتفظ بمفتاحك آمناً وقم بتدويره إذا اشتبهت في تعرضه. يُصدر المفتاح فوراً عند التسجيل عبر Google أو البريد الإلكتروني.

أجرِ أول طلب للنموذج غير الخاضع للرقابة

أرسل طلب POST إلى /v1/chat/completions مع ضبط معرف النموذج على "uncensored". يستجيب هذا النموذج للمحتوى البالغ القانوني، والخيال، والمواضيع المثيرة للجدل دون الرفض القياسي. إنه نموذج مفتوح الوزن مُعدّ للإجابات المباشرة. لا تحتاج إلى تحديد رقم إصدار أو التوجيه بين موردين مختلفين. تُرجع الاستجابة النص في حقل content.

Copycurl https://api.mistralapidoc.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List all available models and their context windows"}]
  }'

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

فعّل البث والتعامل مع استخدام الرمز

عيّن stream إلى true لتلقي الرموز عبر أحداث Server-Sent Events. تقلل هذه الطريقة من التأخير المدرك للردود الطويلة. تحتوي الشريحة الأخيرة في التدفق على إحصائيات استخدام الرموز الكاملة لذلك الطلب. يمكنك تسجيل هذه المقاييس لمتابعة استهلاك رصيدك المدفوع مسبقًا بدقة. التدفق مثالي لواجهات الدردشة والتطبيقات في الوقت الفعلي.

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

مرر مصفوفة أدوات لتمكين استدعاء الدوال. سيقوم النموذج بإخراج استدعاءات أدوات مهيكلة عند الاقتضاء. يمكنك أيضًا فرض وضع JSON عن طريق تعيين response_format إلى json_object. يضمن هذا أن يكون الإخراج JSON صالحًا، مما يبسط التحليل في تطبيقك. تعمل كلتا الميزتين مع تراكيب SDK OpenAI القياسية.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.mistralapidoc.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 مفيد عندما تحتاج إلى هياكل بيانات صارمة. اجمع بين هذه الميزات لسير عمل آلي قوي.

تكوين المعاملات: درجة الحرارة، top_p، والبذرة

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

Copyfrom openai import OpenAI

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

عيّن presence_penalty و frequency_penalty لتقليل التكرار. يدعم النموذج جميع معلمات OpenAI القياسية. يمكنك تمرير تسلسل توقف لإيقاف التوليد عند علامات محددة. تساعدك هذه الضوابط على الحصول على تنسيق الإخراج الدقيق الذي تحتاجه. جرب مجموعات مختلفة من المعلمات للعثور على الإعدادات المثالية لحالة الاستخدام الخاصة بك.

حدود، أخطاء، ونافذة السياق

تدعم واجهة البرمجة لدينا نافذة سياق بحجم 100,000 رمز. الحد الأقصى للإخراج لكل طلب هو 16,000 رمز، أو 2,048 إذاomitت تحديد max_tokens. أنت مقيد بـ 300 طلب في الدقيقة و8 طلبات متزامنة لكل مفتاح. يجب أن يبقى حجم جسم الطلب أقل من 8 ميجابايت. تضمن هذه الحدود الاستخدام العادل لجميع العملاء المدفوعين مسبقاً.

التعامل مع أخطاء HTTP 401 عن طريق التحقق من مفتاح API الخاص بك. يشير خطأ 402 إلى عدم كفاية الرصيد المدفوع مسبقاً. قم بالشحن بالعملات المشفرة لاستئناف الخدمة. يعني خطأ 429 أنك تجاوزت حد معدل الطلب. انتظر قليلاً قبل إعادة المحاولة. لا يستخدم نظامنا الطلبات للتدريب، مما يحافظ على خصوصية بياناتك. الأخطاء والرفضات مجانية، لذا تدفع فقط مقابل الإكمالات الناجحة.