ملخص المواصفة
إذا كان لديك بالفعل كود يتواصل مع OpenAI، فإن النسخة المختصرة من مواصفة الـ API المتوافقة مع OpenAI هي: غيّر عنوان URL الأساسي، غيّر المفتاح، واضبط النموذج على uncensored. تتوافق هياكل طلبات واستجابات الـ API مع شكل إكمال الدردشة، لذا يمكن لمكتبات SDK تحليلها دون تغييرات.
| العنصر | القيمة |
|---|---|
| عنوان URL الأساسي | https://api.unrestrictedaiapi.com/v1 |
| المصادقة | Authorization: Bearer YOUR_KEY |
| نقاط النهاية | POST /v1/chat/completions، GET /v1/models |
| معرّف النموذج | uncensored |
| نافذة السياق | 100,000 توكن، الموجّه بالإضافة إلى الإكمال |
| الحد الأقصى لجسم الطلب | 8 MB |
| المخرجات | نص فقط |
النموذج هو نموذج مفتوح الأوزان واحد تشغله مزود مستقل ومضبط للإجابة دون رفض المحتوى للاستخدام القانوني للبالغين. إنه ليس نقطة النهاية الرسمية لأي بائع نماذج، ولا يقوم بالتوجيه بين المزودين. وهذا هو سبب وجود معرف نموذج واحد وقائمة نماذج قصيرة.
نقاط النهاية
GET /v1/models
يعيد النماذج المتاحة لمفتاحك. إنها أرخص طريقة للتأكد من صحة مفتاحك وـ Base URL الخاص بك، وتستخدم العديد من واجهات المستخدم الرسومية (UI) هذا الأمر لملء القائمة المنسدلة.
curl https://api.unrestrictedaiapi.com/v1/models \
-H "Authorization: Bearer $KEY"
POST /v1/chat/completions
نقطة النهاية الوحيدة للتوليد. ترسل مصفوفة messages من الكائنات التي تحتوي على role (system، user، assistant أو tool) وcontent، بالإضافة إلى النموذج وخيارات أخذ العينات. مكالمة بسيطة:
curl https://api.unrestrictedaiapi.com/v1/chat/completions \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [
{"role": "system", "content": "Answer in one sentence."},
{"role": "user", "content": "What is a base URL?"}
]
}'
تحتوي الاستجابة على النص المُولّد في choices[0].message.content وعدادات الرموز في usage. تعتمد الفوترة على هذه العدادات.
غير متوفر: نقطة النهاية القديمة للإكمال (completions)، والتضمينات (embeddings)، ونقاط النهاية الخاصة بالصور والصوت والفيديو، والتدريب الدقيق (fine-tuning) ونقاط النهاية الخاصة بالملفات. سيتلقى العميل الذي يستدعيها خطأً، لذا قم بإيقاف هذه الميزات في الأدوات التي تعتمد عليها افتراضياً.
معلمات الطلب
هذه المعلمات مقبولة ومُمرَّرة إلى النموذج:
temperatureوtop_pلأخذ العينات.stopلتسلسل توقف واحد أو أكثر.seedلأخذ عينات قابلة للتكرار عندما تبقي كل شيء آخر متساوياً.presence_penaltyوfrequency_penaltyلتقليل التكرار.max_tokens، وهو اختياري. إذا تركته خارجاً، يمكن للإكمال استخدام باقي نافذة الـ 100,000 توكن.streamلأحداث الإرسال من الخادم (SSE).toolsوtool_choiceلاستدعاء الدوال.response_formatمع{"type":"json_object"}لوضع JSON.
ملاحظتان عمليتان. أولاً، تحسب النافذة الموجّه والإكمال معاً، لذا فإن طلباً بحجم 90,000 توكن يترك حوالي 10,000 توكن للإجابة. ثانياً، حد حجم الجسم هو 8 MB، وهو أكثر بكثير مما تحتاجه 100,000 توكن من النص، لذا لن تصل إليه إلا عن طريق تضمين حمولات مشفرة كبيرة في الرسائل.
البث المتدفق
اضبط stream: true وتصل الاستجابة كأحداث إرسال من الخادم. كل حدث هو شريحة JSON تحتوي على delta الذي يحمل الجزء التالي من النص، ويتم الإبلاغ عن الاستخدام في نهاية التدفق. تخفي مكتبات SDK الإطار؛ مع البروتوكول الخام، تقرأ الأسطر التي تبدأ بـ data: حتى ينتهي التدفق.
from openai import OpenAI
client = OpenAI(base_url="https://api.unrestrictedaiapi.com/v1", api_key="YOUR_KEY")
with client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "List five HTTP status codes."}],
stream=True,
) as stream:
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="")
قاعدة واحدة تؤثر على تخطيط السعة: يحتفظ الطلب المتدفق بمكان التزامن الخاص به حتى ينتهي التدفق، وليس حتى وصول الرمز الأول. إذا توقف العميل أثناء القراءة، فإنه يحتفظ بالمكان مشغولاً. قم دائماً بإغلاق أو إنهاء التدفق، واضبط مهلة العميل.
استدعاء الدوال ووضع JSON
استدعاء الدوال
مرر tools كقائمة من تعريفات الدوال مع معلمات مخطط JSON. إذا قرر النموذج استدعاء دالة، تحتوي الرسالة على tool_calls، والتي يتم بثها أيضاً عند تفعيل stream. تقوم بتشغيل الدالة وإرسال النتيجة مرة أخرى كرسالة بـ role: "tool" ومعرف استدعاء الدالة المطابق tool_call_id. استخدم tool_choice لفرض دالة معينة أو ترك القرار للنموذج.
{
"model": "uncensored",
"messages": [{"role": "user", "content": "Weather in Oslo?"}],
"tools": [{
"type": "function",
"function": {
"name": "get_weather",
"description": "Current weather for a city",
"parameters": {
"type": "object",
"properties": {"city": {"type": "string"}},
"required": ["city"]
}
}
}]
}
يقترح النموذج الحجج؛ لا ينفذ أي شيء. تحقق منها قبل اتخاذ إجراء عليها، كما تفعل مع أي إدخال من المستخدم.
وضع JSON
أضف "response_format": {"type": "json_object"} لطلب كائن JSON صالح واحد. كما هو الحال مع التطبيقات الأخرى على غرار OpenAI، أخبر النموذج أيضاً في الموجّه المفاتيح التي تريدها، على سبيل المثال "أرجع كائناً يحتوي على مفاتيح title وtags". قم بتحليل النتيجة في كتلة try على أي حال، واحتفظ بـ max_tokens سخياً حتى لا يُقطع الكائن الطويل.
الحدود، الرؤوس والأخطاء
| نوع المفتاح | الطلبات المتزامنة | الطلبات في الدقيقة |
|---|---|---|
| مفتاح كامل | 8 | 300 |
| مفتاح التجربة | 2 | 60 |
تتضمن كل استجابة X-Request-Id (اذكره عند التواصل مع الدعم)، و X-Balance-USD (رصيدك المتبقي)، و X-RateLimit-Limit-Requests و X-RateLimit-Limit-Concurrency.
عند تجاوز الحد، تُعيد واجهة برمجة التطبيقات استجابة HTTP 429. يميز رمز الخطأ بين الحالات:
rate_limited: عدد كبير جداً من الطلبات في الدقيقة. قلّل من وتيرة الطلبات أو وزّع الحمل.concurrency: عدد كبير جداً من الطلبات النشطة في وقت واحد. قم بترتيبها في طابور على جانبك.- استجابة 429 مع رأس
Retry-After: 5: حمل زائد مؤقت. انتظر خمس ثوانٍ وأعد المحاولة.
import time
import httpx
def post_with_retry(payload, key, tries=4):
# payload example: {"model": "uncensored", "messages": [...]}
for attempt in range(tries):
r = httpx.post(
"https://api.unrestrictedaiapi.com/v1/chat/completions",
headers={"Authorization": "Bearer " + key},
json=payload,
timeout=120,
)
if r.status_code == 429:
wait = int(r.headers.get("Retry-After", 2 ** attempt))
time.sleep(wait)
continue
return r
return r
الطلبات التي تفشل أو تُرفض لا تُفوتر.
الأدوار، السجل، وكائن الاستجابة
واجهة برمجة التطبيقات عديمة الحالة. لا تتذكر الطلبات السابقة، لذا فإن المحادثة موجودة فقط كمصفوفة messages التي ترسلها في كل مرة. يبدأ السجل النموذجي برسالة system واحدة تحدد السلوك، تليها رسائل متبادلة بين user و assistant. عند تفعيل استدعاء الأدوات، تظهر رسائل tool بينها، وكل منها مرتبط بالاستدعاء الذي يجيب عليه عبر tool_call_id.
لهذا الأمر تبعيتان. الأولى هي التكلفة: كل دور يكلف مقابل السجل الكامل كمدخلات، لذا تصبح المحادثات الطويلة أكثر تكلفة لكل رسالة حتى لو كان كل سؤال قصيراً. الثانية هي التحكم: يمكنك تعديل السجل أو اختصاره أو إعادة كتابته حسب الرغبة. حذف الأدوار الأقدم، أو استبدالها بملخص، أو حقن رسالة مساعد مصححة هي جميعها عمليات عادية، والنموذج يعامل ما ترسله كحقيقة.
عند عودة الاستجابة، اقرأ ثلاثة أشياء. choices[0].message يحتوي النص أو استدعاءات الأدوات. choices[0].finish_reason يخبرك سبب توقف التوليد: نهاية طبيعية، الوصول لحد الرمز، أو استدعاء أداة. usage يحتوي عدّادات الرموز للموجّه، الإكمال والمجموع. إذا كان سبب الانتهاء يشير إلى الوصول لحد الرمز، فإن النص مقتطع، ويجب عليك إما رفع الحد أو طلب استمرار النموذج في دور متابعة.
قائمة تحقق قصيرة للتوافق
قبل نشر عميل مقابل نقطة النهاية هذه، قم بتشغيل هذه الفحوصات. تكتشف معظم مشاكل التكامل في بضع دقائق.
- استدعِ
GET /v1/modelsبمفتاحك وتأكد من حصولك على قائمة تتضمنuncensored. - أرسل طلب دردشة عاديًا بدون خيارات وأكّد ردًا عاديًا بكتلة
usage. - كرر الطلب مع
stream: trueوتأكد من أن عميلك يتعامل مع نهاية البث المتدفق وبيانات الاستخدام النهائية. - إذا كنت تستخدم الأدوات، أرسل دورة كاملة من استدعاء أداة، بما في ذلك طلب المتابعة مع رسالة
tool. - أرسل 10 طلبات في وقت واحد باستخدام مفتاح تجريبي وتأكد أن كودك يتعامل مع رمز الحالة 429 الذي يليه بعد الطلب المتزامن الثاني.
- سجّل
X-Request-Idلكل استدعاء بحيث يمكن تتبع أي نتيجة غريبة لاحقاً.
اجتياز الاختبارات الستة يعني أن عميلك جاهز لحركة المرور الفعلية.
أين يختلف هذا عن منصة OpenAI الكاملة
التوافق يعني بروتوكول المحادثة، وليس المنصة بأكملها. أي شيء خارج محادثة النص غير موجود، وبعض السلوكيات تأتي من النموذج وليس البروتوكول. اسم النموذج ثابت، وقد تختلف الإجابات في الأسلوب عن أي نموذج استخدمته من قبل، وأخذ العينات باستخدام seed قابل للتكرار فقط طالما يبقى الموجّه والمعاملات كما هي.
قاعدة المحتوى الوحيدة التي لا يمكن تغييرها هي حظر المحتوى الجنسي الذي يتضمن القاصرين. بخلاف ذلك، النموذج مضبوط لتجنب الرفض للاستخدام القانوني للبالغين، ولا تُستخدم الموجّهات للتدريب.
للأكواد في خمس لغات انظر إلى البدء السريع، ولتقنيات الموجّه اقرأ كتابة الموجّهات لنموذج غير مقيّد، ولجانب الحساب، يدرج الأسعار الأسعار: $0.15 لكل مليون رمز إدخال و$0.50 لكل مليون رمز إخراج، مع رصيد لا ينتهي. تحتوي الوثائق على نفس المواصفة في شكل مختصر.
