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

क्विकस्टार्ट: Python या JS के साथ पहला अनुरोध

अपना पहला प्रॉम्प्ट भेजें और तुरंत कच्चा टेक्स्ट आउटपुट प्राप्त करें। API मानक चैट-पूर्णता पेलोड स्वीकार करता है, इसलिए आप बिना अपने लॉजिक को फिर से लिखे अनियंत्रित सामग्री जनरेट शुरू करने के लिए अपना बेस URL और कुंजी डाल सकते हैं। कनेक्टिविटी और मॉडल उपलब्धता की जांच करने के लिए निम्नलिखित cURL कमांड का उपयोग करें, जिससे आप अपने कोडबेस में एकीकृत करने से पहले तैयार रहें।

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

Copycurl https://api.chatunrestricted.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the three main endpoints for user authentication"}]
  }'

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

प्रमाणीकरण करें अपने API कुंजी को HTTP हेडर में पास करके। सभी अनुरोधों को base URL पर टारगेट करना चाहिए https://api.chatunrestricted.com/v1 OpenAI SDKs के साथ संगतता सुनिश्चित करने के लिए। आप डैशबोर्ड के माध्यम से तुरंत अपनी कुली जनरेट कर सकते हैं, Google या ईमेल क्रेडेंशियल के साथ, बिना फ़ोन नंबर की आवश्यकता के।

API कुंजी आपके खाते की पहचान करती है और आपके प्रीपेड बैलेंस के खिलाफ टोकन उपयोग को ट्रैक करती है। यह कुंजी सुरक्षित रखें, क्योंकि यह आपके क्रेडिट तक सीधी पहुंच प्रदान करती है। प्रति खाते केवल एक सक्रिय कुंजी की अनुमति है; एक नई कुंजी जनरेट करने से पिछली कुंजी स्वचालित रूप से अमान्य हो जाती है।

POST /v1/chat/completions

चैट कंप्लीशन एंडपॉइंट पर एक POST अनुरोध भेजकर टेक्स्ट उत्पन्न करें। मॉडल ID है uncensored, को बदलता है, जो एक ओपन-वेइट मॉडल चलाता है जिसे कानूनी वयस्क उपयोग के लिए सामग्री अस्वीकृति के बिना उत्तर देने के लिए ट्यून किया गया है। आप मानक पैरामीटर के माध्यम से आउटपुट लंबाई, यादृच्छिकता और स्टॉपिंग कंडीशन को नियंत्रित कर सकते हैं।

यह एंडपॉइंट स्ट्रीमिंग, फंक्शन कॉलिंग और JSON मोड रिस्पॉन्स का समर्थन करता है। यह एम्बेडिंग्स, इमेजेज या फाइन-ट्यूनिंग का समर्थन नहीं करता है। वेब एप्लिकेशनों में बेहतर प्रदर्शन के लिए अनुरोध को असिंक्रोनस रूप से हैंडल करने के लिए Python SDK का उपयोग करें।

Copyfrom openai import OpenAI

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

GET /v1/models

API संरचना की पुष्टि करने के लिए उपलब्ध मॉडल की सूची पुनः प्राप्त करें। प्रतिक्रिया में शामिल है uncensored मॉडल ID, जिसे आपको अपने कम्प्लीशन रिक्वेस्ट में निर्दिष्ट करना होगा। यह एंडपॉइंट आपको यह सत्यापित करने में मदद करता है कि सेवा ऑनलाइन है और मॉडल ID बदला नहीं है।

महंगे जनरेशन अनुरोध भेजने से पहले कनेक्टिविटी समस्याओं को डिबग करने के लिए इस एंडपॉइंट का उपयोग करें। यह मानक OpenAI-संगत मॉडल मेटाडेटा लौटाता है, जिसमें मॉडल ID और ऑब्जेक्ट टाइप शामिल हैं।

Copyimport OpenAI from "openai";

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

पैरामीटर: तापमान, Top P, Seed

मानक सैम्पलिंग पैरामीटर का उपयोग करके अपने आउटपुट की यादृच्छिकता और निर्धारकता को नियंत्रित करें। सेट करें temperature 0 और 2 के बीच रचनात्मकता को समायोजित करने के लिए, और top_p न्यूक्लियस सैंपलिंग को सीमित करने के लिए। यह seed पैरामीटर आपको डीबगिंग या स्थिर रोलप्ले परिदृश्यों के लिए विशिष्ट आउटपुट पुन: उत्पन्न करने की अनुमति देता है।

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

स्ट्रीमिंग, टूल्स, और JSON मोड

कम लेटेंसी के लिए सर्वर-सेंट इवेंट्स (SSE) का उपयोग करके रियल-टाइम में स्ट्रीम रिस्पॉन्स करें। JSON मोड को सक्षम करने के लिए सेट करें response_format को json_object संरचित डेटा एक्सट्रैक्शन के लिए। टूल कॉलिंग फ़ंक्शन निष्पादन के लिए समर्थित है, जिससे मॉडल बाहरी 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)

रेट लिमिट और बिलिंग

उच्च-वॉल्यूम उपयोग के दौरान सेवा विच्छेद से बचने के लिए अपनी दर सीमाओं की निगरानी करें। API प्रति कुंजी प्रति मिनट 300 अनुरोध की एक सीमा और 8 समानांतर अनुरोधों के लिए एक समवर्ती सीमा लागू करता है। अधिकतम अनुरोध बॉडी आकार 8 MB है।

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