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

البدء السريع لطلبك الأول

ابدأ توليد النصوص فوراً بتوجيه عميلك إلى عنوان URL الأساسي الخاص بنا والمصادقة باستخدام مفتاح واجهة برمجة التطبيقات (API) المولد. يتبع الواجهة الممارسات القياسية، لذا يمكنك استخدام مكتبات (SDKs) الموجودة دون تعلم بروتوكول جديد. ستقوم بإرسال مطالبات إلى uncensored النموذج واحصل على استجابات نصية لا تطبق فلاتر المحتوى المعتادة للاستخدام القانوني للبالغين.

تكوين عنوان URL الأساسي والمفتاح

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

• URL الأساسي: https://api.nsfwlocalllm.com/v1
• رأس المصادقة: Authorization: Bearer YOUR_API_KEY

يمكنك التحقق من أن مفتاحك يعمل عن طريق التحقق من نقاط نهاية النماذج. يعيد المفتاح صالح معرف النموذج المتاح على الفور.

أرسل طلب إكمال محادثة

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

يشمل الرد النص المُولّد وإحصائيات استخدام الرموز. يمكنك تحليل هذا مباشرة في منطق تطبيقك.

Copycurl https://api.nsfwlocalllm.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Send me the server uptime stats"}]
  }'

تحقق من رموز حالة HTTP القياسية للتعامل مع حالات النجاح أو الفشل.

فعّل التدفق للمخرجات في الوقت الفعلي

تدفق الاستجابات لتقليل زمن الاستجابة المُدرَك للمستخدمين. فعّل التدفق عن طريق تعيين stream: true في جسم الطلب الخاص بك. تُعيد الواجهة البرمجية (API) سلسلة من أحداث الإرسال من الخادم (SSE) تحتوي على رموز جزئية.

اجمع هذه الرموز على جانب العميل لإعادة بناء الرسالة الكاملة. هذا النهج مثالي لواجهات الدردشة حيث يهم التغذية الراجعة الفورية. يحتوي حدث SSE الأخير على إجمالي استخدام الرموز للطلب.

Copyfrom openai import OpenAI

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

التعامل مع أخطاء الاتصال بسلاسة لضمان تجربة مستخدم سلسة.

استخدم وضع JSON للبيانات المهيكلة

فرض النموذج على إخراج JSON صالح للاستهلاك البرمجي. اضبط response_format إلى {"type": "json_object"} في طلبك. يقلل هذا من أخطاء التحليل ويضمن هياكل بيانات متسقة.

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

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.nsfwlocalllm.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 من جانبك للكشف عن أي حالات حافة.

تطبيق استدعاء الوظائف

عرّف الأدوات لتوسيع قدرات النموذج. مرر tools مصفوفة مع تعريفات الدوال إلى الطلب. يمكن للنموذج اختيار استدعاء هذه الدوال بناءً على السياق.

هذا يمكّن من سير عمل معقد حيث يقرر النموذج اللغوي الكبير (LLLM) متى يجلب البيانات أو ينفذ إجراءات. تتلقى حجج الوظيفة في الاستجابة وتنفذها من جانبك. أعد النتائج إلى النموذج لمزيد من الاستدلال.

تعيين tool_choice إلى auto للاتخاذ المرن للقرارات. تدعم هذه الميزة سيناريوهات لعب الأدوار المتقدمة التي تتطلب الوصول إلى بيانات خارجية.

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)