مرجع واجهة GitHub Uncensored AI API

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

تتطلب واجهة برمجة التطبيقات رمز حامل (bearer token) لكل طلب. أنت تنشئ هذا المفتاح على الفور عبر لوحة التحكم باستخدام بيانات اعتماد Google أو البريد الإلكتروني. بمجرد إنشائه، يقوم المفتاح بمصادقة حسابك المسبق ضد النموذج المستضاف.

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

استخدم رأس المصادقة القياسي مع مخطط Bearer. استبدل النص النائب بسلسلة المفتاح الفريدة الخاصة بك.

الإعداد الأساسي

• URL الأساسي: https://api.githubuncensoredai.com/v1
• رأس المصادقة: Authorization: Bearer YOUR_API_KEY
• معرف النموذج: uncensored

Copycurl https://api.githubuncensoredai.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Fix the syntax error in this python loop"}]
  }'

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

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

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

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

Copyfrom openai import OpenAI

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

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

فعّل التدفق عن طريق تعيين علم التدفق إلى true. تُرجع واجهة برمجة التطبيقات سلسلة من أحداث الإرسال من الخادم بدلاً من كائن JSON واحد. يحتوي كل حدث على جزء من النص المُولَّد.

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

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

Copyimport OpenAI from "openai";

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

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

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

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

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)

المعاملات & الحدود

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

احترم حدود الطلبات لتجنب الأخطاء. يمكنك إرسال ما يصل إلى 300 طلب في الدقيقة لكل مفتاح. يتم تحديد الطلبات المتزامنة بثمانية لكل مفتاح. الحد الأقصى لحجم جسم الطلب هو 8 ميجابايت.

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

استخدام الرموز والفوترة

الفوترة مدفوعة مسبقاً وتعتمد على استخدام الرموز المميزة الفعلية. تكلف الرموز المميزة للإدخال 0.15 دولار لكل مليون، وتكلف الرموز المميزة للإخراج 0.50 دولار لكل مليون. الأخطاء والرفضات لا تستهلك الرصيد.

الرصيد لا ينتهي. تتم معالجة عمليات الإيداع عبر العملات المشفرة فقط. تحصل على رصيد إضافي للإيداعات الأكبر. يتتبع النظام الاستخدام بدقة لكل مفتاح API.

راقب رصيدك عبر لوحة التحكم. إذا نفذ الرصيد، ستفشل طلباتك مع رمز خطأ محدد. أضف الأموال فوراً لاستئناف الخدمة دون انتظار الموافقات.