مستندات نقاط النهاية المتوافقة مع OpenAI

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

ابدأ بإنشاء مفتاح API الخاص بك عبر لوحة التحكم باستخدام حساب Google أو البريد الإلكتروني. ألصق هذا المفتاح في رأس كل طلب كـ Authorization: Bearer YOUR_API_KEY. عنوان URL الأساسي هو https://api.openaicompatibleendpoints.com/v1, ضمان عمل رمز العميل الحالي الخاص بك دون تعديل. تتلقى مفتاحًا نشطًا واحدًا لكل حساب، يمكنك تجديده على الفور إذا تعرض للاختراق. لا يلزم رقم هاتف للتسجيل، مما يبقي العملية سريعة وخاصة.

الطلب الأول

أرسل طلب إكمال الدردشة القياسي لبدء توليد النص على الفور. يؤكد هذا أن بيانات الاعتماد الخاصة بك ورصيد الرمز نشط قبل توسيع نطاق سير العمل الخاص بك. تقبل نقطة النهاية حمولات JSON القياسية المطابقة لتنسيق OpenAI، مما يتيح لك اختبار الاتصال بأقل قدر من الحمل.

Copycurl https://api.openaicompatibleendpoints.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Return the current server time in UTC format"}]
  }'

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

ثبّت حزمة بايثون الرسمية من OpenAI وجّهها إلى عنوان URL الأساسي الخاص بنا للاستفادة من الأنماط المألوفة. يعمل هذا النهج بسلاسة مع أدوات مثل LangChain أو LlamaIndex التي تتوقع نقاط نهاية متوافقة مع OpenAI. يمكنك تبديل النماذج أو مزودي الخدمة عن طريق تحديث تكوين عنوان URL الأساسي فقط دون تغيير منطق التطبيق. هذه المرونة حاسمة للوكالات التي تدير خطوط أنابيب استنتاج متعددة.

Copyfrom openai import OpenAI

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

قم تهيئة عميل Node.js بعنوان URL الأساسي ومفتاح واجهة برمجة التطبيقات لبدء طلبات التدفق أو الطلبات المتزامنة. يعكس هذا الإعداد واجهة عميل OpenAI القياسية، مما يسهل دمجه في تطبيقات Express أو Fastify. يمكنك معالجة الأخطاء بسلاسة من خلال التحقق من أكواد الحالة التي يعيدها الخادم، مما يضمن بقاء تطبيقك قويًا أثناء الاستخدام عالي الحجم.

Copyimport OpenAI from "openai";

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

استجابات البث (SSE)

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

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)

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

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