دليل البدء السريع في واجهة برمجة التطبيقات

ثبّت SDK

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

استخدم مدير الحزم المفضل لديك لتثبيت أحدث إصدار. تتولى المكتبة المصادقة والتسلسل تلقائياً.

هذه الخطوة مطلوبة قبل أن تتمكن من إرسال أي طلبات إلى الخادم.

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

وجّه عميلك إلى بوابة API المخصصة لدينا باستخدام عنوان URL الأساسي المقدم. يوجه هذا جميع حركة المرور إلى بنية النموذج غير الخاضع للرقابة لدينا.

قم بتعيين مفتاح API الخاص بك في متغير البيئة أو كائن التكوين. لقد تلقيت هذا المفتاح مباشرة بعد التسجيل عبر Google أو البريد الإلكتروني.

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

تحقق من أن المفتاح يعمل عن طريق التحقق من نقطة نهاية النماذج.

أجرِ أول طلب لك

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

استخدم ال uncensored معرف النموذج لجميع عمليات الإكمال.

يوضح المثال التالي استدعاءً أساسياً لتوليد النص.

Copycurl https://api.aizonderfilter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate python code to parse json"}]
  }'

تحقق من الاستجابة للحصول على النص المولد وإحصائيات استخدام الرموز.

تمكين استجابات التدفق

لتطبيقات زمن الاستجابة المنخفض، قم بتمكين التدفق لتلقي الرموز بمجرد توليدها. يوفر هذا تجربة مستخدم أفضل لواجهات الدردشة.

عيّن معلمة stream إلى true في حمولة الطلب الخاصة بك.

يرسل الخادم أحداث الإرسال من الخادم (SSE) التي تحتوي على إكمالات جزئية.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.aizonderfilter.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 والأدوات

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

عرّف الأدوات في طلبك للسماح للنموذج باستدعاء وظائف خارجية. حدد tool_choice: "auto" للاختيار التلقائي.

Copyimport OpenAI from "openai";

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

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

حدود، أخطاء، والسياق

راقب حدود الاستخدام لتجنب انقطاع الخدمة. يُسمح بـ 300 طلب في الدقيقة و8 طلبات متزامنة لكل مفتاح.

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

التعامل مع أخطاء HTTP الشائعة بشكل مناسب:

• 401 غير مصرح: مفتاح API الخاص بك غير صالح أو مفقود.
• 402 مطلوب الدفع: نفد رصيدك المسبق. قم بالإيداع بالعملات المشفرة للمتابعة.
• 429 Too Many Requests: لقد تجاوزت حد معدل الطلب. انتظر briefly قبل إعادة المحاولة.

لا تستهلك الأخطاء رصيد الرصيد.

التدفق

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)