Ollama API दस्तावेज़ीकरण: एंडपॉइंट संदर्भ

बेस URL और प्रमाणीकरण

सभी अनुरोधों के लिए बेस यूआरएल है https://api.ollamaapidocumentation.com/v1. bearer टोकन पास करके प्रमाणीकरण करें Authorization हेडर। आपकी कुंई डैशबोर्ड पर जनरेट होती है और तुरंत काम करती है।

• आधिकारिक OpenAI SDK या किसी भी संगत क्लाइंट के साथ।
• बेस URL को ऊपर दिए गए मान पर सेट करें।
• हेडर में अपनी API कुंजी शामिल करें।

प्रमाणीकरण कठोर है। यदि कुंजी अनुपस्थित या अमान्य है, तो API एक 401 त्रुटि लौटाता है। यह सुनिश्चित करता है कि आपके उपयोग का सटीक बिलिंग के लिए ट्रैकिंग किया जाता है।

चैट कंप्लीशंस एंडपॉइंट: POST /v1/chat/completions

के माध्यम से मॉडल को संदेश भेजें POST /v1/chat/completions. एंडपॉइंट एक JSON बॉडी स्वीकार करता है जिसमें एक model field सेट है "uncensored" और एक messages array।

यह एंडपॉइंट टेक्स्ट जनरेशन को हैंडल करता है। यह इमेजेस, ऑडियो, या वीडियो को सपोर्ट नहीं करता है। आप रिस्पॉन्स को स्ट्रीम कर सकते हैं या पूरे रिजल्ट का इंतज़ार कर सकते हैं।

त्रुटियाँ जैसे 402 अपर्याप्त क्रेडिट को दर्शाती हैं। अनुरोध वास्तविक टोकन उपयोग द्वारा चार्ज किए जाते हैं। क्रेडिट के कारण अस्वीकृतियाँ मुफ्त हैं।

मॉडल लिस्टिंग: GET /v1/models

का उपयोग करके उपलब्ध मॉडल पुनः प्राप्त करें GET /v1/models. यह मॉडल ऑब्जेक्ट्स की एक सूत्र लौटाता है। उपलब्ध एकमात्र मॉडल आईडी "uncensored" है।

यह एंडपॉइंट कनेक्टिविटी की जांच में मदद करता है। यह पुष्टि करता है कि बेस यूआरएल सही है। यह मॉडल नाम और ऑब्जेक्ट टाइप भी दिखाता है।

भारी पेलोड भेजने से पहले कनेक्शन समस्याओं को डिबग करने के लिए इसका उपयोग करें।

पैरामीटर: तापमान, Top P, और Seed

पैरामीटर जैसे तापमान और top_p के साथ जनरेशन को नियंत्रित करें। temperature, top_p, और seed. The seed पैरामीटर निर्धारणात्मक आउटपुट सुनिश्चित करता है। डीबगिंग या स्थिर परिणामों के लिए इसका उपयोग करें।

सेट करें temperature 0 और 2 के बीच। निम्न मान प्रतिक्रियाओं को अधिक पूर्वानुमेय बनाते हैं। उच्च मान यादृच्छिकता बढ़ाते हैं। top_p पैरामीटर संचयी प्रायिकता द्वारा टोकन को फ़िल्टर करता है।

ये पैरामीटर बिल्कुल वैसे ही काम करते हैं जैसे OpenAI API। आप शैली पर सटीक नियंत्रण के लिए उन्हें जोड़ सकते हैं।

स्ट्रीमिंग रिस्पॉन्सेस और टोकन उपयोग

सेटिंग करके स्ट्रीमिंग सक्षम करें stream: true. API सर्वर-सेंट इवेंट्स (SSE) लौटाती है। प्रत्येक चंक आंशिक टेक्स्ट होता है।

अंतिम चंक में टोकन उपयोग सांख्यिकी शामिल है। इससे आपको लागत की सटीक गणना करने की अनुमति मिलती है। आप टोकन को आने के साथ-साथ प्रोसेस कर सकते हैं।

स्ट्रीमिंग संक्रामक विलंबता को कम करती है। यह चैट इंटरफेस के लिए आदर्श है। सर्वर प्रतिक्रिया पूरी होने तक डेटा धकेलता है।

सीमाएं, त्रुटियां, और संदर्भ विंडो

संदर्भ विंडो 100,000 टोकन की है। इसमें इनपुट और आउटपुट दोनों शामिल हैं। आप प्रति अनुरोध 16,000 टोकन तक जनरेट कर सकते हैं। डिफ़ॉल्ट अधिकतम आउटपुट 2,048 टोकन है।

रेट लिमिट्स प्रति मिनट 300 अनुरोध हैं। आप 8 समवर्ती अनुरोध कर सकते हैं। अनुरोध बॉडी का आकार 8 MB तक सीमित है।

त्रुटियों में अमान्य कुंजियों के लिए 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"}]
  }'

Python

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)