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

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

أرسل أول رسالة إلى النموذج غير المقيد (uncensored) فوراً. استخدم نقطة النهاية القياسية لإكمال الدردشة (chat-completions) لتوليد النص. يستجيب النموذج لموجهات اللغة الطبيعية دون رفض المحتوى للاستخدام القانوني للبالغين. يعمل هذا الإعداد مع أي عميل متوافق مع OpenAI.

ابدأ بتثبيت SDK للغتك المفضلة. ثم قم بتكوين مفتاح API الخاص بك. يوضح المثال التالي طلب curl أساسي لاختبار الاتصال.

يمكنك تعديل معلمات مثل درجة الحرارة للتحكم في العشوائية. تُرجع الاستجابة النص المولد مباشرة. يتيح لك هذا التدفق البسيط التحقق من عمل واجهة البرمجة (API) قبل بناء منطق معقد.

Copycurl https://api.apiaicharacter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the current API rate limit status?"}]
  }'

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

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

أنشئ مفتاحك عبر لوحة التحكم. مرره في رأس المصادقة (Authorization header) كرمز حامل (Bearer token). هذه الطريقة متوافقة مع أدوات SDK القياسية لـ OpenAI. يمكنك تبديل مقدمي الخدمة عن طريق تغيير عنوان URL الأساسي والمفتاح فقط.

حافظ على أمان مفتاحك. يمنحك الوصول الكامل إلى رصيدك المدفوع مسبقًا. يستبدل المفتاح أي مفتاح نشط سابق على الفور عند إنشائه.

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

تفاعل مع النموذج عبر نقطة نهاية إكمال المحادثات. هذه هي نقطة توليد النص الوحيدة المتاحة. تقبل الرسائل وتعيد النص المولد. لا تدعم التضميمات (embeddings) أو الصور أو الصوت.

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

يدعم استدعاء الوظائف أيضًا. عرّف الأدوات واترك للنموذج أن يقرر متى يستخدمها. يتيح هذا المرونة سير عمل الوكلاء المعقدة. يتضمن الرد المحتوى المُنشأ واستخدام الرموز.

Copyfrom openai import OpenAI

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

المعاملات: درجة الحرارة، Top P، و Stop

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

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

تتيح لك معلمة البذرة (seed) الحصول على نتائج قابلة للتكرار. استخدمها عند تصحيح أخطاء المطالبات (prompts). تمنحك هذه المعلمات تحكماً دقيقاً في سلوك النموذج. قم بضبطها لتتوافق مع احتياجات تطبيقك.

Copyimport OpenAI from "openai";

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

حدود المعدلات والقيود

فهم الحدود لتجنب انقطاع الخدمة. يمكنك إجراء 300 طلب في الدقيقة لكل مفتاح. يتم تقييد الطلبات المتزامنة في ثمانية في وقت واحد. يجب ألا يتجاوز جسم الطلب 8 ميجابايت.

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

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