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

प्रमाणीकरण और बेस यूआरएल

API प्रमाणीकरण के लिए एकल API कुंजी की आवश्यकता होती है। Google या ईमेल पता से साइन अप करने के बाद आपको यह कुंजी तुरंत मिलती है। इसे पास करें Authorization हेडर को Bearer टोकन के रूप में सेट करें। बेस URL है https://api.topuncensored.com/v1. यह URL किसी भी OpenAI-संगत SDK या क्लाइंट लाइब्रेरी के साथ काम करता है।

• हेडर का उपयोग करें: Authorization: Bearer YOUR_API_KEY
• अपने क्लाइंट का बेस URL प्रदान किए गए एंडपॉइंट पर सेट करें।

यह सेटअप सुनिश्चित करता है कि आप बिना अपनी कोर लॉजिक बदले लाइब्रेरीज स्विप कर सकें।

Copycurl https://api.topuncensored.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate a list of ten distinct UI layout patterns."}]
  }'

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

टेक्स्ट प्रॉम्प्ट को /v1/chat/completions एंडपॉइंट। मॉडल आईडी है uncensored. यह एंडपॉइंट मेसेजेस के साथ स्टैंडर्ड चैट फॉर्मेटिंग हैंडल करता है। यह सीधे टेक्स्ट रिस्पॉन्स लौटाता है। कोई एक्स्ट्रा लेयर्स या व्रैपर्स नहीं हैं। आप 100,000 टोकन की कॉन्टेक्स्ट विंडो को कंट्रोल करते हैं। 8 MB से कम रिक्वेस्ट्स रिलायबली काम करती हैं। डायरेक्ट टेक्स्ट जनरेशन के लिए इसका उपयोग करें।

अपने अनुरोध को एक सिस्टम प्रॉम्प्ट और उपयोगकर्ता संदेश के साथ संरचित करें। मॉडल कानूनी वयस्क सामग्री को फ़िल्टर किए बिना प्रतिक्रिया देता है। कुंजी न मिलने जैसी त्रुटियां 401 लौटाती हैं। क्रेडिट खत्म हो गया? आपको 402 त्रुटि मिलती है। ये स्पष्ट संकेत हैं।

स्ट्रीमिंग रिस्पॉन्सेस

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

प्रत्येक चंक को अपनी अंतिम प्रतिक्रिया बनाने के लिए पार्स करें। यह विधि बड़े आउटपुट को सहजता से संभालती है। API मानक सर्वर-सेंट इवेंट्स का समर्थन करती है। यह इंटरैक्टिव ऐप्स के लिए अनुशंसित दृष्टिकोण है।

Copyfrom openai import OpenAI

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

टूल कॉलिंग और JSON मोड

संरचित इंटरैक्शन के लिए फ़ंक्शन कॉलिंग का उपयोग करें। अपने अनुरोध में टूल परिभाषित करें। मॉडल संरचित तर्क लौटाता है। सेट करें response_format को {"type": "json_object"} कठोर JSON आउटपुट के लिए। यह भविष्यवाणी योग्य डेटा प्रारूप सुनिश्चित करता है। मजबूत इंटीग्रेशन के लिए इन सुविधाओं को जोड़ें। आपको आउटपुट संरचना पर सटीक नियंत्रण मिलता है।

टूल कॉलिंग मानक OpenAI स्कीमा के साथ काम करता है। JSON मोड वैध JSON को फोर्स करता है। API इंटीग्रेशन या डेटा एक्सट्रैक्शन के लिए इनका उपयोग करें। यह लचीलापन जटिल वर्कफ्लो का समर्थन करता है।

Copyimport OpenAI from "openai";

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

पैरामीटर और सीमाएं

समायोजित करें temperature, top_p, और stop अनुक्रम। सेट करें max_tokens 16,000 तक। यदि छोड़ दिया जाए तो डिफ़ॉल्ट 2,048 है। पुनरावृत्ति को presence_penalty और frequency_penalty. उपयोग करें seed निर्धारक आउटपुट के लिए। ये पैरामीटर जनरेशन गुणवत्ता को सूक्ष्म-समायोजित करते हैं। आपको आउटपुट शैली पर पूर्ण नियंत्रण है।

रेट लिमिट्स प्रति मिनट 300 अनुरोध हैं। समवर्ती अनुरोध 8 तक सीमित हैं। ये सीमाएं स्थिर प्रदर्शन सुनिश्चित करती हैं। डैशबोर्ड के माध्यम से अपनी उपयोगिता की निगरानी करें। अपने विशिष्ट उपयोग मामले के लिए अनुकूलित करने के लिए पैरामीटर समायोजित करें।

त्रुटियां और संदर्भ विंडो

त्रुटियों को सहजता से हैंडल करें। 401 का अर्थ है अमान्य कुंजी। 402 अपर्याप्त क्रेडिट को संकेत देता है। 429 दर सीमाओं को संकेत देता है। संदर्भ विंडो कुल मिलाकर 100,000 टोकन है। आउटपुट 16,000 टोकन पर अधिकतम होता है। अपने टोकन का प्रबंधन समझदारी से करें। त्रुटियां क्रेडिट नहीं खाती हैं। यह डीबगिंग के दौरान पैसे बचाती हैं। उपयोग आँकड़ों के लिए अंतिम चंक का उपयोग करें।

अपने टोकन उपयोग को ट्रैक करें। दर सीमाओं को पार न करें। एक्सपोनेंशियल बैकऑफ के साथ पुनः प्रयास करें। यह विश्वसनीय संचालन सुनिश्चित करता है। 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)