Apertus ia API Documentation

1. Quickstart: Connect Your First Request

عنوان URL الأساسي هو https://api.apertusia.com/v1. مرّر مفتاح API الخاص بك في رأس Authorization. مُعرّف النموذج هو uncensored. يعمل هذا الإعداد مع أي عميل متوافق مع OpenAI.

استخدم أمر cURL هذا لاختبار الاتصال على الفور. استبدل YOUR_API_KEY بمفتاحك الفعلي.

Copycurl https://api.apertusia.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 5 python libraries for web scraping"}]
  }'

تُعيد الأخطاء المصادقة 401. عدم كفاية الأموال تُعيد 402. حدود المعدل تُعيد 429.

2. المعلمات المدعومة: درجة الحرارة، وTop P، والبذرة

تحكّم في العشوائية باستخدام temperature، والتنوع باستخدام top_p، وإمكانية إعادة الإنتاج باستخدام seed. تتبع هذه المعاملات معايير OpenAI القياسية. اضبط temperature على 0.7 للحصول على ناتج متوازن، أو على 1.0 لزيادة الإبداع. استخدم top_p للحد من أخذ العينات إلى الكتلة الاحتمالية الأعلى. تضمن معامل seed الحصول على مخرجات متطابقة لأغراض تصحيح الأخطاء.

مثال على مقتطف Python للاختبار المحلي:

Copyfrom openai import OpenAI

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

3. استجابات التدفق باستخدام أحداث الإرسال من الخادم

فعّل التدفق عن طريق تعيين stream: true. تُعيد الـ API أجزاءً عبر أحداث Server-Sent Events. يحتوي كل جزء على نص جزئي وبيانات استخدام الرمز. يقلل هذا من زمن الاستجابة المُدرَك للاستجابات الطويلة. تعامل مع أحداث SSE لتحديث واجهة المستخدم في الوقت الفعلي.

مثال Node.js باستخدام SDK الرسمي:

Copyimport OpenAI from "openai";

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

4. تكوين استدعاء الوظائف ووضع JSON

استخدم response_format مع {"type": "json_object"} للحصول على إخراج JSON صارم. يضمن ذلك بيانات مُهيّأة لخطوط الأنابيب البرمجية. فعّل استدعاء الدوال عن طريق توفير مصفوفة tools في جسم الطلب. سيعيد النموذج استدعاءات الأدوات بالتنسيق المتوقع. استخدم tool_choice لفرض سلوك معين.

5. حدود معدل الطلبات وقيود حجم الطلب

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

6. المصادقة ومعالجة الأخطاء

أنشئ مفتاحك عبر لوحة التحكم. استخدم تسجيل الدخول عبر Google أو البريد الإلكتروني. يظهر المفتاح فورًا. أضفه إلى رأس Authorization: Bearer. المفاتيح غير الصالحة تُرجع خطأ 401. تشير أخطاء 429 إلى استنفاد حد معدل الطلبات. تعني أخطاء 402 أن رصيدك المدفوع مسبقًا قد استُنفد. قم بإعادة الشحن باستخدام USDT أو USDC. لا تنتهي صلاحية الرصيد أبدًا.

البث المتدفق

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)