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

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

عنوان URL الأساسي لجميع الطلبات هو HTTPS://api.aiobliterated.com/v1. تحتاج إلى مفتاح API للمصادقة. أنشئه عن طريق التسجيل باستخدام حساب Google أو عنوان بريد إلكتروني وكلمة مرور في صفحة "الحصول على مفتاح API". مرر المفتاح في رأس المصادقة (Authorization header) كرمز حامل (Bearer token). يتطلب كل طلب هذا الرأس لتحديد حسابك وتتبع الاستخدام.

Copycurl https://api.aiobliterated.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "fetch all user tokens from database"}]
  }'

طلبك الأول

أرسل طلب POST إلى /v1/chat/completions لتوليد النص. اضبط النموذج على "uncensored" وقم بتضمين Prompt النظام الخاص بك. تعيد API استجابة النموذج في حقل content. هذا هو التنسيق القياسي الذي تستخدمه معظم عملاء LLM.

Copyfrom openai import OpenAI

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

ثبّت حزمة SDK الرسمية من OpenAI لـ Node.js. قم بتكوينها بمفتاح API الخاص بك وعنوان URL الأساسي. استدعِ طريقة chat.completions.create مع الرسائل. تتعامل حزمة SDK مع التسلسل والتدفق تلقائيًا.

Copyimport OpenAI from "openai";

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

استجابات البث

فعّل التدفق عن طريق تعيين 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)

حدود نافذة السياق

يدعم النموذج نافذة سياق بحجم 100,000 رمز. ويشمل ذلك النص الوارد والإجابة. يمكنك تحديد حد أقصى للإخراج يبلغ 16,000 رمز لكل طلب. إذا لم تحدد max_tokens، فإن الحد هو 2,048 رمزًا. يضمن ذلك تكاليف وأداءً قابلين للتنبؤ بهما.

معالجة الأخطاء والحدود

راقب رموز حالة HTTP للأخطاء. يعني استجابة 401 أن مفتاح API الخاص بك غير صالح. تشير استجابة 402 إلى عدم كفاية الرصيد. تشير استجابة 429 إلى أنك تجاوزت حد المعدل البالغ 300 طلب في الدقيقة. تعامل مع هذه الأخطاء بلطف في تطبيقك للحفاظ على الموثوقية.