البدء السريع لواجهة برمجة تطبيقات متوافقة مع OpenAI

المتطلبات الأساسية وإعداد البيئة

تحتاج إلى مفتاح API وعنوان URL الأساسي الصحيح لتوصيل عميلك. سجّل باستخدام Google أو البريد الإلكتروني على صفحة الحصول على مفتاح API لتلقي بيانات الاعتماد الخاصة بك على الفور. يمنحك التجريبي $0.50 لمدة سبعة أيام، ويمكنك إضافة رصيد باستخدام USDT أو USDC عبر العملات المشفرة. احتفظ بمفتاحك آمناً وتأكد من مطابته لإعدادات حسابك.

تأكد من أن بيئتك تدعم طلبات HTTP القياسية. تعمل خدمتنا على نموذج واحد غير خاضع للرقابة، لذا لا تحتاج إلى إدارة نقاط نهاية نماذج متعددة. اضبط عنوان URL الأساسي الخاص بك على HTTPS://api.openaiapicompatibility.com/v1 قبل إجراء أي مكالمات. يضمن ذلك توجيه جميع الطلبات بشكل صحيح إلى خوادم الاستدلال الخاصة بنا.

تثبيت الحزمة البرمجية (SDK) الرسمية لـ OpenAI

استخدم الحزم الرسمية (SDKs) للحفاظ على التوافق مع سير عمل OpenAI الحالي. تعمل مكتبات Python و Node.js مباشرة مع نقطة النهاية الخاصة بنا لأننا نلتزم بمخطط API القياسي. قم بتثبيت الحزمة في دليل مشروعك باستخدام مدير الحزم المفضل لديك. تتجنب هذه الطريقة الحاجة إلى كتابة كود عميل HTTP مخصص.

ندعم معلمات قياسية مثل temperature و top_p وتسلسلات الإيقاف. تتعامل الحزمة البرمجية مع تسلسل JSON ورؤوس الطلب تلقائيًا. يمكنك تبديل عنوان URL الأساسي في تكوين العميل للإشارة إلى خوادمنا. يتيح لك ذلك التبديل بين المزودين دون تغيير منطق التطبيق الخاص بك.

تكوين عنوان URL الأساسي ومفتاح API

اضبط عنوان URL الأساسي ومفتاح API في كائن تكوين العميل الخاص بك. عنوان URL الأساسي هو HTTPS://api.openaiapicompatibility.com/v1. مرر مفتاح API الخاص بك في رأس المصادقة كرمز Bearer. يضمن هذا التكوين مصادقة طلباتك وتوجيهها إلى الخدمة الصحيحة.

Copycurl https://api.openaiapicompatibility.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list all python packages for data science"}]
  }'

تحقق من اتصالك عن طريق استدعاء نقطة النهاية GET /v1/models. يعيد هذا قائمة النماذج المتاحة، بما في ذلك معرف النموذج غير الخاضع للرقابة. استخدم هذه الخطوة لتأكيد صحة وصولك إلى الشبكة ومعلومات الاعتماد الخاصة بك قبل إرسال طلبات معقدة.

إجراء أول إكمال للدردشة

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

Copyfrom openai import OpenAI

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

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

استجابات البث مع 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)

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

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

استخدم وضع JSON عن طريق تعيين response_format إلى json_object. يجبر هذا النموذج على إخراج JSON صالح بدلاً من النص الحر. إنه مفيد لاستخراج البيانات المهيكلة أو استجابات API. اجمع بينه وبين استدعاء الوظائف لسيناريوهات استخدام الأدوات.

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

Node.js

Copyimport OpenAI from "openai";

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