البدء السريع: دمج واجهة API لصديقة الذكاء الاصطناعي

عنوان URL الأساسي والمصادقة

تتبع واجهة API الخاصة بنا معيار chat-completions الخاص بـ OpenAI، مما يجعل التكامل مباشراً للعملاء الحاليين. يجب أن تتضمن مفتاح API الخاص بك في رأس Authorization لكل طلب. عنوان URL الأساسي لجميع نقاط النهاية هو https://api.roleplayapi.com/v1. عند استخدام SDKs الرسمية، قم بتحديث تكوين base_url للإشارة إلى هذا العنوان وقم بتوفير مفتاحك كـ api_key. يضمن هذا الإعداد وصول طلباتك إلى نقطة النهاية غير الخاضعة للرقابة المخصصة لدينا دون تعديل منطقك القياسي.

إرسال إكمال

ابدأ محادثة بإرسال طلب POST إلى /v1/chat/completions. معرف النموذج هو uncensored. يمكنك تمرير أي عدد من الرسائل في مصفوفة messages لتأسيس سياق أو بدء حوار جديد. الاستجابة تحتوي على مخرجات النص من النموذج، والتي يمكنك بثها أو تحليلها ككائن JSON. تتعامل نقطة النهاية هذه مع التفاعل الأساسي للنص الداخل والخارج المطلوب لتطبيقات الشخصيات.

Copycurl https://api.roleplayapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

تكامل SDK Python

استخدم مكتبة Python الرسمية openai للتفاعل مع واجهة API بأقل قدر من الشيفرة النمطية. قم بتكوين العميل مع عنوان URL الأساسي الخاص بنا ومفتاح API الخاص بك. ثم، قم باستدعاء chat.completions.create بمعرف النموذج uncensored. تستفيد هذه الطريقة من تلميحات الأنواع وميكانيكيات معالجة الأخطاء الموجودة، مما يتيح لك التركيز على منطق التطبيق الخاص بك بدلاً من تحليل HTTP. يوفر كائن الاستجابة الوصول إلى المحتوى المولد مباشرة.

Copyfrom openai import OpenAI

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

تكامل SDK Node.js

لمشاريع JavaScript و TypeScript، يوفر Node SDK الخاص بـ OpenAI واجهة نظيفة لمكالمات API. قم بتهيئة العميل مع عنوان URL الأساسي المخصص ومفتاحك السري. قم باستدعاء نقطة نهاية إكمال الدردشة باستخدام نموذج uncensored. هذه الطريقة مثالية لخوادم الويب أو الوظائف الطرفية حيث تحتاج إلى إدارة الطلبات غير المتزامنة بكفاءة. يتعامل SDK مع تسلسل وتحويل كائن JSON تلقائياً.

Copyimport OpenAI from "openai";

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

تمكين البث

قلل من زمن الاستجابة الظاهري بتمكين أحداث الإرسال من الخادم (SSE). اضبط المعلمة stream على true في طلبك. سترجع واجهة API تدفقاً للقطع بدلاً من استجابة كاملة واحدة. هذا مفيد بشكل خاص لواجهات الدردشة حيث يتوقع المستخدمون استجابات شخصية فورية. يمكنك معالجة كل قطعة عند وصولها، وتحديث واجهة المستخدم تدريجياً. ينتهي التدفق عندما ينتهي النموذج من توليد تسلسل الرموز.

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)

الحدود والأخطاء والسياق

تخضع طلباتك لحدّ معدل قدره 300 طلب في الدقيقة لكل مفتاح. إذا تجاوزت هذا الحد، تُعيد الـ API رمز حالة 429. يؤدي فشل المصادقة إلى خطأ 401، بينما يُسبب عدم كفاية رصيد مسبق الدفع خطأ 402. تدعم نافذة السياق ما يصل إلى 100,000 رمز للموجّه والاكتمال معًا. إذا كنت بحاجة إلى التحقق من النماذج المتاحة، أرسل طلب GET إلى /v1/models. تأكد من أن جسم الطلب لا يتجاوز 8 MB.