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

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

ابدأ كل طلب بتوجيه عميلك إلى HTTPS://api.uncensoredia.com/v1 وإرفاق مفتاحك. المصادقة يستخدم المعيار Bearer scheme، لذا يمكنك ببساطة لصق الرمز الذي تلقيته بعد التسجيل باستخدام Google أو البريد الإلكتروني. نقطة النهاية متوافقة بالكامل openai compatible API متوافق، مما يعني أنك تحتاج فقط إلى تبديل عنوان URL الأساسي ومفتاح API في تكوينك الحالي. لا تحتاج إلى إدارة طبقات التوجيه المعقدة أو رؤوس الوكيل. فقط تأكد من أن Authorization يحتوي الرأس على التوكن الفريد الخاص بك. يضمن هذا الإعداد وصول طلباتك إلى نموذج غير الخاضع للرقابة المخصص دون أي تصفية وسيطة. إذا حصلت على 401 خطأ، تحقق من أن مفتاحك نشط ومُتنسق بشكل صحيح.

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

أرسل الرسائل إلى POST /v1/chat/completions لتلقي استجابات نصية من النموذج غير المقيد. يتعامل هذا الرابط الوحيد مع جميع احتياجات التوليد لديك، من المطالبات البسيطة إلى المحادثات متعددة الأدوار المعقدة. يمكنك التحكم في طول الإخراج والعشوائية باستخدام معلمات مثل max_tokens, temperature، و top_p. يدعم النموذج مساحة 100,000 رمز نافذة السياق، مما يتيح لك إدخال مستندات شاملة أو سجلات محادثات طويلة. يمكنك إرسال ما يصل إلى 16,000 توكن في الاستجابة. إذا حذفت max_tokens, الحد الافتراضي هو 2,048 رمزًا. لا يدعم هذا النهاية إنشاء الصور أو الصوت. إنه نص فقط، نص فقط. استخدم أمر curl التالي لاختبار اتصالك على الفور.

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

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

إعداد SDK Node.js

دمج واجهة برمجة التطبيقات في تطبيقات JavaScript أو TypeScript الخاصة بك باستخدام @anthropic-ai/sdk أو المكتبة الرسمية openai حزمة. اضبط baseURL نقطة النهاية وقدم مفتاح API الخاص بك. يتيح لك هذا استخدام الأساليب المألوفة مثل chat.completions.create() مباشرة. يتعامل SDK مع طلبات HTTP و تحليل استجابات JSON لك. يمكنك بسهولة التعامل مع الأخطاء مثل 402 (رصيد غير كافٍ) أو 429 (حد معدل الطلب) داخل منطق التطبيق الخاص بك. هذا الإعداد مثالي لخوادم الويب، أو البوتات، أو أي بيئة Node.js. يعمل النموذج غير الخاضع للرقابة بسلاسة مع تنسيق الطلب القياسي. قم بتكوين عميلك لضمان التوافق مع توقعات واجهة برمجة التطبيقات.

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

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

حدود معدل الطلبات وحدود السياق

تفرض واجهة برمجة التطبيقات حدودًا صارمة لضمان الأداء المستقر لجميع المستخدمين. يمكنك إرسال ما يصل إلى 300 طلب في الدقيقة لكل مفتاح ولديك 8 طلبات متزامنة نشط في أي وقت. الحد الأقصى لحجم جسم الطلب هو 8 ميجابايت. إذا تجاوزت هذه الحدود، ستتلقى 429 رمز الحالة. تأكد من معالجة إعادة المحاولة باستخدام زيادة الأسي لتجنب تجاوز هذه الحدود بشكل متكرر. نافذة السياق هي 100,000 رمز، لكن الحد الأقصى للإخراج هو 16,000 رمز. إذا كنت بحاجة إلى المزيد من الإخراج، قم بتعديل max_tokens معامل. أخطاء مثل 401 (مفتاح غير صالح) و 402 (لا يوجد رصيد) هي فورية ولا تستهلك رصيد الرموز الخاصة بك. أدر حصتك بعناية لتجنب انقطاع الخدمة أثناء مهام التوليد عالية الحجم.

cURL

Copycurl https://api.uncensoredia.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "return json with key status true"}]
  }'

Python

Copyfrom openai import OpenAI

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