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

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

عنوان URL الأساسي لجميع الطلبات هو https://api.ollamaapidocumentation.com/v1. تقوم بالمصادقة باستخدام رمز حامل مُمرَّر في Authorization رأس الصفحة. يتم إنشاء مفتاحك على لوحة التحكم ويعمل فوراً.

• استخدم مكتبات OpenAI الرسمية أو أي عميل متوافق.
• اضبط عنوان URL الأساسي إلى القيمة أعلاه.
• أدرج مفتاح API الخاص بك في الرأس.

المصادقة صارمة. إذا كان المفتاح مفقوداً أو غير صالح، تُرجع API خطأ 401. هذا يضمن تتبع استخدامك بدقة للفوترة.

نقطة نهاية إكمال الدردشة: POST /v1/chat/completions

أرسل الرسائل إلى POST /v1/chat/completions. تقبل نقطة النهاية جسم JSON مع model field مضبوطًا على "uncensored" و messages مصفوفة.

تتعامل هذه نقطة النهاية مع توليد النصوص. لا تدعم الصور أو الصوت أو الفيديو. يمكنك تدفق الاستجابات أو انتظار النتيجة الكاملة.

أخطاء مثل 402 تشير إلى عدم كفاية الرصيد. تُ charged الطلبات حسب استخدام الرموز الفعلي. الرفض بسبب الرصيد مجاني.

سرد النماذج: GET /v1/models

استرجع النماذج المتاحة باستخدام GET /v1/models. يعيد هذا قائمة من كائنات النماذج. معرف النموذج المتاح الوحيد هو "uncensored".

تساعد هذه نقطة النهاية في التحقق من الاتصال. تؤكد أن عنوان URL الأساسي صحيح. كما تعرض اسم النموذج ونوع الكائن.

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

المعلمات: درجة الحرارة وTop P والبذلة

تحكّم في التوليد باستخدام temperature, top_p، و seed. الـ seed يضمن مخرجات حتمية. استخدمه لاكتشاف الأخطاء أو للحصول على نتائج متسقة.

تعيين temperature بين 0 و2. تجعل القيم الأقل الاستجابات أكثر قابلية للتنبؤ. تزيد القيم الأعلى من العشوائية. ال top_p المعامل يفلتر الرموز المميزة بناءً على الاحتمال التراكمي.

تعمل هذه المعلمات تمامًا مثل واجهة برمجة تطبيقات OpenAI. يمكنك دمجها للتحكم الدقيق في النمط.

استجابات البث واستهلاك الرموز

فعّل البث عن طريق تعيين stream: true. يعيد API أحداث الإرسال عبر الخادم (SSE). تحتوي كل قطعة على نص جزئي.

تتضمن الشريحة النهائية إحصائيات استخدام الرموز الشاردية. يتيح لك ذلك حساب التكاليف بدقة. يمكنك معالجة الرموز الشاردية مع وصولها.

يقلل البث من زمن الاستجابة المُدرَك. وهو مثالي لواجهات الدردشة. يدفع الخادم البيانات حتى اكتمال الاستجابة.

حدود، أخطاء، ونافذة السياق

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

حدود معدل الطلبات هي 300 طلب في الدقيقة. يمكنك إجراء 8 طلبات متزامنة. حجم جسم الطلب محدود بـ 8 ميجابايت.

تشمل الأخطاء 401 للمفاتيح غير الصالحة و429 لحدود معدل الطلب. إخطاء الرصيد تعيد 402. هذه الأخطاء واضحة وقابلة للتنفيذ.

cURL

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

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

التدفق

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)