وثائق واجهة برمجة تطبيقات متوافقة مع OpenAI

المتطلبات الأساسية: حزمة التطوير (SDK) وعنوان URL الأساسي

ابدأ بتثبيت المكتبة المفضلة لديك وتوجيهها إلى نقطة النهاية الخاصة بنا. ال base_url هو https://api.apicompatible.com/v1. تؤكد وثائق الواجهة برمجة التطبيقات المتوافقة مع OpenAI أن المكتبات القياسية تعمل على الفور. لا تحتاج إلى جهاز توجيه أو إعداد بوابة معقد. غيّر عنوان URL والمفتاح، ثم شغّل الكود الموجود لديك.

المصادقة: الرأس وتنسيق المفتاح

أرسل مفتاحك في Authorization الرأس. استخدم التنسيق Bearer your_api_key. تستخدم واجهة برمجة التطبيقات الخاصة بنا هيكل مفتاح API المتوافق مع OpenAI القياسي. يتم إنشاء المفاتيح فورًا عبر تسجيل الدخول عبر Google أو البريد الإلكتروني. احتفظ بمفتاحك بأمان، حيث يمنحك الوصول إلى رصيدك المدفوع مسبقًا.

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

أرسل طلبات إلى /v1/chat/completions. حدد النموذج كـ uncensored. تُعيد الـ API استجابات نصية مباشرة. استخدم أمر curl التالي للتحقق من الاتصال:

Copycurl https://api.apicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List available models"}]
  }'

يضمن هذا النهج المتوافق مع OpenAI SDK توليد نصوص غير مقيد. يتعامل النموذج مع الطلبات المعقدة دون رفض غير ضروري للمحتوى القانوني.

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

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

Copyfrom openai import OpenAI

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

يقلل البث من زمن الاستجابة المُدرَك بشكل كبير. يعمل بسلاسة مع مكتبات جانب العميل القياسية.

المعلمات: درجة الحرارة وTop-P والأدوات

تحكّم في التوليد باستخدام المعاملات القياسية. اضبط temperature للعشوائية أو top_p للعينة النواة. مكن tools للاستدعاء الوظيفي. وضع JSON متاح عبر response_format. الـ uncensored تحترم هذه القيود بفعالية:

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.apicompatible.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 صارمة لحالات الاستخدام البرمجية.

حدود: حدود المعدل وحجم الجسم

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

التدفق

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)