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

المصادقة

يصادق مفتاح API الخاص بك على جميع الطلبات الموجهة إلى الخادم. مرره في Authorization رأس الصفحة كرمز حامل (Bearer token). سجل عبر Google أو البريد الإلكتروني للحصول على مفتاحك على الفور. تحصل على $0.50 كرصيد تجريبي صالح لمدة 7 أيام. احتفظ بمفتاحك بأمان. مفتاح نشط واحد لكل حساب. استبداله يلغي المفتاح القديم على الفور.

الطلب الأول

أرسل طلب POST إلى نقطة نهاية إكمال الدردشة. استخدم معرف النموذج "uncensored" لنموذجنا المحدد. عنوان URL الأساسي هو https://api.llamansfw.com/v1. يعمل مع أي مكتلة SDK قياسية لـ OpenAI. استبدل YOUR_API_KEY مع المفتاح الفعلي الخاص بك. يتضمن جسم الطلب رسائل مع الأدوار والمحتوى.

تكامل Python

قم بتهيئة عميل OpenAI بعنوان URL الأساسي الخاص بنا. اضبط مفتاح API في البيئة أو في المنشئ. استدعِ chat.completions.create() باستخدام النموذج والرسائل. هذا يعيد كائن إكمال. تعامل مع الاستجابة لاستخراج النص المُولّد. يحافظ هذا النهج على توافق الكود الخاص بك مع أنماط OpenAI القياسية. اضبط درجة الحرارة للحصول على تنوعات إبداعية.

تكامل Node.js

استيراد حزمة OpenAI. قم بتكوين عنوان URL الأساسي لنقطة النهاية الخاصة بنا. مرر مفتاح API الخاص بك. أنشئ إكمالًا بالمعلمات المرغوبة. يتعامل العميل مع طلب HTTP تلقائيًا. قم بتحليل الاستجابة للحصول على رسالة المساعد. تعمل هذه الطريقة بسلاسة مع تطبيقات Node.js الموجودة. يمكنك تعيين التدفق على false للاستجابات القياسية.

استجابات البث

فعّل البث عن طريق تعيين stream إلى true. تُعيد الواجهة البرمجية (API) أجزاء من النص كما يتم توليدها. يقلل هذا من زمن الاستجابة المُدرَك للاستجابات الطويلة. يمكنك عرض النص للمستخدمين في الوقت الفعلي. يحتوي الجزء الأخير على إحصائيات استخدام الرموز (Tokens). تعمل هذه الميزة مع كل من مكتبات SDK الخاصة بـ Python و Node. إنها مثالية لواجهات الدردشة التي تتطلب تغذية راجعة فورية.

الحدود والأخطاء

تدعم نافذة السياق إجمالي 100,000 رمز موزع. يمكنك إرسال ما يصل إلى 16,000 رمز لكل طلب. تُرجع الأخطاء أكواد HTTP القياسية. يشير 401 إلى مفتاح غير صالح أو مفقود. يعني 402 استنفاد رصيدك المدفوع مسبقًا. يشير 429 إلى تجاوزك لحد معدل الطلب البالغ 300 طلب في الدقيقة. رصيدك المدفوع مسبقًا لا ينتهي صلاحيته. الأخطاء لا تستهلك الرموز. الرفض مجاني أيضًا.

cURL

Copycurl https://api.llamansfw.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the max context window size?"}]
  }'

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

التدفق

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)