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

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

تتطلب واجهة برمجة التطبيقات رمز حامل (bearer token) لكل طلب. قم بإنشاء مفتاحك في صفحة الحصول على مفتاح API عن طريق تسجيل الدخول باستخدام Google أو كلمة مرور البريد الإلكتروني. يظهر المفتاح على الفور دون التحقق من الهاتف. استخدم عنوان URL الأساسي https://api.uncensoredaigithub.com/v1 باستخدام مكتبات OpenAI الرسمية من خلال تحديث base_url و api_key القيم. هذا الإعداد يعمل مع أي عميل متوافق مع OpenAI.

نقطة النهاية: https://api.uncensoredaigithub.com/v1

رأس المصادقة: Authorization: Bearer YOUR_API_KEY

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

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

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

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

استجابات البث والاستخدام

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

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

استدعاء الوظائف والأدوات

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

عرّف الدوال بأسماء ووصف ومخططات المعاملات. تعيد واجهة برمجة التطبيقات اسم الدالة والحجج في الاستجابة. قم بتحليل هذه الحجج لتنفيذ الكود المخصص الخاص بك. هذه القدرة تجعل API LLM غير الخاضع للرقابة مناسبًا لسير عمل الوكلاء المعقدة.

وضع JSON والمعاملات

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

تشمل المعلمات المدعومة الأخرى seed لإخراج حتمي، presence_penalty، و frequency_penalty. استخدم seed لإعادة إنتاج استجابات محددة لأغراض تصحيح الأخطاء. اضبط العقوبات لتقليل التكرار أو تشجيع تنوع المفردات في مخرجاتك.

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

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

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

cURL

Copycurl https://api.uncensoredaigithub.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Run the unit tests for the new auth module."}]
  }'

Python

Copyfrom openai import OpenAI

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