API مستندات

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

API در https://api.ollamaapidoc.com/v1. شما با یک توکن Bearer در Authorization هدر. کلید خود را به صورت فوری از طریق گوگل یا ایمیل در داشبورد ایجاد کنید. نیاز به شماره تلفن نیست. کلید با SDKهای استاندارد 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) استفاده می‌کنند.

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

کتابخانه رسمی OpenAI را نصب کنید. کلاینت را با URL پایه و کلید API خود پیکربندی کنید. انتهای‌کار chat completions را فراخوانی کنید. کد با استفاده استاندارد از 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. کلاینت را با URL پایه سفارشی مقداردهی اولیه کنید. کلید API خود را پاس دهید. سینتکس با مثال Python مطابقت دارد. این ثبات زمان اشکال‌زدایی را کاهش می‌دهد. می‌توانید پیام‌های متعددی را در یک آرایه تاریخچه گفتگو ارسال کنید.

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);

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

استریمینگ و حالت JSON

با تنظیم stream پارامتر را 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)

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

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

پنجره زمینه ۱۰۰,۰۰۰ توکن است. حداکثر خروجی ۱۶,۰۰۰ توکن در هر درخواست است. خطاها شامل 401 برای کلیدهای نامعتبر و 402 برای اعتبار ناکافی است. محدودیت نرخ تا 300 درخواست در دقیقه است. این‌ها را به صورت ایمن در برنامه خود مدیریت کنید. API هرگز از پرامپت‌های شما برای آموزش استفاده نمی‌کند. حریم خصوصی حفظ می‌شود. اعتبار منقضی نمی‌شود.