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

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

قم بتكوين العميل ليشير إلى نقطة النهاية المستضافة لدينا. اضبط base_url إلى https://api.apiollama.com/v1 وإمداد المفتاح في Authorization رأس. تستخدم المصادقة المعيارية Bearer scheme. يمكنك إنشاء مفتاح عبر Google أو البريد الإلكتروني على لوحة التحكم. ينشئ النظام مفتاحاً نشطاً واحداً لكل حساب.

Copycurl https://api.apiollama.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list installed models"}]
  }'

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

POST /v1/chat/completions: إرسال الطلبات

أرسل أول طلب إكمال للدردشة باستخدام النقطة النهائية القياسية. حدد معرف النموذج كـ uncensored في جسم الطلب. تقبل واجهة برمجة التطبيقات مصفوفات الرسائل القياسية التي تحتوي على أدوار النظام والمستخدم والمساعد. يعمل هذا مع أي SDK يدعم تنسيق OpenAI. تأكد من تضمين model field في كل طلب.

Copyfrom openai import OpenAI

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

تُعالج الطلبات عبر خوادمنا. يستجيب النموذج بنص مُولّد بناءً على طلبك. يمكنك ضبط المعلمات مثل temperature أو top_p للتحكم في العشوائية. يعيد النظام كائن استجابة كامل يحتوي على المحتوى المولد.

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

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

Copyimport OpenAI from "openai";

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

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

استجابات البث مع أحداث الإرسال من الخادم

فعّل التدفق عن طريق تعيين stream parameter إلى true. تُعيد الـ API أحداث الإرسال من الخادم (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)

التعامل مع تدفق SSE في كود العميل الخاص بك. قم بمعالجة كل حدث عند وصوله. يحتوي الحدث الأخير على usage كائن مع عدد رموز الإدخال والإخراج. يعمل التدفق مع جميع المعلمات المدعومة. يوفر ملاحظات فورية للتطبيقات التفاعلية.

معلمات التكوين: درجة الحرارة، Top-p، والمزيد

اضبط سلوك التوليد باستخدام المعلمات القياسية. اضبط temperature للعشوائية و top_p للعينة النواة. استخدم stop تسلسلات لإيقاف التوليد مبكراً. الـ seed يضمن المعامل نتائج قابلة للتكرار. يمكنك أيضًا تعيين presence_penalty و frequency_penalty للتحكم في الأسلوب.

وضع JSON متاح عبر response_format. حدد هذا إلى json_object للمخرجات المُهيّأة. يلتزم النموذج بالتنسيق المحدد. تنطبق هذه المعلمات على جميع الطلبات. استخدمها لضبط أسلوب الاستجابة.

معالجة الأخطاء وإعداد استخدام التوكن

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

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