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

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

تتطلب واجهة برمجة التطبيقات مفتاح API واحدًا للمصادقة. تتلقى هذا المفتاح على الفور بعد التسجيل باستخدام Google أو عنوان بريد إلكتروني. مرره في Authorization رأس الصفحة كرمز حامل (Bearer token). عنوان URL الأساسي هو https://api.topuncensored.com/v1. يعمل هذا الرابط مع أي مكتبة SDK أو مكتبة عميل متوافقة مع OpenAI.

• استخدم الرأس: Authorization: Bearer YOUR_API_KEY
• قم بتعيين عنوان URL الأساسي للعميل الخاص بك إلى نقطة النهاية المقدمة.

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

Copycurl https://api.topuncensored.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate a list of ten distinct UI layout patterns."}]
  }'

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

أرسل مطالبات نصية إلى /v1/chat/completions النقطة النهائية. معرف النموذج هو uncensored. تتعامل نقطة النهاية هذه مع تنسيق الدردشة القياسي مع الرسائل. تعيد استجابات نصية مباشرة. لا توجد طبقات أو أغلفة إضافية. أنت تتحكم في نافذة السياق التي تتسع لـ 100,000 رمز. تعمل الطلبات التي تقل عن 8 ميجابايت بشكل موثوق. استخدم هذا للتوليد النصي المباشر.

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

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

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

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

Copyfrom openai import OpenAI

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

استدعاء الأدوات ووضع JSON

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

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

Copyimport OpenAI from "openai";

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

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

تعديل temperature, top_p، و stop التسseqs. اضبط max_tokens إلى 16,000. الافتراضي هو 2,048 إذا تم حذفه. تحكم في التكرار باستخدام presence_penalty و frequency_penalty. استخدم seed لإخراج حتمي. تضبط هذه المعاملات جودة التوليد. لديك تحكم كامل في نمط المخرجات.

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

الأخطاء ونافذة السياق

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

تتبع استخدام التوكنات. تجنب تجاوز حدود معدل الطلب. أعد المحاولة مع زيادة أسية في الفجوة الزمنية. يضمن ذلك تشغيلًا موثوقًا. تم تصميم 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)