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

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

ابدأ بضبط عنوان URL الأساسي على HTTPS://api.uncensoredal.com/v1 ومرر مفتاح API الخاص بك في رأس التفويض (Authorization). تتلقى مفتاحاً نشطاً واحداً لكل حساب، وإنشاء مفتاح جديد يلغي سريان المفتاح السابق فوراً. هذا الإعداد البسيط يعمل مع أي عميل متوافق مع OpenAI دون منطق توجيه معقد.

Copycurl https://api.uncensoredal.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate the next 50 lines of a python script"}]
  }'

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

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

أرسل طلب POST إلى /v1/chat/completions مع سجل رسائلك في مصفوفة الرسائل. يعالج النظام إدخال النص ويُرجع النص المُولّد دون رفض المحتوى للمحتوى البالغ القانوني. يجب أن تحدد النموذج على أنه "uncensored" في حمولتك لضمان التوافق.

Copyfrom openai import OpenAI

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

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

استجابات البث مع SSE

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

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)

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

استدعاء الوظائف ووضع JSON

عرّف الأدوات في طلبك لتمكين استدعاء الوظائف أو إجبار إخراج JSON باستخدام response_format. تدعم الواجهة البرمجية tool_choice للتحكم الدقيق في متى يجب على النموذج استدعاء وظيفة. تعمل هذه الميزة مع مخطط OpenAI القياسي، لذا يمكنك إعادة استخدام تعريفات الأدوات الحالية.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.uncensoredal.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 صالحاً، وهو مفيد لتحليل البيانات المهيكلة برمجياً. يمكنك الجمع بين هذا وإعدادات درجة الحرارة لموازنة الإبداع مع الموثوقية الهيكلية. تتعامل الـ API مع منطق تنفيذ الأدوات عن طريق إرجاع تفاصيل استدعاء الوظيفة ليتم معالجتها بواسطة كودك.

تكوين معلمات النموذج

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

يمكنك استخدام presence_penalty و frequency_penalty لتقليل التكرار في النصوص الأطول. تتيح هذه المعلمات ضبط أسلوب النموذج بدقة دون تغيير الأوزان الأساسية. اضبطها تدريجياً للعثور على التوازن المناسب لحالة الاستخدام الخاصة بك.

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

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

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