Ollama उपयोगकर्ताओं के लिए क्विकस्टार्ट

आवश्यकताएं

इस API का उपयोग करने के लिए, आपको एक सक्रिय खाते और एक वैध API कुंजी की आवश्यकता है। Google या ईमेल और पासवर्ड का उपयोग करके API कुंजी प्राप्त करें पेज पर साइन अप करें। फोन नंबर की आवश्यकता नहीं है। आपको अपने मशीन पर एक समर्थित भाषा SDK की भी आवश्यकता है। यह गाइड Python और Node.js को कवर करती है, जो OpenAI-compatible एंडपॉइंट्स के लिए सबसे सामान्य क्लाइंट हैं। API एक single uncensored मॉडल को सर्व करता है जिसे uncensored से पहचाना जाता है। यह केवल टेक्स्ट स्वीकार करता है और केवल टेक्स्ट लौटाता है। कोई एम्बेडिंग, छवियां या ऑडियो सुविधाएं नहीं हैं। सभी अनुरोध https://api.ollamaapi.cc/v1 पर जाते हैं।

SDK इंस्टॉल करें

अपनी पसंदीदा भाषा के लिए आधिकारिक SDK इंस्टॉल करें। Python के लिए, pip का उपयोग करें। Node.js के लिए, npm का उपयोग करें। ये लाइब्रेरी HTTP प्रोटोकॉल, JSON serialisation और streaming को स्वचालित रूप से संभालती हैं। यदि आप उस स्तर की नियंत्रण को प्राथमिकता देते हैं, तो आपको कच्चे HTTP अनुरोध लिखने की आवश्यकता नहीं है। SDKs अच्छी तरह से दस्तावेजित हैं और उत्पादन वातावरण में व्यापक रूप से उपयोग किए जाते हैं। सुनिश्चित करें कि आपका वातावरण SDK आवश्यकताओं से मेल खाता है। Python 3.8+ और Node.js 18+ की सिफारिश की जाती है। नए मॉडल पैरामीटर के साथ संगतता की समस्याओं से बचने के लिए अपने निर्भरताओं को अपडेट रखें।

क्लाइंट कॉन्फ़िगर करें

हमारे एंडपॉइंट के लिए base URL सेट करें। OpenAI से हमारे uncensored सेवा में स्विच करने के लिए यह एकमात्र कॉन्फ़िगरेशन बदलाव है। अपनी API कुंजी को authorization header के रूप में पास करें। SDK शेष काम संभाल लेगा। मॉडल नाम को gpt-4 या इसी तरह के किसी अन्य में न बदलें; uncensored का उपयोग करें। API कठोरता से OpenAI chat-completions प्रोटोकॉल का पालन करता है। कोई भी क्लाइंट जो OpenAI के साथ काम करता है, इन दो बदलावों के साथ यहाँ भी काम करेगा। यह माइग्रेशन या A/B टेस्टिंग को सरल बनाता है। आप दोनों APIs को साथ-साथ चलाकर आउटपुट की तुलना कर सकते हैं।

पहला अनुरोध भेजें

/v1/chat/completions पर एक POST अनुरोध करें। मॉडल ID, सिस्टम प्रॉम्प्ट और उपयोगकर्ता संदेश शामिल करें। API एक टेक्स्ट प्रतिक्रिया लौटाता है। यदि आपके पास क्रेडिट है, तो अनुरोध सफल होता है। यदि आपके पास क्रेडिट नहीं है, तो आपको 402 त्रुटि मिलती है। यदि आपकी कुंजी अमान्य है, तो आपको 401 मिलती है। ये त्रुटियां मानक हैं और कोड में आसानी से संभाली जा सकती हैं। मॉडल कानूनी वयस्क सामग्री को अस्वीकार नहीं करता है, जिससे यह रचनात्मक लेखन, सुरक्षा अनुसंधान या uncensored चैट के लिए उपयोगी है। यदि आपको शेष क्रेडिट के बारे में संदेह है, तो डैशबोर्ड पर अपना बैलेंस जांचें।

स्ट्रीमिंग प्रतिक्रियाएं

stream: true सेट करके स्ट्रीमिंग सक्षम करें। API टोकन को जनरेट होते ही लौटाता है। इससे उपयोगकर्ताओं की अनुभूत विलंबता कम होती है। अंतिम चंक में बिलिंग के लिए कुल टोकन उपयोग होता है। सभी आधिकारिक SDKs स्ट्रीमिंग का समर्थन करते हैं। इसका उपयोग उन चैट इंटरफेस के लिए आवश्यक है जहाँ आप टेक्स्ट को लिखते हुए दिखाना चाहते हैं। सर्वर Server-Sent Events (SSE) भेजता है। आपकी क्लाइंट लाइब्रेरी पarsing संभालती है। यदि आप कस्टम क्लाइंट बना रहे हैं, तो आपको इवेंट स्ट्रीम को मैनुअली मैनेज करने की आवश्यकता नहीं है।

सीमाएं, त्रुटियां और कॉन्टेक्स्ट विंडो

कॉन्टेक्स्ट विंडो कुल 100,000 टोकन की है, जिसमें अधिकतम आउटपुट 32,000 टोकन है। अनुरोध प्रति मिनट 300 और प्रति कुंजी 8 समानांतर अनुरोधों तक सीमित हैं। अनुरोध बॉडी 8 MB से कम होनी चाहिए। त्रुटियों में अमान्य कुंजियों के लिए 401, अपर्याप्त क्रेडिट के लिए 402 और रेट लिमिट के लिए 429 शामिल हैं। ये मानक HTTP कोड हैं। अपने एप्लिकेशन में उन्हें दयालुता से संभालें। मॉडल किशोरों से संबंधित यौन सामग्री को ब्लॉक करता है। बाकी सभी सामग्री की अनुमति है। क्रेडिट कभी समाप्त नहीं होता, इसलिए आप उपयोग बिना धन खोए रोक सकते हैं। रिफंड मुद्दों के लिए सपोर्ट पेज का उपयोग करें।

cURL

Copycurl https://api.ollamaapi.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

Python

Copyfrom openai import OpenAI

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