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

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

अपने रिक्वेस्ट्स हमारे बेस यूआरएल पर भेजें हेडर में एक वैध API कुंजी के साथ।

• बेस यूआरएल: https://api.unlockedaimodels.com/v1
• हेडर: Authorization: Bearer YOUR_API_KEY

मॉडल पहचानकर्ता बस uncensored. आपको प्रति खाता एक सक्रिय कुंजी मिलती है, जो जनरेशन के दौरान किसी भी पिछली कुंजी को प्रतिस्थापित कर देती है।

Copycurl https://api.unlockedaimodels.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate the standard HTTP headers for a POST request."}]
  }'

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

The POST /v1/chat/completions एंडपॉइंट आपके टेक्स्ट को संसाधित करता है और एक कंप्लीशन लौटाता है।

यह एकमात्र टेक्स्ट एंडपॉइंट है जो हम प्रदान करते हैं। हम छवि, ऑडियो या एम्बेडिंग जनरेशन नहीं प्रदान करते हैं। मॉडल एक मानक संदेश सरणी स्वीकार करता है जिसमें आपका सिस्टम, उपयोगकर्ता और असिस्टेंट टर्न्स शामिल होते हैं।

त्रुटियाँ जैसे 401 अमान्य कुंजी को दर्शाती हैं, जबकि 402 का अर्थ है कि आपको अधिक क्रेडिट की आवश्यकता है। अनुरोध केवल तभी चार्ज किए जाते हैं जब टोकन जनरेट किए जाते हैं।

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

सेटिंग करके स्ट्रीमिंग सक्षम करें stream: true अपने अनुरोध बॉडी में।

प्रत्येक चंक आंशिक पाठ शामिल करता है, जिससे आप आउटपुट को रियल-टाइम में दिखा सकते हैं। अंतिम चंक बिलिंग पारदर्शिता के लिए पूर्ण टोकन उपयोग आंकड़े शामिल करता है।

यह विधि लंबे उत्तरों के लिए अनुपस्थित विलंबता को कम करती है, जो 16,000 टोकन से अधिक जनरेट करते समय महत्वपूर्ण है।

Copyfrom openai import OpenAI

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

फंक्शन कॉलिंग और टूल्स

स्ट्रक्चर्ड फंक्शन कॉलिंग सक्षम करने के लिए अपने रिक्वेस्ट में टूल्स परिभाषित करें।

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

सुनिश्चित करें कि आपकी टूल परिभाषाएं OpenAI स्कीमा का पालन करती हैं संगतता के लिए।

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.unlockedaimodels.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 मोड और संरचित आउटपुट

मॉडल को वैध JSON लौटने के लिए सेट करके फोर्स करें response_format: {"type": "json_object"}.

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

फंक्शन कॉलिंग के साथ, यह बाहरी वैलिडेशन लेयर्स के बिना ऑटोमेटेड टास्क के लिए एक मजबूत पाइपलाइन बनाता है।

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, और स्टॉप

तापमान के साथ रचनात्मकता को नियंत्रित करें temperature और विविधता के साथ top_p.

उपयोग करें stop सीक्वेंस का उपयोग विशिष्ट मार्कर पर जनरेशन रोकने के लिए। संदर्भ विंडो कुल 100,000 टोकन की है, अधिकतम आउटपुट 16,000 टोकन की है जब तक कि आप कम न निर्दिष्ट करें max_tokens मान (डिफ़ॉल्ट 2,048 है).

रेट लिमिट्स प्रति मिनट 300 अनुरक्षण और प्रति की 8 कंकरेंट अनुरक्षण हैं।