مستندات API نقطه پایانی Ollama

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

از URL پایه و یک کلید API برای هر درخواست استفاده کنید. نقطه پایانی است https://api.ollamaendpoint.com/v1Authorization هدر به عنوان یک توکن Bearer. این کلید بلافاصله پس از ورود با گوگل یا ایمیل تولید می‌شود. کلید برای هر حساب منحصر به فرد است و هر کلید فعال قبلی را جایگزین می‌کند.

اولین درخواست

درخواست تکمیل چت استاندارد را ارسال کنید تا متن تولید شود. شناسه مدل uncensored و همان پارامترهایی را می‌پذیرد که کلاینت‌های استاندارد OpenAI می‌پذیرند. این برای وظایف LLM NSFW یا تولید محتوای نامحدود کار می‌کند.

• روش: POST
• نقطه پایانی: /v1/chat/completions
• مدل: uncensored

Copycurl https://api.ollamaendpoint.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Get the local ip address of this machine"}]
  }'

یک پاسخ موفق، متن تولید شده را در آرایه choices برمی‌گرداند. بررسی کنید که usage فیلد برای مشاهده تعداد توکن‌ها.

یکپارچه‌سازی SDK Python

کتابخانه رسمی OpenAI را نصب کنید و URL پایه را پیکربندی کنید. این به شما اجازه می‌دهد از مدل ollama بدون سانسور با کد پایتون آشنا استفاده کنید. مقدار base_url و api_key before initializing the client. کد شما با SDKهای موجود OpenAI سازگار باقی می‌ماند.

Copyfrom openai import OpenAI

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

فراخوانی chat.completions.create روش دقیقاً مانند GPT. ساختار پاسخ با انتظارات استاندارد مطابقت دارد. می‌توانید پاسخ‌ها را به صورت stream دریافت کنید یا پاسخ کامل بگیرید.

یکپارچه‌سازی Node SDK

از پکیج OpenAI Node.js برای تعامل با API استفاده کنید. کلاینت را با URL پایه سفارشی و کلید API خود پیکربندی کنید. این روش برای برنامه‌های سمت سرور یا توابع edge کار می‌کند. پکیج سریال‌سازی و تلاش مجدد را به صورت خودکار مدیریت می‌کند.

Copyimport OpenAI from "openai";

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

نقطه پایانی تکمیل را با پرامپت خود فراخوانی کنید. کتابخانه یک promise را برمی‌گرداند که به شیء پاسخ حل می‌شود. خطاها را بر اساس کدهای وضعیت HTTP استاندارد مدیریت کنید.

پاسخ‌های استریم با SSE

استریمینگ را با تنظیم stream: true در درخواست شما. سرور یک استریم رویدادهای ارسالی سرور (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)

بخش‌های محتوا را از هر تکه جمع‌آوری کنید تا پاسخ کامل را بازسازی کنید. خطاها را هنگامی که در جریان (stream) دریافت می‌شوند پردازش کنید. آخرین تکه، شمار توکن را برای اعتبار پیش‌پرداخت شما تأیید می‌کند.

محدودیت‌های نرخ و محدودیت‌ها

هر کلید API از ۳۰۰ درخواست در دقیقه و ۸ درخواست همزمان پشتیبانی می‌کند. حداکثر اندازه بدنه درخواست ۸ مگابایت است. پنجره زمینه ۱۰۰,۰۰۰ توکن برای ترکیب prompt و completion است. محدودیت‌های خروجی ۱۶,۰۰۰ توکن در هر درخواست است. خطاها و رد شدن‌ها اعتبار مصرف نمی‌کنند. خطای ۴۰۱ به معنای نامعتبر بودن کلید شماست. خطای ۴۰۲ نشان‌دهنده اعتبار پیش‌پرداخت ناکافی است. خطای ۴۲۹ به معنای رسیدن به محدودیت نرخ است. همزمانی خود را تنظیم کنید تا در محدودیت‌ها بمانید.