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

التثبيت والإعداد

The codex api يتطلب مفتاحًا صالحًا وعنوان URL الأساسي الصحيح. اشترك عبر Google أو البريد الإلكتروني للحصول على مفتاحك على الفور. لا حاجة إلى رقم هاتف. استخدم مكتبات SDK الرسمية لـ OpenAI عن طريق تعيين base_url إلى https://api.codexfiyat.com/v1.

تعتمد المصادقة على المعيار Authorization: Bearer رأس. يحتوي كل حساب على مفتاح نشط واحد. يؤدي إنشاء مفتاح جديد إلى إلغاء سريان المفتاح السابق فوراً. هذا يبسط الدوران دون إدارة بيانات اعتماد متعددة.

Temel Istek Ornegi

أرسل طلب إكمال إلى uncensored باستخدام أي عميل HTTP. تقبل نقطة النهاية المعايير القياسية مثل temperature و top_p. قم بتكوين عميلك للتعامل مع استجابات JSON بكفاءة.

• حدد النموذج إلى uncensored.
• أدرج مطالبة النظام الخاصة بك للسياق.
• عرّف رسائل المستخدم في messages مصفوفة.

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

بث Yanitlar

فعّل البث عن طريق تعيين stream: true في طلبك. يعيد الواجهة البرمجية أحداث الإرسال من الخادم (SSE) لتسليم الرموات في الوقت الفعلي. قم بتحليل كل شريحة لعرض النص تدريجياً للمستخدمين الخاصين بك.

يقلل هذا الأسلوب من زمن الاستجابة المُدرَك بشكل كبير. تظهر الردود الكبيرة فوراً بمجرد توليدها. تتضمن الشريحة الأخيرة إجمالي استخدام الرموز للفوترة الدقيقة.

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

عرّف الدوال في tools معامل لتمكين استدعاء الأدوات. يعيد النموذج استدعاءات الوظائف بتنسيق JSON هيكلي. استخدم tool_choice: auto للاكتشاف التلقائي.

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

وضع JSON

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

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

الحدود والقيود

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

الحد الأقصى للإخراج هو 16,000 رمز مميز لكل طلب. إذا max_tokens غير مضبوط، ينخفض الحد إلى 2,048. تُرجع الطلبات التي تتجاوز حد حجم الجسم البالغ 8 ميجابايت خطأ. راقب استخدامك عبر لوحة التحكم لتجنب الانقطاعات.

cURL

Copycurl https://api.codexfiyat.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list available server configurations for ubuntu"}]
  }'

Python

Copyfrom openai import OpenAI

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