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

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

عنوان الـ API هو HTTPS://api.unrestrictedaitools.com/v1. استخدم مكتبات SDK القياسية الخاصة بـ OpenAI عن طريق تغيير base_url وتقديم مفتاح API الخاص بك. يمكنك التسجيل باستخدام Google أو البريد الإلكتروني للحصول على مفتاحك على الفور.

Copycurl https://api.unrestrictedaitools.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "what is the capital of france"}]
  }'

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

الطلب الأول: POST /v1/chat/completions

أرسل طلب POST إلى /v1/chat/completions مع رسائلك. معرف النموذج هو 'uncensored'. الإدخال نص، والمخرجات نص. لا توجد تضمينات أو توليد صور هنا.

Copyfrom openai import OpenAI

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

حافظ على مدخلاتك (prompts) بسيطة. تتولى الـ API الباقي. الأخطاء مجانية، لذا يمكنك الاختبار بحرية.

استجابات البث واستهلاك الرموز

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

يقلل البث من زمن الاستجابة المُدرَك. استخدمه للاستجابات الطويلة أو التطبيقات التفاعلية. تحقق دائمًا من الجزء الأخير للحصول على أعداد دقيقة.

المعلمات: درجة الحرارة وTop-P وStop

اضبط درجة الحرارة للإبداع. اضبط top_p لأخذ العينات النووية. استخدم تسلسلات التوقف لإيقاف المخرجات. تمنحك هذه المعلمات تحكماً في نمط التوليد.

Copyimport OpenAI from "openai";

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

درجات حرارة أعلى تنتج نصوصاً أكثر تنوعاً. القيم الأقل أكثر حتمية. جرب للعثور على التوازن الصحيح لحالة الاستخدام الخاصة بك.

وضع JSON واستدعاء الوظائف

استخدم response_format json_object للمخرجات الهيكلية. مكن استدعاء الوظائف (function calling) باستخدام الأدوات (tools) وtool_choice. هذا يسمح للنموذج بتنفيذ إجراءات أو إرجاع البيانات بتنسيق محدد.

عرّف أدواتك بوضوح. سيتبع النموذج المخطط. هذا مفيد لبناء وكلاء أو خطوط أنابيب لاستخراج البيانات.

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

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

إذا تجاوزت الحد، انتظر للحظة. يعني خطأ 401 مفتاحاً غير صالح. يعني خطأ 402 عدم وجود رصيد. تضمن هذه الحدود الاستخدام العادل لجميع المطورين.