विशेषताओं का सारांश
यदि आपके पास पहले से OpenAI से बात करने वाला कोड है, तो OpenAI-संगत API विनिर्देश का संक्षिप्त संस्करण यह है: बेस URL बदलें, कुंजी बदलें, और मॉडल को uncensored पर सेट करें। अनुरोध और प्रतिक्रिया बॉडी चैट पूर्णता के आकार का पालन करती हैं, इसलिए SDK उन्हें बिना किसी बदलाव के पार्स कर लेते हैं।
| आइटम | मान |
|---|---|
| बेस URL | https://api.unrestrictedaiapi.com/v1 |
| Auth | Authorization: Bearer YOUR_KEY |
| विधियाँ | POST /v1/chat/completions, GET /v1/models |
| मॉडल ID | uncensored |
| कॉन्टेक्स्ट विंडो | 100,000 टोकन, प्रॉम्प्ट और पूर्णता |
| अधिकतम अनुरोध बॉडी | 8 MB |
| आउटपुट | केवल टेक्स्ट |
यह मॉडल एक स्वतंत्र प्रदाता द्वारा संचालित एकल ओपन-वेट मॉडल है जिसे कानूनी वयस्क उपयोग के लिए सामग्री अस्वीकृति के बिना उत्तर देने के लिए ट्यून किया गया है। यह किसी भी मॉडल विक्रेता का आधिकारिक एंडपॉइंट नहीं है और यह विक्रेताओं के बीच रूट नहीं करता है। यही एकल मॉडल ID होने और मॉडल सूची के छोटी होने का कारण है।
विधियाँ
GET /v1/models
आपकी कुंजी के लिए उपलब्ध मॉडल लौटाता है। यह पुष्टि करने का सबसे सस्ता तरीका है कि आपकी कुंजी और बेस URL सही हैं, और कई UI क्लाइंट ड्रॉपडाउन भरने के लिए इसका उपयोग करते हैं।
curl https://api.unrestrictedaiapi.com/v1/models \
-H "Authorization: Bearer $KEY"
POST /v1/chat/completions
एकमात्र जनरेशन एंडपॉइंट। आप messages ऑब्जेक्ट्स की एक सरणी भेजते हैं जिसमें role (system, user, assistant या tool) और content होता है, साथ ही मॉडल और कोई भी सैंपलिंग विकल्प। एक न्यूनतम कॉल:
curl https://api.unrestrictedaiapi.com/v1/chat/completions \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [
{"role": "system", "content": "Answer in one sentence."},
{"role": "user", "content": "What is a base URL?"}
]
}'
प्रतिक्रिया में जनरेटेड टेक्स्ट choices[0].message.content में होता है और टोकन गणना usage में होती है। वही गणना बिलिंग के आधार के रूप में कार्य करती है।
पेश नहीं किया गया: विरासत कंप्लीशन्स एंडपॉइंट, एम्बेडिंग्स, इमेज, ऑडियो और वीडियो एंडपॉइंट, फाइन-ट्यूनिंग और फ़ाइल एंडपॉइंट। एक क्लाइंट जो इन्हें कॉल करता है, उसे एक त्रुटि प्राप्त होगी, इसलिए उन उपकरणों में जहाँ वे डिफ़ॉल्ट रूप से उपयोग किए जाते हैं, उन सुविधाओं को अक्षम करें।
अनुरोध पैरामीटर
ये पैरामीटर स्वीकार किए जाते हैं और मॉडल को पास किए जाते हैं:
temperatureऔरtop_pनमूनीकरण के लिए।stopएक या एक से अधिक स्टॉप सीक्वेंस के लिए।seedदोहराए जाने योग्य सैंपलिंग के लिए जब आप बाकी सब कुछ समान रखते हैं।presence_penaltyऔरfrequency_penaltyrepetition कम करने के लिए।max_tokens, जो वैकल्पिक है। यदि आप इसे छोड़ देते हैं, तो पूर्णता 100,000-टोकन विंडो की शेष अवधि का उपयोग कर सकती है।streamसर्वर-सेंट इवेंट्स के लिए।toolsऔरtool_choiceफ़ंक्शन कॉलिंग के लिए।response_format{"type":"json_object"}के साथ JSON mode के लिए।
दो व्यावहारिक नोट। पहला, विंडो प्रॉम्प्ट और कंप्लीशन दोनों की गणना करती है, इसलिए एक 90,000-टोकन प्रॉम्प्ट उत्तर के लिए लगभग 10,000 टोकन छोड़ता है। दूसरा, बॉडी की सीमा 8 MB है, जो 100,000 टोकन पाठ की आवश्यकता से कहीं अधिक है, इसलिए आप इसे केवल संदेशों में बड़े एन्कोडेड पेलोड एम्बेड करके ही प्राप्त कर सकते हैं।
स्ट्रीमिंग
stream: true सेट करें और response server-sent events के रूप में आता है। प्रत्येक event एक JSON chunk होता है जिसमें delta होता है जो अगला text piece रखता है, और stream के अंत में usage की रिपोर्ट की जाती है। SDKs framing को छिपा देते हैं; raw protocol के साथ आप data: से शुरू होने वाली lines पढ़ते हैं जब तक stream बंद नहीं हो जाती।
from openai import OpenAI
client = OpenAI(base_url="https://api.unrestrictedaiapi.com/v1", api_key="YOUR_KEY")
with client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "List five HTTP status codes."}],
stream=True,
) as stream:
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="")
एक नियम capacity planning को प्रभावित करता है: एक streamed request concurrency slot को तब तक पकड़े रखता है जब तक stream खत्म नहीं हो जाती, न कि जब तक पहला token नहीं आ जाता। यदि एक client पढ़ते समय stall हो जाता है, तो वह slot को busy रखता है। हमेशा stream को बंद या finish करें, और client timeout सेट करें।
टूल कॉलिंग और JSON मोड
टूल कॉलिंग
tools JSON Schema parameters के साथ function definitions की सूची के रूप में पास करें। यदि मॉडल किसी function को call करने का निर्णय लेता है, तो message में tool_calls होता है, जो stream on होने पर भी streamed होते हैं। आप function चलाते हैं और role: "tool" और matching tool_call_id के साथ message के रूप में उसका परिणाम वापस भेजते हैं। tool_choice का उपयोग किसी विशेष function को force करने या निर्णय मॉडल पर छोड़ने के लिए करें।
{
"model": "uncensored",
"messages": [{"role": "user", "content": "Weather in Oslo?"}],
"tools": [{
"type": "function",
"function": {
"name": "get_weather",
"description": "Current weather for a city",
"parameters": {
"type": "object",
"properties": {"city": {"type": "string"}},
"required": ["city"]
}
}
}]
}
मॉडल तर्कों का प्रस्ताव रखता है; यह कुछ भी निष्पादित नहीं करता है। किसी भी उपयोगकर्ता इनपुट की तरह, उन पर कार्य करने से पहले उन्हें सत्यापित करें।
JSON मोड
एक मान्य JSON ऑब्जेक्ट मांगने के लिए "response_format": {"type": "json_object"} जोड़ें। अन्य OpenAI-शैली की कार्यान्वयनों की तरह, प्रॉम्प्ट में मॉडल को बताएं कि आपको किन कुंजियों की आवश्यकता है, उदाहरण के लिए "title और tags कुंजियों वाले एक ऑब्जेक्ट लौटाएं"। किसी try ब्लॉक में परिणाम को पार्स करें, और max_tokens को उदार रखें ताकि एक लंबा ऑब्जेक्ट काटा न जाए।
सीमाएं, हेडर और त्रुटियां
| कुंजी का प्रकार | समकालीय अनुरोध | प्रति मिनट अनुरोध |
|---|---|---|
| पूर्ण कुंजी | 8 | 300 |
| ट्रायल कुंजी | 2 | 60 |
प्रत्येक प्रतिक्रिया में X-Request-Id (जब आप support से संपर्क करें तो इसे उद्धृत करें), X-Balance-USD (आपका शेष क्रेडिट), X-RateLimit-Limit-Requests और X-RateLimit-Limit-Concurrency शामिल होता है।
जब आप एक सीमा पार करते हैं, तो API HTTP 429 लौटाता है। त्रुटि कोड मामलों को अलग करता है:
rate_limited: एक मिनट में बहुत सारे अनुरोध। गति कम करें या लोड बांटें।concurrency: एक साथ बहुत सारे चल रहे अनुरोध। उन्हें अपनी ओर से कतार में लगाएं।- 429
Retry-After: 5हेडर के साथ: अस्थायी ओवरलोड। पांच सेकंड प्रतीक्षा करें और पुनः प्रयास करें।
import time
import httpx
def post_with_retry(payload, key, tries=4):
# payload example: {"model": "uncensored", "messages": [...]}
for attempt in range(tries):
r = httpx.post(
"https://api.unrestrictedaiapi.com/v1/chat/completions",
headers={"Authorization": "Bearer " + key},
json=payload,
timeout=120,
)
if r.status_code == 429:
wait = int(r.headers.get("Retry-After", 2 ** attempt))
time.sleep(wait)
continue
return r
return r
जो अनुरोध विफल होते हैं या अस्वीकृत किए जाते हैं, उनका शुल्क नहीं लगाया जाता है।
भूमिकाएं, इतिहास और प्रतिक्रिया ऑब्जेक्ट
API स्टेटलेस है। यह पिछले अनुरोधों को याद नहीं रखता, इसलिए एक संवाद केवल उसी messages सरणी के रूप में मौजूद होता है जिसे आप हर बार भेजते हैं। एक सामान्य इतिहास एक system संदेश से शुरू होता है जो व्यवहार सेट करता है, इसके बाद बारी-बारी से user और assistant संदेश आते हैं। जब फ़ंक्शन कॉलिंग चल रही हो, तो tool संदेश उनके बीच प्रकट होते हैं, प्रत्येक tool_call_id द्वारा उस कॉल से जुड़ा होता है जिसका वह जवाब देता है।
इसके दो परिणाम हैं। पहला लागत है: हर टर्न में पूरे इतिहास को इनपुट के रूप में भुगतान किया जाता है, इसलिए लंबी चैट में संदेश प्रति अधिक महंगी हो जाती है भले ही प्रत्येक प्रश्न छोटा हो। दूसरा नियंत्रण है: आप इच्छानुसार इतिहास को संपादित, काट या पुनर्लेखन कर सकते हैं। सबसे पुराने टर्न को हटाना, उन्हें सारांश से बदलना या एक सुधारा गया assistant संदेश इंजेक्ट करना सभी सामान्य ऑपरेशन हैं, और मॉडल आपके द्वारा भेजे गए किसी भी चीज़ को सत्य मानता है।
वापसी पर, तीन चीज़ें पढ़ें। choices[0].message टेक्स्ट या टूल कॉल्स रखता है। choices[0].finish_reason बताता है कि जनरेशन क्यों रुका: एक प्राकृतिक अंत, टोकन सीमा, या एक टूल कॉल। usage प्रॉम्प्ट, कंप्लीशन और कुल टोकन गणनाएँ रखता है। यदि फिनिश रीजन बताता है कि टोकन सीमा टकरा गई है, तो टेक्स्ट अपूर्ण है, और आपको या तो सीमा बढ़ानी चाहिए या मॉडल से एक फॉलो-अप टर्न में जारी रखने के लिए कहना चाहिए।
एक छोटी संगतता जांच सूची
इस एंडपॉइंट के खिलाफ एक क्लाइंट शिप करने से पहले, इन जांच से गुजरें। ये कुछ ही मिनटों में अधिकांश एकीकरण समस्याओं को पकड़ते हैं।
- अपनी कुंजी के साथ
GET /v1/modelsकॉल करें और पुष्टि करें कि आपको एक सूची मिलती है जिसमेंuncensoredशामिल है। - बिना किसी विकल्प के एक साधारण चैट अनुरोध भेजें और एक सामान्य प्रतिक्रिया की पुष्टि करें जिसमें एक
usageब्लॉक हो। - इसे
stream: trueके साथ दोहराएं और पुष्टि करें कि आपका क्लाइंट स्ट्रीम के अंत और अंतिम उपयोग डेटा को संभालता है। - यदि आप टूल्स का उपयोग करते हैं, तो एक टूल-कॉल राउंड ट्रिप को अंत तक भेजें, जिसमें
toolसंदेश के साथ फॉलो-अप अनुरोध भी शामिल है। - एक ट्रायल कुंजी पर एक साथ 10 अनुरोध भेजें और पुष्टि करें कि आपका कोड दूसरे समवर्ती अनुरोध के बाद आने वाले 429 को संभाल लेता है।
- हर कॉल के लिए
X-Request-Idलॉग करें ताकि कोई भी अजीब परिणाम बाद में ट्रैक किया जा सके।
सभी छह पास करना इसका मतलब है कि आपका क्लाइंट असली ट्रैफ़िक के लिए तैयार है।
यह पूर्ण OpenAI प्लेटफ़ॉर्म से कैसे अलग है
संगतता का मतलब चैट प्रोटोकॉल है, पूरी प्लेटफ़ॉर्म नहीं। टेक्स्ट चैट के बाहर कुछ भी अनुपस्थित है, और कुछ व्यवहार प्रोटोकॉल से नहीं बल्कि मॉडल से आते हैं। मॉडल का नाम स्थिर है, उत्तर किसी भी मॉडल से जिसका आपने पहले उपयोग किया है, शैली में अलग हो सकते हैं, और समान seed के साथ सैंपलिंग केवल तभी दोहराया जा सकता है जब प्रॉम्प्ट और पैरामीटर समान रहें।
वह एकमात्र सामग्री नियम जिसे आप बदल नहीं सकते वह है कि नाबालिगों से जुड़े यौन सामग्री को ब्लॉक किया गया है। इसके अलावा, मॉडल कानूनी वयस्कों के उपयोग के लिए अस्वीकृतियों से बचने के लिए ट्यून्ड है, और प्रॉम्प्ट को प्रशिक्षण के लिए उपयोग नहीं किया जाता है।
पाँच भाषाओं में कोड के लिए क्विकस्टार्ट देखें, बिना प्रतिबंध वाले मॉडल को प्रॉम्प्ट करने के लिए प्रॉम्प्टिंग पढ़ें, और खाता पक्ष के लिए, मूल्य निर्धारण में दरें दी गई हैं: 1M इनपुट टोकन के लिए $0.15 और 1M आउटपुट टोकन के लिए $0.50, जिसमें क्रेडिट कभी समाप्त नहीं होता है। दस्तावेज़ में संक्षिप्त रूप में वही विनिर्देश है।
