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

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

API एंडपॉइंट HTTPS://api.unrestrictedaitools.com/v1 है। मानक OpenAI SDKs का उपयोग बेस_url बदलकर और अपनी API कुंजी प्रदान करके करें। आप तुरंत अपनी कुंजी प्राप्त करने के लिए Google या ईमेल से साइन अप कर सकते हैं।

Copycurl https://api.unrestrictedaitools.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "what is the capital of france"}]
  }'

हर अनुरोध में Authorization हेडर शामिल होना चाहिए। आपकी कुंजी बिना अतिरिक्त कॉन्फ़िगरेशन चरणों के अनसेंसर्ड मॉडल तक पहुंच प्रदान करती है।

पहला अनुरोध: POST /v1/chat/completions

अपने messages के साथ /v1/chat/completions पर POST अनुरोध भेजें। मॉडल आईडी 'uncensored' है। इनपुट टेक्स्ट है, आउटपुट टेक्स्ट है। यहाँ एम्बेडिंग या इमेज जनरेशन नहीं है।

Copyfrom openai import OpenAI

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

अपने प्रॉम्प्ट्स को सरल रखें। API बाकी सब संभाल लेती है। त्रुटियां मुफ्त हैं, इसलिए आप स्वतंत्र रूप से परीक्षण कर सकते हैं।

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

अपने अनुरोध में stream को true सेट करके स्ट्रीमिंग सक्षम करें। 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)

स्ट्रीमिंग लंबी प्रतिक्रियाओं या इंटरैक्टिव ऐप्स के लिए इसका उपयोग करें। सटीक गणना के लिए हमेशा अंतिम खंड की जांच करें।

पैरामीटर: तापमान, Top-P, और स्टॉप

रचनात्मकता के लिए तापमान समायोजित करें। न्यूक्लियस सैंपलिंग के लिए top_p सेट करें। आउटपुट रोकने के लिए स्टॉप सीक्वेंस का उपयोग करें। ये पैरामीटर आपको जनरेशन शैली पर नियंत्रण देते हैं।

Copyimport OpenAI from "openai";

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

उच्च तापमान अधिक विविध पाठ उत्पन्न करते हैं। निम्न मान अधिक निर्धारक होते हैं। अपने उपयोग के मामले के लिए सही संतुलन खोजने के लिए प्रयोग करें।

JSON मोड और फंक्शन कॉलिंग

स्ट्रक्चर्ड आउटपुट के लिए response_format json_object का उपयोग करें। टूल्स और tool_choice के साथ फंक्शन कॉलिंग सक्षम करें। इससे मॉडल एक्शन एक्जीक्यूट कर सकता है या विशिष्ट फॉर्मेट में डेटा लौटा सकता है।

अपने टूल्स को स्पष्ट रूप से परिभाषित करें। मॉडल स्कीमा का पालन करेगा। यह एजेंट्स या डेटा एक्सट्रैक्शन पाइपलाइन बनाने के लिए उपयोगी है।

रेट लिमिट्स और संदर्भ विंडो

आपको प्रति मिनट 300 अनुरोध और 8 समवर्ती अनुरोध मिलते हैं। संदर्भ विंडो 100,000 टोकन की है। अधिकतम आउटपुट 16,000 टोकन है। अनुरोध बॉडी 8 MB से कम होनी चाहिए।

यदि आप 429 पर पहुंचते हैं, तो कुछ समय के लिए प्रतीक्षा करें। 401 का अर्थ है अमान्य कुंजी। 402 का अर्थ है कोई क्रेडिट नहीं। ये सीमाएं सभी डेवलपर्स के लिए उचित उपयोग को सुनिश्चित करती हैं।