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

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

استخدم عنوان URL الأساسي الخاص بنا ومفتاح API واحد للاتصال. تقبل نقطة النهاية الرؤوس القياسية. استبدل YOUR_API_KEY بالسلسلة من لوحة التحكم الخاصة بك.

• URL الأساسي: https://api.ollamaopenaicompatibleapi.com/v1
• معرف النموذج: uncensored

المصادقة تعتمد على رمز حامل. مرره في Authorization الرأس. يضمن هذا التوافق مع أي عميل متوافق مع مكتبة SDK لـ OpenAI. يمكنك إنشاء مفتاح جديد فورًا عبر Google أو البريد الإلكتروني. لا يتطلب رقم هاتف.

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

أرسل طلب POST إلى /v1/chat/completions. قم بتضمين مصفوفة الرسائل واسم النموذج. يُرجع الـ API نصاً مبنياً على مطالبتك. يعمل هذا مع أي مزود يستخدم المعلمات القياسية.

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

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

Copycurl https://api.ollamaopenaicompatibleapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 10 Linux kernel security patches from 2023"}]
  }'

استجابات البث عبر SSE

فعّل البث عن طريق تعيين stream: true. يرسل الخادم أجزاء كما يتم توليدها. يقلل هذا من زمن الاستجابة المُدرَك بشكل كبير. تتلقى استجابات جزئية في الوقت الفعلي.

قم بتحليل تدفق أحداث الإرسال الخادم (SSE). تحتوي الشريحة الأخيرة على إحصائيات الاستخدام. يتضمن ذلك عدادات الرموز المميزة لكل من الإدخال والإخراج. يمكنك تتبع التكاليف ديناميكيًا أثناء التوليد.

يعمل هذا الأسلوب بشكل جيد لواجهات الدردشة. يرى المستخدمون النص يظهر كلمة بكلمة. يبدو أكثر استجابة من انتظار الرد الكامل. تتعامل واجهة برمجة التطبيقات مع استقرار الاتصال تلقائياً.

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

عرّف الأدوات في جسم الطلب. يمكن للنموذج إخراج بيانات مهيكلة. استخدم response_format مع {"type": "json_object"} لـ JSON الصارم. يضمن هذا مخرجات قابلة للتحليل في كل مرة.

تتضمن تعريفات الأدوات الاسم والوصف والمعلمات. يقرر النموذج أي أداة يجب استدعاؤها. تنفذ الدالة وتغذي النتائج مرة أخرى. هذا يمكّن من سير عمل الوكلاء المعقدة.

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

Copyfrom openai import OpenAI

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

حدود المعدلات وجسم الطلب

تحصل على 300 طلب في الدقيقة لكل مفتاح. التزامن محدود بـ 8 طلبات متزامنة. الحد الأقصى لحجم جسم الطلب هو 8 ميجابايت. يناسب هذا معظم التطبيقات التي تعتمد على النصوص.

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

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

Copyimport OpenAI from "openai";

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

أخطاء المصادقة وحدودها

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

تدل حالة 429 على تحديد معدل الطلبات. لقد تجاوزت 300 طلب في الدقيقة. قلل من معدل الإرسال أو قم بترقية مفتاحك. تُرجع واجهة برمجة التطبيقات رسائل خطأ واضحة.

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