مستندات API Ollama: مرجع نقطه پایانی

URL پایه و احراز هویت

آدرس پایه برای تمام درخواست‌ها https://api.ollamaapidocumentation.com/v1. شما با یک توکن bearer ارسال‌شده در Authorization header. کلید شما در داشبورد ایجاد می‌شود و بلافاصله کار می‌کند.

• از SDKهای رسمی OpenAI یا هر کلاینت سازگاری استفاده کنید.
• آدرس پایه را به مقدار بالا تنظیم کنید.
• کلید API خود را در هدر قرار دهید.

احراز هویت سخت‌گیرانه است. اگر کلید ناموجود یا نامعتبر باشد، API خطای 401 را برمی‌گرداند. این اطمینان حاصل می‌کند که استفاده شما برای صورت‌حساب‌دهی به دقت ردیابی می‌شود.

نقطه پایانی تکمیل چت: POST /v1/chat/completions

پیام‌ها را به مدل از طریق POST /v1/chat/completions. نقطه پایانی یک بدنه JSON با model field set to "uncensored" and a messages آرایه.

این اندپوینت، تولید متن را مدیریت می‌کند. از تصاویر، صدا یا ویدیو پشتیبانی نمی‌کند. می‌توانید پاسخ‌ها را streaming کنید یا منتظر نتیجه کامل بمانید.

خطاهایی مانند ۴۰۲ نشان‌دهنده اعتبار ناکافی است. درخواست‌ها بر اساس مصرف واقعی توکن‌ها هزینه‌بر هستند. رد درخواست‌ها به دلیل کمبود اعتبار رایگان است.

فهرست‌بندی مدل: GET /v1/models

مدل‌های موجود را با استفاده از GET /v1/models. این یک لیست از اشیاء مدل برمی‌گرداند. تنها ID مدل موجود "uncensored" است.

این اندپوینت به بررسی اتصال کمک می‌کند. تأیید می‌کند که آدرس پایه صحیح است. همچنین نام مدل و نوع شیء را نشان می‌دهد.

از این روش برای رفع اشکال مشکلات اتصال پیش از ارسال payloadهای سنگین استفاده کنید.

پارامترها: دما، Top P و Seed

تولید را با کنترل کنید temperature, top_p، و seedThe seed پارامتر خروجی‌های قطعی را فراهم می‌کند. از آن برای اشکال‌زدایی یا نتایج ثابت استفاده کنید.

تنظیم temperature بین 0 و 2. مقادیر پایین‌تر پاسخ‌ها را قابل‌پیش‌بینی‌تر می‌کنند. مقادیر بالاتر تصادفی بودن را افزایش می‌دهند. The top_p پارامتر ترکیب کنید که توکن‌ها را بر اساس احتمال تجمعی فیلتر می‌کند.

این پارامترها دقیقاً مانند API OpenAI کار می‌کنند. می‌توانید آن‌ها را برای کنترل دقیق سبک با هم ترکیب کنید.

پاسخ‌های استریم و مصرف توکن

استریمینگ را با تنظیم stream: true. API رویدادهای ارسال سرور (SSE) را برمی‌گرداند. هر قطعه متن جزئی را شامل می‌شود.

قطعه نهایی شامل آمار مصرف توکن است. این امکان محاسبه دقیق هزینه‌ها را فراهم می‌کند. می‌توانید توکن‌ها را هنگام دریافت آن‌ها پردازش کنید.

استریمینگ تأخیر ادراک‌شده را کاهش می‌دهد. این قابلیت برای رابط‌های چت ایده‌آل است. سرور داده‌ها را تا تکمیل پاسخ ارسال می‌کند.

محدودیت‌ها، خطاها و پنجره زمینه

پنجره زمینه ۱۰۰,۰۰۰ توکن است. این شامل ورودی و خروجی است. می‌توانید تا ۱۶,۰۰۰ توکن در هر درخواست تولید کنید. حداکثر خروجی پیش‌فرض ۲,۰۴۸ توکن است.

محدودیت نرخ ۳۰۰ درخواست در دقیقه است. می‌توانید ۸ درخواست همزمان داشته باشید. اندازه بدنه درخواست به ۸ مگابایت محدود است.

خطاها شامل 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"}]
  }'

پایتون

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)