Dolphin अनकैप्ड API Documentation

आवश्यकताएँ और पर्यावरण सेटअप

किसी भी अनुरोध भेजने से पहले सुनिश्चित करें कि आपके एनवायरनमेंट में आवश्यक डिपेंडेंसियां इंस्टॉल हैं। आपको हमारे डैशबोर्ड से एक सक्रिय API कुली और Python या Node.js जैसी एक सपोर्टेड रनटाइम की आवश्यकता होगी। हमारी API को आपको डिफ़ॉल्ट OpenAI एंडपॉइंट के बजाय एक विशिष्ट बेस यूआरएल पर अनुरोध भेजने की आवश्यकता होती है।

अपनी API कुंजी को सुरक्षित रखें और इसे एक एन्वायरनमेंट वेरिएबल में संग्रहीत करें। इससे आपके कोड रिपॉजिटरी में इसकी अनजाने में खुलासा होने से बचा जा सकता है। Google या ईमेल से साइन अप करने के बाद आप तुरंत एक नई कुंजी जनरेट कर सकते हैं।

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

आधिकारिक OpenAI SDK इंस्टॉल करना

प्रमाणीकरण और अनुरूप प्रारूपण को स्वचालित रूप से संभालने के लिए आधिकारिक SDK पैकेज इंस्टॉल करें। यह लाइब्रेरी Python और Node.js दोनों वातावरण को स्थिर इंटरफ़ेस के साथ सपोर्ट करती है।

Python उपयोगकर्ताओं के लिए, लाइब्रेरी को अपने वर्चुअल एनवायरनमेंट में जोड़ने के लिए स्टैंडर्ड pip install कमांड चलाएं। Node.js डेवलपर्स को समतुल्य पैकेज इंस्टॉल करने के लिए npm का उपयोग करना चाहिए।

SDK JSON पेलोड संरचना को आपके लिए प्रबंधित करता है, इसलिए आपको केवल प्रॉम्प्ट सामग्री और तापमान या top_p जैसे पैरामीटर पर ध्यान केंद्रित करने की आवश्यकता होती है।

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

बेस URL और API कुंजी कॉन्फ़िगर करना

अपने SDK क्लाइंट को हमारे विशिष्ट बेस यूआरएल की ओर निर्देशित दें ताकि अनुरोधों को हमारी अनसेंसर्ड इंफ्रास्ट्रक्चर की ओर रूट किया जा सके। उपयोग करें https://api.dolphinuncensored.com/v1 अपने एंडपॉइंट के रूप में।

अपनी API कुंजी को प्रमाणीकरण हेडर या क्लाइंट कॉन्फ़िगरेशन ऑब्जेक्ट में सेट करें। क्लाइंट स्वचालित रूप से इस कुंजी को हर अनुरोध से जोड़ देगा।

सुनिश्चित करें कि आप अपनी कॉन्फ़िगरेशन में मॉडल ID को "uncensored" के रूप में निर्दिष्ट करते हैं। यह सर्वर को बताता है कि आपकी जनरेशन के लिए कौन सा मॉडल संस्करण उपयोग करना है।

अपना पहला चैट कंप्लीशन अनुरोध बनाना

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

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

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

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

API स्ट्रीम के अंतिम खंड में उपयोग सांख्यिकी लौटाता है। आप बिलिंग पारदर्शिता के लिए इनपुट और आउटपुट टोकन गणना की निगरानी कर सकते हैं।

अपने अनुरोध बॉडी में stream पैरामीटर को true पर सेट करें। अंतिम टेक्स्ट बनाने या इसे रियल-टाइम में प्रोसेस करने के लिए चंक पर पुनरावृत्ति करें।

त्रुटियों और रिफ्यूजल्स हैंडल करना

अपने API कुंजी के सही और समाप्त न होने की जांच करके HTTP 401 त्रुटियों को हैंडल करें। एक 402 त्रुटि अपर्याप्त पूर्व-भुगतान क्रेडिट को दर्शाती है; जारी रखने के लिए क्रिप्टो के माध्यम से टॉप अप करें।

429 स्थिति का अर्थ है कि आपने प्रति मिनट 300 अनुरोधों की दर सीमा को पार कर लिया है। पुनः प्रयास करने से पहले थोड़ा प्रतीक्षा करें या अपनी समवर्तीता को कम करें।

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

cURL

Copycurl https://api.dolphinuncensored.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "fetch the list of installed python packages"}]
  }'

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

स्ट्रीमिंग

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)