API दस्तावेज़: क्विकस्टार्ट

Base URL और प्रमाणीकरण

सर्वरलेस LLM API मानक OpenAI-compatible endpoint संरचना का उपयोग करती है। शुरू करने के लिए, आपको दो जानकारी की आवश्यकता है: आपका base URL और API कुंजी।

सभी अनुरोधों के लिए निम्नलिखित base URL का उपयोग करें:

https://api.serverlessllmapi.com/v1

प्रमाणीकरण Authorization हेडर के माध्यम से किया जाता है। अपनी कुंजी प्राप्त करने के लिए Get API key पेज पर एक खाता बनाएं। आप इस कुंजी को किसी भी समय रीजेनरेट कर सकते हैं, जिससे पुरानी कुंजी तुरंत रद्द हो जाती है। अपनी कुंजी को सुरक्षित रखें, क्योंकि यह आपके प्रीपेड क्रेडिट तक सीधा एक्सेस प्रदान करती है।

पहला अनुरोध: चैट पूर्णता

/v1/chat/completions एंडपॉइंट पर एक मानक चैट कंप्लीशन अनुरोध भेजें। API एक मॉडल नाम, संदेशों की एक सूची और वैकल्पिक पैरामीटर स्वीकार करता है। हमारा डिफ़ॉल्ट मॉडल आईडी uncensored है, जो उच्च गुणवत्ता वाली, बिना प्रतिबंध वाली प्रतिक्रियाओं के लिए अनुकूलित है।

यहाँ curl का उपयोग करके एक प्रतिक्रिया जनरेट करने का एक मूल उदाहरण दिया गया है:

Copycurl https://api.serverlessllmapi.com/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."}]
  }'

प्रतिक्रिया मानक OpenAI JSON फॉर्मेट का पालन करती है। यदि अनुरोध सफल होता है, तो आपको जनरेटेड टेक्स्ट वाला एक पूर्णता ऑब्जेक्ट प्राप्त होगा। यह सरलता आपको base URL और कुंजी बदलकर अपने मौजूदा OpenAI SDK कॉन्फ़िगरेशन में हमारे endpoint को बदलने की अनुमति देती है।

Python SDK एकीकरण

औपचारिक OpenAI Python SDK का उपयोग करना एकीकरण का सबसे तेज़ तरीका है। चूँकि हमारा API openai compatible api है, आपको केवल base URL और API key को ओवरराइड करने की आवश्यकता है। यह सुनिश्चित करता है कि आपका मौजूदा कोड बिना संशोधन के काम करे।

Copyfrom openai import OpenAI

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

यह दृष्टिकोण आपको परिचित पायथन लाइब्रेरीज़ का लाभ उठाने और हमारे बिना सेंसर मॉडल से लाभान्वित होने की अनुमति देता है। कॉन्टेक्स्ट विंडो 100,000 टोकन तक का समर्थन करता है, जिससे एक ही अनुरोध में महत्वपूर्ण इनपुट और आउटपुट लंबाई संभव होती है। सुनिश्चित करें कि आपके संदेशों में मॉडल को प्रभावी रूप से मार्गदर्शित करने के लिए आवश्यक सिस्टम और उपयोगकर्ता प्रॉम्प्ट शामिल हैं।

Node.js SDK एकीकरण

JavaScript और TypeScript डेवलपर्स के लिए, OpenAI Node SDK एक सरल एकीकरण पथ प्रदान करता है। तुरंत अनुरोध करने के लिए क्लाइंट को हमारे base URL और अपनी API key के साथ कॉन्फ़िगर करें।

Copyimport OpenAI from "openai";

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

यह सेटअप सर्वरलेस फ़ंक्शन्स या बैकएंड सेवाओं के लिए आदर्श है जिनमें रियल-टाइम LLM इंटरैक्शन की आवश्यकता होती है। पे-एज़-यू-गो प्राइसिंग का अर्थ है कि आप केवल उसी के लिए भुगतान करते हैं जिसका आप उपयोग करते हैं, बिना मासिक सदस्यता के। क्रेडिट कभी समाप्त नहीं होते, इसलिए आप प्रोजेक्ट्स के बीच उपयोग रोक सकते हैं और अपना बैलेंस नहीं खोते।

स्ट्रीमिंग प्रतिक्रियाएँ (SSE)

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

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)

अंतिम प्रतिक्रिया को संचित करने के लिए अपने क्लाइंट कोड में स्ट्रीम इवेंट्स हैंडल करें। सही ढंग से कॉन्फ़िगर करने पर स्ट्रीमिंग Python और Node SDKs दोनों के साथ काम करती है। यह सुविधा लंबी सामग्री जनरेशन के लिए विशेष रूप से उपयोगी है जहाँ तत्क प्रतिक्रिया मूल्यवान होती है।

रेट लिमिट और बाधाएँ

सुचारू एकीकरण सुनिश्चित करने के लिए बाधाओं को समझें। API प्रत्येक API कुंजी के लिए प्रति मिनट 300 अनुरोध का रेट लिमिट लागू करता है। प्रत्येक अनुरोध बॉडी 8 MB से अधिक नहीं होनी चाहिए। यदि आप रेट लिमिट से अधिक हो जाते हैं, तो आपको 429 स्टेटस कोड प्राप्त होगा।

प्रमाणीकरण त्रुटियाँ 401 स्थिति लौटाती हैं, जो एक अमान्य या रद्द की गई कुंजी को दर्शाती हैं। यदि आपका प्रीपेड क्रेडिट समाप्त हो जाता है, तो अनुरोध 402 स्थिति लौटाएंगे। मॉडल आईडी uncensored एम्बेडिंग, छवि जनरेशन या फाइन-ट्यूनिंग का समर्थन नहीं करती है। सर्वोत्तम प्रदर्शन के लिए टेक्स्ट-आधारित चैट पूर्णताओं पर ध्यान केंद्रित करें।