مستندات API Ollama: راهنمای شروع سریع

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

URL پایه HTTPS://api.ollamaapidocs.com/v1 است. کلید خود را در هدر استاندارد Authorization ارسال کنید.

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 با تنظیم مدل روی uncensored ارسال کنید.

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، پخش زنده (streaming) را فعال کنید. API توکن‌ها را از طریق رویدادهای ارسالی سرور برمی‌گرداند و از فراخوانی تابع پشتیبانی می‌کند.

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 دقیق استفاده کنید. همچنین می‌توانید دما، top_p و دنباله‌های توقف را تنظیم کنید.

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

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

محدودیت ۳۰۰ درخواست در دقیقه به ازای هر کلید است. هر درخواست از یک پنجره زمینه ۱۰۰,۰۰۰ توکنی پشتیبانی می‌کند.

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"}]
  }'

خطاها و پنجره زمینه

خطای ۴۰۱ را برای کلیدهای نامعتبر، ۴۰۲ را برای عدم وجود اعتبار و ۴۲۹ را برای محدودیت نرخ درخواست مدیریت کنید. مدل از پنجره زمینه ۱۰۰,۰۰۰ توکن پشتیبانی می‌کند.

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)