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

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

المصادقة على كل طلب عن طريق تمرير مفتاح API الخاص بك في Authorization الرأس. عنوان URL الأساسي لجميع نقاط النهاية هو https://api.notfilter.cc/v1. يضمن هذا الهيكل التوافق مع مكتلات SDK الخاصة بـ OpenAI الحالية دون تغييرات تكوين معقدة.

Copycurl https://api.notfilter.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "what is the capital of france"}]
  }'

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

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

أرسل مطالبات نصية واحصل على استجابات عبر /v1/chat/completions endpoint. هذه واجهتك الأساسية للتفاعل مع النموذج. قم بتكوين معلمات مثل temperature و top_p لضبط سلوك الاستجابة.

Copyfrom openai import OpenAI

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

تتوقع واجهة برمجة التطبيقات تنسيق رسائل قياسي. يتم تحويل النص المدخل إلى رموز، ومعالجته، وإعادته كاستجابة متماسكة. يتم التعامل مع الأخطاء عبر رموز حالة HTTP القياسية.

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

تمكين المخرجات في الوقت الفعلي عن طريق ضبط stream: true. تُعيد الـ API أجزاء بيانات أثناء توليدها. يقلل هذا من زمن الاستجابة المُدرَك للاستجابات الطويلة.

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)

يحتوي كل جزء على محتوى جزئي. يتضمن الجزء الأخير إحصائيات استخدام الرموز. قم بتحليل هذه الأحداث لعرض النص تدريجيًا للمستخدمين الخاصين بك.

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

عرّف الأدوات للسماح للنموذج باستدعاء دوال خارجية. حدد تعريفات الأدوات في جسم الطلب. يُعيد النموذج حججاً مُهيكلة عندما يكون استدعاء الدالة مناسباً.

Copyimport OpenAI from "openai";

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

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

وضع JSON

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

النموذج يلتزم بالمخطط الذي تقدمه. أخطاء هيكل JSON نادرة لكنها ممكنة. تحقق من المخرجات في طبقة التطبيق الخاص بك للأمان.

حدود المعدلات ونافذة السياق

يدعم كل مفتاح API 300 طلب في الدقيقة و8 طلبات متزامنة. نافذة السياق هي 100,000 رمز لكل من النص الأولي والإكمال معًا. الحد الأقصى للإخراج هو 16,000 رمز.

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