توثيق API: البدء السريع

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

تستخدم واجهة برمجة التطبيقات serverless llm هيكل نقطة النهاية القياسي المتوافق مع OpenAI. للبدء، تحتاج إلى معلومتين: عنوان URL الأساسي ومفتاح API الخاص بك.

استخدم عنوان URL الأساسي التالي لجميع الطلبات:

https://api.serverlessllmapi.com/v1

تتم المصادقة عبر رأس Authorization. أنشئ حسابًا في صفحة الحصول على مفتاح API لتلقي مفتاحك. يمكنك تجديد هذا المفتاح في أي وقت، مما يلغي سريان المفتاح القديم فورًا. احتفظ بمفتاحك بأمان، حيث يوفر وصولاً مباشرًا إلى رصيدك المسبق الدفع.

الطلب الأول: إكمال الدردشة

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

إليك مثال أساسي باستخدام curl لتوليد استجابة:

Copycurl https://api.serverlessllmapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

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

تكامل SDK Python

يعد استخدام SDK Python الرسمي لـ OpenAI أسرع طريقة للتكامل. نظرًا لأن واجهتنا متوافقة مع OpenAI، فأنت بحاجة فقط إلى تجاوز عنوان URL الأساسي ومفتاح API. يضمن ذلك عمل الكود الحالي دون تعديل.

Copyfrom openai import OpenAI

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

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

تكامل SDK Node.js

لمطوري JavaScript وTypeScript، يوفر SDK Node.js لـ OpenAI مسار تكامل مباشر. قم بتكوين العميل بعنوان URL الأساسي ومفتاح API الخاص بك لبدء إرسال الطلبات على الفور.

Copyimport OpenAI from "openai";

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

هذا الإعداد مثالي لوظائف الخوادم الخالية من الخوادم أو خدمات الخلفية التي تتطلب تفاعلات LLM في الوقت الفعلي. يعني التسعير حسب الاستخدام أنك تدفع فقط مقابل ما تستخدمه، بدون اشتراكات شهرية. لا تنتهي صلاحية الرصيد، لذا يمكنك إيقاف الاستخدام بين المشاريع دون فقدان رصيدك.

استجابات البث المتدفق (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)

عالج أحداث الدفق في كود العميل الخاص بك لتراكم الاستجابة النهائية. يعمل البث المتدفق مع كل من SDK Python وNode.js عند تكوينه بشكل صحيح. هذه الميزة مفيدة بشكل خاص لتوليد المحتوى طويل المدى حيث يكون التغذية الراجعة الفورية ذات قيمة.

حدود المعدل والقيود

فهم القيود لضمان تكامل سلس. تفرض الواجهة حد معدل 300 طلب في الدقيقة لكل مفتاح API. يجب ألا يتجاوز جسم كل طلب 8 MB. إذا تجاوزت حد المعدل، ستتلقى رمز حالة 429.

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