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

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

عنوان URL الأساسي هو HTTPS://api.ollamaapidocs.com/v1. مرر مفتاحك في رأس المصادقة القياسي.

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

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

أرسل طلبات POST إلى /v1/chat/completions مع تعيين النموذج على غير مقيد.

Copyfrom openai import OpenAI

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

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 json_object لمخرجات JSON صارمة. يمكنك أيضًا ضبط درجة الحرارة (temperature)، وtop_p، وتسلسلات التوقف (stop sequences).

Copyimport OpenAI from "openai";

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

حدود المعدلات والقيود

الحد هو 300 طلب في الدقيقة لكل مفتاح. يدعم كل طلب نافذة سياق تتسع لـ 100,000 رمز.

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

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

التعامل مع أخطاء 401 للمفاتيح غير الصالحة، و402 لعدم وجود رصيد، و429 لحدود معدل الطلبات. يدعم النموذج نافذة سياق بحجم 100,000 رمز.

Copyfrom openai import OpenAI

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