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

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

ابدأ بإنشاء المفتاح الخاص بك على لوحة التحكم. عنوان URL الأساسي لجميع الطلبات هو HTTPS://api.filterno.cc/v1. مرر مفتاحك في رأس المصادقة كرمز حامل. يعمل هذا الإعداد مع أي عميل قياسي متوافق مع OpenAI.

جرّب الاتصال فوراً بطلب إكمال بسيط. تقبل نقطة النهاية تنسيقات المحادثات القياسية وتعيد النص الخام بدون مرشبات المحتوى.

استبدل YOUR_API_KEY بالسلسلة المصدرة لحسابك. يحدد جسم الطلب النموذج ومحتوى الرسالة. تتلقى استجابة تحتوي على النص المولد.

نقطة النهاية: POST /v1/chat/completions

أرسل تلميحاتك إلى POST /v1/chat/completions. هذه نقطة الدردشة الوحيدة التي ندعمها. تقدم تعليمات النظام ورسائل المستخدم بتنسيق المصفوفة.

معرف النموذج هو "uncensored". يعالج إدخال النص ويعيد إخراج النص. لا تتوقع توليد الصور أو الصوت هنا.

عيّن درجة الحرارة للتحكم في العشوائية. تنتج القيم الأعلى مخرجات أكثر إبداعًا. تعطي القيم الأقل نتائج حتمية. تتبع الواجهة بدقة مخطط OpenAI لهذا الطرف.

نقطة النهاية: GET /v1/models

تحقق من النماذج المتاحة بإجراء طلب GET إلى /v1/models. تعيد هذه النقطة قائمة معرفات النماذج المدعومة. يجب أن ترى "uncensored" في الاستجابة.

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

يشمل الرد معرف النموذج ونوع الكائن. لا يدرج الأسعار أو الحدود. تحقق من الوثائق للحصول على معدلات الرموز.

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

تحكّم في تنوع التوليد باستخدام درجة الحرارة وtop_p. تعدل درجة الحرارة توزيع الاحتمالات. تقوم top_p بتصفية الرموز منخفضة الاحتمال. معًا، توازن بين الإبداع والتركيز.

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

عيّن تسلسلات التوقف لإنهاء التوليد مبكرًا. استخدم seed للحصول على نتائج قابلة للتكرار. تقلل عقوبات الحضور والتكرار من التكرار. تتبع هذه المعلمات اتفاقيات OpenAI القياسية.

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

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

يظهر استهلاك الرموز في الشريحة الأخيرة. اقرأها لتتبع التكاليف. يقلل التدفق من زمن الاستجابة المُدرَك للاستجابات الطويلة. وهو مثالي للتطبيقات في الوقت الفعلي.

تحليل بنية بيانات SSE بعناية. تعامل مع انقطاعات الشبكة بسلاسة. يضمن API سلامة البيانات من خلال حدود الشظايا.

حدود، أخطاء، وحساب الرموز

تحصل على 300 طلب في الدقيقة لكل مفتاح. التزامن محدود بـ 8 طلبات متزامنة. الحد الأقصى لحجم جسم الطلب هو 8 ميجابايت.

نوافذ السياق تتسع لـ 100,000 رمز. يشمل ذلك النص الأولي والإكمال. الحد الأقصى للإخراج هو 16,000 رمز. اضبط max_tokens لقياس الاستخدام.

التعامل مع الأخطاء من خلال التحقق من رموز الحالة. يعني 401 مفتاحاً غير صالح. يشير 402 إلى عدم وجود رصيد. يشير 429 إلى حد المعدل. أعد المحاولة باستخدام التخلف الأسي لأخطاء 429.

cURL

Copycurl https://api.filterno.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top five risks in a standard React application."}]
  }'

Python

Copyfrom openai import OpenAI

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