توثيق API لإكمال المحادثات غير الخاضعة للرقابة

البدء السريع: التوصيل بـ Python أو JavaScript

توصيل إلى API عن طريق تحديث عنوان URL الأساسي الخاص بك وضبط مفتاح API الخاص بك. تقبل نقطة النهاية طلبات إكمال الدردشة القياسية وتعيد النص. لا تحتاج إلى تثبيت مكتبات مخصصة إذا كنت تستخدم مكتبات OpenAI SDK الرسمية، لأن الواجهة تط她们的 مواصفات بالضبط.

ابدأ بطلب HTTP بسيط للتحقق من الاتصال. استخدم أمر curl أدناه لإرسال موجه أساسي إلى uncensored النموذج. استبدل YOUR_API_KEY باستخدام المفتاح الذي تم إنشاؤه على لوحة التحكم الخاصة بك.

Copycurl https://api.aiplayrolebest.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Set the character persona to a grumpy detective"}]
  }'

بالنسبة لمطوري Python، العملية متطابقة تقريباً. قم بتهيئة العميل بمفتاحك وعنوان URL الأساسي الصحيح. هذا يضمن توجيه جميع الطلبات عبر خوادمنا غير المقيدة مع الحفاظ على التوافق مع الأدوات الحالية.

Copyfrom openai import OpenAI

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

يمكن لمستخدمي JavaScript تحقيق نفس النتيجة باستخدام Node SDK. اضبط baseURL الخاصية إلى نقطة النهاية الخاصة بنا. يسمح هذا النهج لك بتكامل واجهة برمجة التطبيقات (API) في خوادم الويب أو الخدمات الخلفية بأقل تغييرات في الكود.

Copyimport OpenAI from "openai";

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

المصادقة تعتمد على مفتاح API واحد يمرر في الرأس. مرر هذا المفتاح في Authorization الرأس لكل طلب. إذا كان المفتاح مفقوداً أو غير صالح، ترجع واجهة برمجة التطبيقات خطأ 401 فوراً. يضمن هذا الوصول الآمن إلى رصيدك المدفوع مسبقاً.

أنشئ مفتاحك على لوحة التحكم. يظهر المفتاح مرة واحدة عند الإنشاء. احفظه بأمان في متغيرات البيئة الخاصة بك. لا تشاركه علناً. يدعم كل حساب مفتاحاً نشطاً واحداً في الوقت نفسه. يؤدي إنشاء مفتاح جديد إلى إبطال المفتاح السابق فوراً.

استخدم المفتاح في طلباتك هكذا: Authorization: Bearer YOUR_API_KEY. يعمل تنسيق الرأس القياسي مع جميع المكتبات الرئيسية. احتفظ بمفتاحك قريبًا للتكرار السريع أثناء التطوير.

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

أرسل الطلبات إلى /v1/chat/completions النقطة النهائية. قم بتضمين مصفوفة الرسائل الخاصة بك واضبط النموذج على uncensored. يمكنك ضبط معاملات مثل temperature و top_p للتحكم في الإبداع. تنتج القيم الأعلى استجابات أكثر تنوعاً.

تعيين max_tokens لتحديد طول المخرجات. الافتراضي هو 2,048 رمزاً إذا لم يُحدد. يدعم النموذج نافذة سياق بحجم 100,000 رمز للسياق بالإضافة إلى المخرجات. يتيح ذلك محادثات طويلة دون اقتطاع. اضبط presence_penalty و frequency_penalty لتقليل التكرار في سيناريوهات لعب الأدوار.

استخدم ال stop معامل لإيقاف التوليد عند عبارات محددة. يساعد ذلك في فرض هيكل الحوار. ال seed يضمن مخرجات قابلة للتكرار للاختبار. تمنحك هذه الأدوات تحكماً دقيقاً في سلوك النموذج.

الاستجابات التدفقية وبيانات الاستخدام

فعّل البث عن طريق تعيين stream: true في طلبك. تُعيد الـ API شرائح من النص بمجرد توليدها. يقلل هذا من زمن الاستجابة المُدرَك للمستخدمين النهائيين. تتضمن كل شريحة نصًا جزئيًا وبيانات تعريفية.

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

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

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)

معالجة الأخطاء وحدود المعدل

تفرض الـ API حدًا قدره 300 طلب في الدقيقة لكل مفتاح. يتم تحديد الطلبات المتزامنة بثمانية لكل مفتاح. يجب ألا يتجاوز جسم الطلب 8 ميجابايت. يؤدي تجاوز هذه الحدود إلى إرجاع خطأ 429. نفذ التراجع الأسي للتعامل مع الارتفاعات العابرة.

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

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

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

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

يتيح استدعاء الوظائف للنموذج استدعاء الأدوات. عرّف الأدوات في جسم الطلب. يعيد النموذج استدعاءات الأدوات عند الاقتضاء. تعامل مع هذه الاستدعاءات في منطق تطبيقك. يتيح ذلك سير عمل متعدد الخطوات معقدًا.

ادمج وضع JSON مع استدعاء الوظائف لدمجات قوية. تحقق من مخرجات JSON على جانب العميل. استخدم tool_choice معامل للتحكم في استدعاء الوظائف. تدعم هذه المرونة معماريات التطبيقات المتنوعة. تأكد من تعريف أدواتك بشكل جيد للحصول على أداء أمثل.

تفاصيل النموذج وحدود نافذة السياق

The uncensored تدعم نافذة سياق بحجم 100,000 رمز. يشمل ذلك كل من مطالقة الإدخال وإكمال المخرجات. الحد الأقصى للمخرجات هو 16,000 رمز لكل طلب. يتيح ذلك سيناريوهات لعب أدبي شاملة دون انقطاع النص في المنتصف.

النموذج مفتوح الأوزان وتم ضبطه للمحتوى غير المقيد. لا يرفض المواضيع القانونية للبالغين. إنه ليس GPT أو Claude أو أي نموذج من مورد آخر. تتم معالجة الطلبات على خوادمنا المخصصة. هذا يضمن أداءً ثابتًا وزمن استجابة منخفضًا.

راقب استخدام السياق للبقاء ضمن الحدود المسموح بها. تتبع واجهة برمجة التطبيقات (API) استخدام الرمز (Token) بدقة. الأخطاء والرفض لا تستهلك الرموز. يساعدك هذا النموذج الشفاف للفوترة على التنبؤ بالتكاليف. خطط لنوافذ السياق الخاصة بك لتعظيم القيمة.