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

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

واجهة برمجة تطبيقات Heretic AI متوافقة تماماً مع OpenAI. تتفاعل معها عن طريق توجيه عميلك إلى عنوان URL الأساسي الخاص بنا: https://api.hereticai.cc/v1. تعتمد المصادقة على مفتاح API واحد لكل حساب، يتم إنشاؤه فوراً عند التسجيل عبر Google أو البريد الإلكتروني. مرر هذا المفتاح في Authorization رأس الصفحة كرمز حامل (Bearer token). معرف النموذج ببساطة uncensored. يتعامل هذا النموذج الوحيد مع جميع طلباتك دون تعقيد التوجيه. الأخطاء مثل 401 تشير إلى مفتاح غير صالح، بينما 402 تعني أنك تحتاج إلى المزيد من رصيد الكريبتو المدفوع مسبقًا.

Copycurl https://api.hereticai.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "generate twenty test cases"}]
  }'

نقطة نهاية إكمال الدردشة

أرسل طلبات نصية باستخدام POST /v1/chat/completions النقطة النهائية. تتوقع واجهة برمجة التطبيقات مصفوفة رسائل قياسية تحتوي على سجل محادثتك أو المطالبة. تُرجع النص المولد في choices مصفوفة. هذه واجهة برمجة تطبيقات للأغراض العامة فقط: نص مدخل، نص مخرج. تدفع فقط مقابل الرمز المميز المستهلك. الرصيد المدفوع مسبقًا لا ينتهي، والرفض أو الأخطاء لا تستهلك رموزًا مميزة. يلغي هذا النهج قفل الاشتراكات ومستويات مجانية غير متوقعة.

Copyfrom openai import OpenAI

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

استجابات البث (SSE)

فعّل تدفق الرمز الفوري عن طريق تعيين stream: true في طلبك. يعيد الواجهة البرمجية أحداث الإرسال من الخادم (SSE) لكل رمز يتم توليده. هذا يسمح لك بعرض المخرجات تدريجياً، وهو أمر حاسم للتطبيقات الحساسة للزمن. تظهر إحصائيات استخدام الرموز في الشريحة الأخيرة من التدفق. تعمل هذه الميزة بسلاسة مع مكتبات SDK القياسية لـ OpenAI التي تتعامل مع أحداث 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)

استدعاء الوظائف والأدوات

تدعم واجهة برمجة التطبيقات استدعاء الوظائف مع tools و tool_choice المعلمات. عرّف مخططات أدواتك في الطلب، وسيعيد النموذج مكالمات وظيفية منظمة عند الاقتضاء. هذا يتيح سير عمل معقد حيث يقرر نموذج اللغة الكبير (LLM) الإجراء التالي الذي يجب اتخاذه. يمكنك فرض استخدام أدوات محددة أو ترك النموذج يختار بحرية. هذه القدرة ضرورية لبناء تطبيقات وكيالية تتفاعل مع الأنظمة الخارجية أو قواعد البيانات.

وضع JSON

تأكد من حتمية المخرجات عن طريق تعيين response_format إلى {"type": "json_object"}. سيقيّد النموذج استجابته بـ JSON صالح، وهو أمر حيوي للتحليل البرمجي. يقلل هذا من الحاجة إلى إصلاحات التعبيرات النمطية (regex) بعد المعالجة. يضمن أن المخرجات يمكن استهلاكها مباشرة بواسطة كودك. هذا مفيد بشكل خاص لمهام استخراج البيانات الهيكلية أو توليد التكوينات.

المعاملات والحدود

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

Node.js

Copyimport OpenAI from "openai";

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