API दस्तावेज़ीकरण & क्विकस्टार्ट

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

कनेक्ट करने के लिए हमारे बेस यूआरएल और एक एकल API कुंजी का उपयोग करें। एंडपॉइंट मानक हेडर्स स्वीकार करता है। प्रतिस्थापित करें YOUR_API_KEY आपके डैशबोर्ड से स्ट्रिंग के साथ।

• बेस यूआरएल: https://api.ollamaopenaicompatibleapi.com/v1
• मॉडल ID: uncensored

प्रमाणीकरण एक Bearer टोकन पर निर्भर करता है। इसे Authorization हेडर। यह किसी भी OpenAI SDK संगत क्लाइंट के साथ संगतता सुनिश्चित करता है। आप Google या ईमेल के माध्यम से तुरंत एक नई कुंजी जनरेट कर सकते हैं। फ़ोन नंबर की आवश्यकता नहीं है।

चैट कंप्लीशंस एंडपॉइंट

एक POST अनुरोध भेजें /v1/chat/completions. अपने संदेशों के सरल और मॉडल का नाम शामिल करें। API आपके प्रॉम्प्ट के आधार पर पाठ आउटपुट लौटाता है। यह मानक प्राचरक का उपयोग करने वाले किसी भी प्रदाता के साथ काम करता है।

रचनात्मकता के लिए तापमान सेट करें या सटीकता के लिए इसे कम रखें। आप स्टॉप सीक्वेंस भी परिभाषित कर सकते हैं। सर्वर अनुरोध को प्रक्रिया करता है और पूर्णता लौटाता है। यह अधिकांश एकीकरणों के लिए मुख्य इंटरैक्शन है।

याद रखें कि त्रुटियां आपके पूर्व-भुगतान क्रेडिट का उपभोग नहीं करती हैं। केवल सफल पूर्णताओं के लिए बिल किया जाता है। यह डीबगिंग चरणों के दौरान आपके बजट की रक्षा करता है।

Copycurl https://api.ollamaopenaicompatibleapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 10 Linux kernel security patches from 2023"}]
  }'

SSE के माध्यम से स्ट्रीमिंग रिस्पॉन्सेस

सेटिंग करके स्ट्रीमिंग सक्षम करें stream: true. सर्वर जनरेट होते ही चंक भेजता है। यह अनुपस्थित विलंबता को काफी कम करता है। आप वास्तविक समय में आंशिक प्रतिक्रियाएं प्राप्त करते हैं।

सर्वर-सेंट इवेंट्स (SSE) स्ट्रीम को पार्स करें। अंतिम चंक में उपयोग के आंकड़े होते हैं। इसमें इनपुट और आउटपुट दोनों के लिए टोकन गणना शामिल है। जनरेशन के दौरान आप लागत को गतिशील रूप से ट्रैक कर सकते हैं।

यह दृष्टिकोण चैट इंटरफेस के लिए अच्छा काम करता है। उपयोगकर्ता टेक्स्ट शब्द-दर-शब्द प्रकट होते हुए देखते हैं। यह पूरी प्रतिक्रिया का इंतजार करने से अधिक प्रतिक्रियाशील लगता है। 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 के साथ {"type": "json_object"} कठोर JSON के लिए। यह सुनिश्चित करता है कि आउटपुट हर बार पार्स करने योग्य हो।

Tool definitions में नाम, विवरण और पैरामीटर शामिल हैं। मॉडल तय करता है कि किस टूल को कॉल करना है। आप फंक्शन एक्जीक्यूट करते हैं और रिजल्ट वापस भेजते हैं। यह जटिल एजेंट वर्कफ्लो को सक्षम बनाता है।

JSON मोड फ्री-टेक्स्ट जनरेशन को अक्षम करता है। यह मॉडल को आपके स्कीमा का पालन करने पर मजबूर करता है। इसे डेटाबेस या API के साथ एकीकृत करते समय उपयोग करें। यह संरचित फ़ील्ड्स में हैलुसिनेशन को कम करता है।

Copyfrom openai import OpenAI

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

रेट लिमिट्स और अनुरोध बॉडी

आपको प्रति कुंजी 300 अनुरोध प्रति मिनट मिलते हैं। सह-संचालन 8 समानांतर अनुरोधों तक सीमित है। अधिकतम अनुरोध बॉई आकार 8 MB है। यह अधिकांश टेस्ट-भरित एप्लिकेशन के लिए उपयुक्त है।

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

HTTP 429 त्रुटियों को सहजता से हैंडल करें। वे दर्शाते हैं कि आपने दर सीमा पार कर ली है। क्लाइंट कोड में एक्सपोनेंशियल बैकऑफ लागू करें। यह स्पाइक के दौरान सर्वर को ओवरलोड होने से रोकता है।

Copyimport OpenAI from "openai";

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

प्रमाणीकरण त्रुटियाँ और सीमाएँ

401 स्टेटस का अर्थ है कि आपकी कुंजी अमान्य है। टाइपिंग त्रुटियों या समाप्त हो चुके सत्रों के लिए जांचें। 402 स्टेटस अपर्याप्त क्रेडिट का संकेत देता है। सेवा जारी रखने के लिए क्रिप्टो के माध्यम से टॉप अप करें।

429 स्थिति दर सीमा को दर्शाती है। आपने प्रति मिनट 300 अनुरोध पार कर लिए हैं। अपनी थ्रूपुट को कम करें या अपनी कुंजी को अपग्रेड करें। API स्पष्ट त्रुटि संदेश लौटाता है।

क्रेडिट कभी समाप्त नहीं होता है। आप किसी भी समय टॉप-अप कर सकते हैं। न्यूनतम टॉप-अप $20 है। बड़ी राशि के लिए बोनस क्रेडिट लागू होते हैं। यह आपके प्रोजेक्ट को सुचारू रूप से चलाने में मदद करता है।