توثيق KiApi: التكامل في 5 دقائق

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

تتوافق KiApi تمامًا مع واجهة برمجة التطبيقات OpenAI. يمكنك استخدام النظام البيئي الحالي من أدوات SDK والعملاء عن طريق تعديل base_url. عنوان URL الأساسي لجميع الطلبات هو https://api.kiapis.com/v1. يتم المصادقة حصريًا باستخدام مفتاح API، والذي تحصل عليه بعد التسجيل في لوحة التحكم الخاصة بك. يجب إرسال هذا المفتاح في رأس HTTP Authorization: Bearer <IHR_API_SCHLÜSSEL>. يمكنك إنشاء مفتاح جديد في أي وقت، مما يجعل المفتاح القديم غير صالح.

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

POST /v1/chat/completions: توليد النص

الجزء الأساسي من واجهة برمجة التطبيقات هو نقطة النهاية POST /v1/chat/completions. هنا ترسل قائمة بالرسائل (النظام، المستخدم، المساعد) وتتلقى استجابة نصية. يجب ضبط معلمة معرف النموذج على uncensored. الاستجابة متزامنة وتحتوي فورًا على جزء النص المولد وبيانات تعريف حول استخدام الرموز.

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

Kopierencurl https://api.kiapis.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

تحتوي الاستجابة على كائن JSON بالمحتوى المولد. تأكد من استخراج منطقة content من الاستجابة لاستخدامها في تطبيقك. لا يتم إرجاع بيانات تعريفية إضافية مثل التكلفة لكل طلب في الاستجابة القياسية، يمكنك العثور عليها في لوحة التحكم.

البث باستخدام أحداث الإرسال من الخادم (SSE)

لتطبيقات التي تحتاج إلى إخراج فوري، تدعم KiApi البث عبر أحداث الإرسال من الخادم (SSE). قم بتمكين ذلك عن طريق تعيين "stream": true في جسم الطلب. بدلاً من انتظار استجابة كاملة، تحصل على تدفق من التصحيحات JSON التي تحتوي تدريجيًا على النص المولد.

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

Kopierenstream = 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)

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

استدعاء الأدوات واستدعاء الدوال

يدعم النموذج استدعاء الأدوات، المعروف أيضًا باسم استدعاء الدوال. هذا يسمح لـ LLM بإرجاع بيانات JSON هيكلية تمثل وظائف أو إجراءات محددة في تطبيقك. تحدد الأدوات المتاحة في جسم الطلب، ويقرر النموذج بناءً على إدخال المستخدم متى يجب استدعاء أداة.

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

Kopierenfrom openai import OpenAI

client = OpenAI(base_url="https://api.kiapis.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. لا تحتاج إلى استخدام برامج تحليل خارجية للاستجابة لأن الهيكل يأتي مباشرة من النموذج. هذا يجعل التكامل مع الأنظمة القائمة أسهل وأكثر موثوقية.

GET /v1/models: النماذج المتاحة

تقوم نقطة النهاية GET /v1/models بسرد النماذج المتاحة التي يمكن الوصول إليها عبر واجهة برمجة التطبيقات. هذا مفيد للتحقق ديناميكيًا من النماذج المتاحة أو لتأكيد معرف النموذج. عادةً ما تحصل على قائمة تحتوي على النموذج uncensored.

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

Kopierenimport OpenAI from "openai";

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

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

حدود المعدل ورموز الخطأ

لضمان استقرار الخدمة، تنطبق حدود معينة. يُسمح بـ 300 طلب في الدقيقة لكل مفتاح API. يبلغ حجم جسم الطلب الأقصى 8 ميجابايت. إذا تجاوزت هذه الحدود، ستحصل على رمز حالة HTTP 429 Too Many Requests. خطط لتطبيقك لتنفيذ محاولات إعادة مع زيادة عكسية.

رموز الخطأ الشائعة الأخرى هي 401 Unauthorized عندما يكون مفتاح API غير صالح، و 402 Payment Required عندما ينفد رصيدك. تستخدم KiApi نموذج الدفع المسبق، لذا يتم رفض الطلبات بدون رصيد على الفور. تأكد من مراجعة أرصدة حسابك بانتظام.

تبلغ نافذة السياق 100,000 رمز للإدخال والإخراج معًا. إذا تجاوزت هذا الحد، يتم إرجاع رسالة خطأ. KiApi هي حل موثوق للمطورين الذين يقدرون القواعد الواضحة والحدود الشفافة.