API Documentation

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

API का जीवन है https://api.ollamaapidoc.com/v1. Bearer टोकन का उपयोग करके प्रमाणीकरण करें Authorization हेडर। डैशबोर्ड पर Google या ईमेल के माध्यम से अपनी कुंजी तुरंत जनरेट करें। फोन नंबर की आवश्यकता नहीं है। कुंजी मानक OpenAI SDKs के साथ काम करती है बेस यूआरएल सेट करके।

आपका पहला अनुरोध

एक POST अनुरोध भेजें /v1/chat/completions मॉडल ID के साथ 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 जब कुछ विफल हो जाए तो विवरण। स्ट्रीमिंग प्रतिक्रियाएं सर्वर-संवादित घटनाओं (Server-Sent Events) का उपयोग करती हैं।

Python SDK इंटीग्रेशन

औपचारिक OpenAI लाइब्रेरी को इंस्टॉल करें। अपने बेस URL और API कुंजी के साथ क्लाइंट को कॉन्फ़िगर करें। चैट पूर्णता एंडपॉइंट को कॉल करें। कोड मानक 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 सेट किया है तो लाइब्रेरी टोकन स्ट्रीम करती है। यह दृष्टिकोण आपके कोडबेस को स्वच्छ और संगत रखता है।

Node.js SDK सेटअप

का उपयोग करें openai npm पैकेज। कस्टम बेस यूआरएल के साथ क्लाइंट को इनिशियलाइज करें। अपनी 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)

फंक्शन कॉलिंग समान रूप से काम करती है। अपने अनुरोध में टूल्स परिभाषित करें। मॉडल टूल कॉल लौटाता है। अपने कोड में इन कॉल्स को पार्स करें। उन्हें निष्पादित करें और परिणाम मॉडल को वापस फीड करें। यह लूप जटिल वर्कफ़्लो को सक्षम बनाता है।

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

संदर्भ विंडो 100,000 टोकन की है। अधिकतम आउटपुट प्रति अनुरोध 16,000 टोकन है। त्रुटियों में अमान्य कुंजियों के लिए 401 और अपर्याप्त क्रेडिट के लिए 402 शामिल हैं। दर सीमाएं प्रति मिनट 300 अनुरोधों पर सीमित हैं। अपने ऐप में इन्हें दयालुता से संभालें। API आपके प्रॉम्प्ट को प्रशिक्षण के लिए कभी उपयोग नहीं करता है। गोपनीयता बनाए रखी जाती है। क्रेडिट समाप्त नहीं होता है।