مستندات API Ollama برای توسعه‌دهندگان

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

استفاده https://api.ollamaendpointurl.com/v1 به‌عنوان آدرس پایه (base URL) خود تنظیم کنید و کلید API خود را در Authorization هدر.

• URL پایه: https://api.ollamaendpointurl.com/v1
• هدر: Authorization: Bearer YOUR_API_KEY

کلید خود را به‌طور فوری از طریق Google یا ایمیل در داشبورد ایجاد کنید. نیاز به شماره تلفن نیست. این URL با هر SDK استاندارد OpenAI کار می‌کند با جای‌گزینی URL پایه.

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

یک درخواست POST به /v1/chat/completions با شناسه مدل uncensored و پیام‌های شما.

Copycurl https://api.ollamaendpointurl.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the default port for Ollama?"}]
  }'

این یک پاسخ JSON شامل متن تولید شده برمی‌گرداند. اگر خطای 401 دریافت کردید، کلید API شما نامعتبر است. خطای 402 نشان‌دهنده اعتبار پیش‌پرداخت ناکافی است.

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

کلاینت را با کلید خود و URL پایه سفارشی مقداردهی اولیه کنید تا درخواست‌ها را به صورت برنامه‌نویسی ارسال کنید.

Copyfrom openai import OpenAI

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

تنظیم max_tokens برای کنترل طول خروجی. بدون آن، پیش‌فرض ۲,۰۴۸ توکن است. مدل پارامترهای استاندارد مانند را می‌پذیرد temperature و top_p برای تنظیم رفتار تولید.

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

مشتری Node.js را پیکربندی کنید تا به نقطه پایانی ما برای یکپارچه‌سازی روان در اسکریپت‌های شما اشاره کند.

Copyimport OpenAI from "openai";

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

SDK سریال‌سازی را به صورت خودکار مدیریت می‌کند. مطمئن شوید که از نسخه جدیدی از SDK OpenAI که از URLهای پایه سفارشی پشتیبانی می‌کند استفاده می‌کنید. خطاها به عنوان استثناهای استاندارد API پرتاب می‌شوند.

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

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

جزئیات مصرف توکن در قطعه نهایی جریان ظاهر می‌شود. این موضوع تأخیر ادراک‌شده را برای خروجی‌های طولانی کاهش می‌دهد. نقطه پایانی از قالب‌بندی استاندارد SSE پشتیبانی می‌کند که با اکثر کتابخانه‌های کلاینت سازگار است.

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

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