واجهة برمجة التطبيقات التوثيق

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

تعيش واجهة برمجة التطبيقات عند https://api.ollamaapidoc.com/v1. تقوم بالمصادقة باستخدام رمز حامل في Authorization رأس. أنشئ مفتاحك فوراً عبر Google أو البريد الإلكتروني في لوحة التحكم. لا يلزم رقم هاتف. يعمل المفتاح مع واجهات برمجة التطبيقات (SDKs) القياسية لـ OpenAI عن طريق ضبط عنوان URL الأساسي.

طلبك الأول

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

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

يُرجع التنسيق القياسي لـ OpenAI. تُرجع الأخطاء أكواد HTTP المناسبة. تحقق من الجسم لـ error التفاصيل إذا فشل شيء ما. تستخدم استجابات التدفق أحداث الإرسال من الخادم (SSE).

تكامل واجهة برمجة تطبيقات Python

ثبّت الحزمة الرسمية من OpenAI. قم بتكوين العميل بعنوان URL الأساسي ومفتاح API الخاص بك. استدعِ نقطة نهاية إكمال المحادثة. يبقى الكود متطابقًا مع الاستخدام القياسي لـ OpenAI. يضمن ذلك سهولة الترحيل للمشاريع الحالية. يمكنك تعديل معلمات مثل درجة الحرارة و top_p مباشرة في الاستدعاء.

Copyfrom openai import OpenAI

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

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

إعداد SDK Node.js

استخدم ال openai npm package. Initialize the client with the custom base URL. Pass your API key. The syntax mirrors the Python example. This consistency reduces debugging time. You can send multiple messages in a conversation history array.

Copyimport OpenAI from "openai";

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

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

وضع JSON والبث

فعّل التدفق عن طريق تعيين stream parameter إلى true. ترسل الـ API الرموز عبر أحداث الإرسال من الخادم. تتلقى استجابات جزئية في الوقت الفعلي. يحسن هذا تجربة المستخدم للمخرجات الطويلة. يمكنك أيضًا فرض إخراج JSON باستخدام response_format. هذا مفيد لاستخراج البيانات المهيكلة.

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)

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

حدود، أخطاء، والسياق

نافذة السياق هي 100,000 رمز. الحد الأقصى للإخراج هو 16,000 رمز لكل طلب. تشمل الأخطاء 401 للمفاتيح غير الصالحة و402 لعدم كفاية الرصيد. حدود معدل الطلب تصل إلى 300 طلب في الدقيقة. تعامل مع هذه بسلاسة في تطبيقك. لا تستخدم API نصوصك للتدريب. الخصوصية محفوظة. الرصيد لا ينتهي.