توثيق واجهة برمجة التطبيقات: نقاط نهاية متوافقة مع OpenAI

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

تصفح واجهة API عن طريق تعيين مفتاحك الفريد وعنوان URL الأساسي في متغيرات البيئة الخاصة بك. تقع نقطة النهاية على https://api.apikeykimi.com/v1. يجب أن تتضمن الرأس Authorization: Bearer YOUR_API_KEY مع كل طلب. يتم إنشاء هذا المفتاح فورًا عند التسجيل عبر Google أو البريد الإلكتروني. إنه الاعتماد الوحيد المطلوب للمصادقة. لا حاجة لتكوين نطاقات أو أذونات.

Copycurl https://api.apikeykimi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "convert this json object to python dictionary syntax"}]
  }'

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

أرسل الرسائل إلى النموذج باستخدام الواجهة /v1/chat/completions النقطة النهائية. حدد معرف النموذج كـ uncensored في جسم الطلب. تعيد واجهة برمجة التطبيقات نصًا مُولّدًا بناءً على سجل المطالبات الخاص بك. يمكنك ضبط معلمات مثل درجة الحرارة و top_p للتحكم في الإبداع. يدعم النموذج استدعاء الوظائف ووضع JSON للمخرجات المهيكلة.

Copyfrom openai import OpenAI

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

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)

استدعاء الوظائف ووضع JSON

عرّف الأدوات أو فرض إخراج JSON باستخدام response_format معامل. اضبط json_object لضمان استجابات JSON صالحة. يمكنك أيضًا تمرير تعريفات الأدوات لاستدعاء الوظائف. يلتزم النموذج بهذه القيود بدقة. يتيح ذلك تكاملًا موثوقًا مع الخدمات الخارجية. استخدم tool_choice للتحكم في كيفية استدعاء الأدوات.

حدود الرموز & القيود

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

معالجة الأخطاء & حدود الاستخدام

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

Node.js

Copyimport OpenAI from "openai";

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