عنوان URL الأساسي والمصادقة
تواصل مع واجهة برمجة التطبيقات باستخدام عنوان URL الأساسي المقدم ومفتاح رمز مميز مسبق الدفع. تتم المصادقة عن طريق تمرير مفتاح واجهة برمجة التطبيقات الخاص بك في رأس الطلب، مما يضمن وصول حسابك فقط إلى رصيدك. سجّل الدخول عبر Google أو البريد الإلكتروني للحصول على مفتاحك فورًا دون الحاجة إلى التحقق من الهاتف.
curl https://api.kimicodeapi.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 rate limit for free tier users?"}]
}'تستهدف طلباتك نقطة النهاية القياسية المتوافقة مع OpenAI. يسمح هذا التصميم لك باستبدال خدمتنا دون إعادة كتابة كود العميل الحالي، بشرط تحديث عنوان URL الأساسي والبيانات الاعتمادية.
نقطة نهاية إكمال الدردشة
أرسل الرسائل إلى النموذج باستخدام POST /v1/chat/completions نقطة النهاية. يجب أن تحدد معرف النموذج كـ uncensored للوصول إلى نموذج اللغة الكبير المحسن الذي يعمل على خوادمنا. يقبل النظام أدوار الرسائل القياسية مثل المستخدم أو المساعد للمحادثات متعددة الأدوار.
from openai import OpenAI
client = OpenAI(base_url="https://api.kimicodeapi.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)تتعامل هذه نقطة النهاية مع مدخلات النص وتعيد النص المولد. لا تدعم التضمينات أو الصور أو الصوت. ركز على هيكل طلبك للحصول على أفضل النتائج من النموذج غير الخاضع للرقابة.
استجابات البث (SSE)
فعّل تسليم الرمز الفوري عن طريق تعيين المعلمة stream إلى true في الطلب. تُعيد واجهة البرمجة تطبيقات (API) شرائح أحداث الإرسال من الخادم (SSE)، مما يتيح لتطبيقك عرض النص أثناء توليده. تحتوي الشريحة الأخيرة على إحصائيات استخدام الرمز الكاملة للفوترة.
stream = 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)يقلل التدفق من زمن الاستجابة المُدرَك للمستخدمين النهائيين. يمكنك معالجة كل رمز عند وصوله، وهو أمر مثالي لواجهات الدردشة. تذكر أن التدفق لا يغير سلوك النموذج الأساسي أو تسعير الرموز.
استدعاء الوظائف والأدوات
عرّف الأدوات في طلبك للسماح للنموذج بإرجاع استدعاءات وظائف مهيكلة. تدعم واجهة برمجة التطبيقات (API) معاملات خيار الأداة (tool_choice)، مما يتيح لك إجبار النموذج على استخدام أداة محددة أو تركه يقرر بشكل مستقل. تعمل هذه الميزة مع تنسيقات الأدوات القياسية من OpenAI، مما يجعل التكامل مباشرًا.
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.kimicodeapi.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);استخدم استدعاء الوظائف لاستخراج البيانات أو تشغيل الإجراءات في تطبيقاتك. يفسر النموذج تعريفات الأدوات ويعيد كائنات JSON تحتوي على المعاملات اللازمة. تمتد هذه القدرة بواجهة برمجة التطبيقات بما يتجاوز توليد النص البسيط.
وضع JSON والمعاملات
فرض إخراج JSON صارم عن طريق تعيين response_format إلى {"type": "json_object"}. يضمن ذلك أن يُعيد النموذج بيانات JSON، وهو أمر حاسم للتحليل البرمجي. يمكنك أيضًا ضبط معاملات مثل درجة الحرارة و top_p وتسلسلات التوقف للتحكم في الإبداع وطول المخرجات.
يدعم النموذج نافذة سياق بحجم 100,000 رمز. هذا يتيح لك تمرير كميات كبيرة من السياق في طلب واحد. الحد الأقصى للإخراج هو 16,000 رمز لكل طلب، أو 2,048 إذا لم تحدد max_tokens.
حدود، أخطاء، والسياق
راقب حدود طلباتك لتجنب انقطاع الخدمة. يسمح الـ API بـ 300 طلب في الدقيقة لكل مفتاح و8 طلبات متزامنة كحد أقصى. يجب أن يبقى جسم طلبك أقل من 8 MB. إذا تجاوزت هذه الحدود، ستتلقى خطأ حد المعدل 429.
يعيد فشل المصادقة خطأ 401 إذا كان المفتاح غير صالح. يشير خطأ 402 إلى عدم كفاية الرصيد المدفوع مسبقاً. لا تستهلك الأخطاء أثناء التوليد الرموز الخاصة بك. تشمل نافذة السياق كل من رموز المطالبة والإكمال. الرصيد غير المستعمل لا ينتهي صلاحيته، مما يضمن بقاء رصيدك المدفوع مسبقاً متاحاً للمشاريع المستقبلية.
