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

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

ابدأ بتحديث تكوين عميلك بمفتاح API الفريد الخاص بك وعنوان URL الأساسي المحدد لدينا. لا تحتاج إلى تغيير منطق الكود الخاص بك، فقط سلسلة الاتصال. نقطة النهاية هي https://api.gatewayllm.cc/v1 ويحتاج إلى Authorization: Bearer <key> الرأس. يعمل هذا الإعداد مع أي مكتبة SDK متوافقة مع OpenAI قياسي لديك بالفعل مثبتة.

الطلب الأول

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

Copycurl https://api.gatewayllm.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Check server health status"}]
  }'

ستصل استجابتك بتنسيق JSON يحتوي على النص المُولّد. إذا تلقيت استجابة صالحة، فإن تكاملك يعمل بشكل صحيح.

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

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

Copyfrom openai import OpenAI

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

تتعامل المكتبة مع التسلسل وفك التسلسل تلقائيًا. يمكنك الآن استخدام الأساليب القياسية مثل chat.completions.create مع الخلفية الخلفية لدينا.

إعداد SDK Node.js

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

Copyimport OpenAI from "openai";

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

استدعاء طريقة الإكمال بمعرف النموذج المطلوب. سيحتوي كائن الاستجابة على النص المُولّد في content الحقل.

البث وأحداث الإرسال الخادم (SSE)

تمكين التدفق لتلقي الرموز أثناء توليدها، مما يقلل من زمن الاستجابة المُدرَك للمخرجات الطويلة. اضبط stream: 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 طلب في الدقيقة لكل مفتاح. ستتلقى 401 خطأ إذا كان مفتاحك غير صالح، أو 402 خطأ إذا استنفدت رصيدك المدفوع مسبقاً، أو 429 خطأ إذا تجاوزت حد معدل الطلبات. يدعم كل طلب نافذة سياق تتكون من 100,000 رمز. تأكد من أن مجموع النص المطلوب والإكمال لا يتجاوز هذا الحد لتجنب الاقتطاع.