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

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

أرسل طلباتك إلى عنوان URL الأساسي الخاص بنا مع مفتاح API صالح في الرأس.

• URL الأساسي: https://api.unlockedaimodels.com/v1
• رأس: Authorization: Bearer YOUR_API_KEY

معرف النموذج هو ببساطة uncensored. تحصل على مفتاح نشط واحد لكل حساب، والذي يستبدل أي مفتاح سابق عند إنشائه.

Copycurl https://api.unlockedaimodels.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate the standard HTTP headers for a POST request."}]
  }'

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

The POST /v1/chat/completions نقطة النهاية تعالج نصك وتعيد الاكتمال.

هذا هو نقطة النهاية النصية الوحيدة التي نقدمها. نحن لا نقدم توليد الصور، أو الصوت، أو التضمين. يقبل النموذج مصفوفة رسائل قياسية تحتوي على أدوار النظام، والمستخدم، والمساعد.

أخطاء مثل 401 تشير إلى مفتاح غير صالح، بينما 402 تعني أنك بحاجة إلى المزيد من الرصيد. تُ charged الطلبات فقط عند توليد الرموز.

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

فعّل البث عن طريق تعيين stream: true في جسم الطلب الخاص بك.

يحتوي كل جزء على نص جزئي، مما يتيح لك إخراج المخرجات في الوقت الفعلي. يتضمن الجزء الأخير إحصائيات استخدام الرموز الكاملة لشفافية الفوترة.

تقلل هذه الطريقة من زمن الاستجابة المُدرَك للاستجابات الطويلة، وهو أمر حاسم عند توليد أكثر من 16,000 رمز.

Copyfrom openai import OpenAI

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

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

عرّف الأدوات في طلبك لتمكين استدعاء الوظائف المهيكلة.

يدعم النموذج tool_choice المعلمات، مما يتيح لك فرض سلوكيات محددة أو ترك النموذج يقرر. هذا مفيد لبناء وكلاء يحتاجون إلى التفاعل مع الأنظمة الخارجية دون كسر السياق غير الخاضع للرقابة.

تأكد من أن تعريفات الأدوات الخاصة بك تتبع مخطط OpenAI للتوافق.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.unlockedaimodels.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 والمخرجات المهيكلة

فرض النموذج على إرجاع JSON صالح عن طريق تعيين response_format: {"type": "json_object"}.

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

بالاقتران مع استدعاء الوظائف، يخلق خط أنابيب قوياً للمهام الآلية دون طبقات تحقق خارجية.

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

تحكم في الإبداع باستخدام temperature والتنوع مع top_p.

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

حدود المعدلات هي 300 طلب في الدقيقة و8 طلبات متزامنة لكل مفتاح.