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

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

प्रत्येक अनुरोध को प्रमाणीकृत करें अपने API कुंजी को पास करके Authorization हेडर। सभी एंडपॉइंट्स के लिए बेस यूआरएल है https://api.notfilter.cc/v1. यह संरचना जटिल कॉन्फ़िगरेशन परिवर्तनों के बिना मौजूदा OpenAI SDKs के साथ संगतता सुनिश्चित करती है।

Copycurl https://api.notfilter.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "what is the capital of france"}]
  }'

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

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

टेक्स्ट प्रॉम्प्ट प्राप्त करें और /v1/chat/completions एंडपॉइंट। यह मॉडल के साथ इंटरैक्ट करने के लिए आपका प्राथमिक इंटरफ़ेस है। पैरामीटर कॉन्फ़िगर करें जैसे temperature और top_p प्रतिक्रिया व्यवहार को समायोजित करने के लिए।

Copyfrom openai import OpenAI

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

API एक मानक संदेश प्रारूप की उम्मीद करता है। इनपुट टेक्स्ट को टोकन में परिवर्तित किया जाता है, प्रोसेस किया जाता है, और एक सहज प्रतिक्रिया के रूप में लौटाया जाता है। त्रुटियों को मानक HTTP स्टेटस कोड के माध्यम से संभाला जाता है।

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

रियल-टाइम आउटपुट को सक्षम करने के लिए सेटिंग करें stream: true. 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)

प्रत्येक चंक आंशिक सामग्री रखता है। अंतिम चंक में टोकन उपयोग आंकड़े शामिल होते हैं। इन इवेंट्स को पार्स करें ताकि आप उपयोगकर्ताओं को टेक्स्ट को क्रमिक रूप से प्रदर्शित कर सकें।

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

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

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.notfilter.cc/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 मोड

सेट करके संरचित आउटपुट फ़ोर्स करें response_format को {"type": "json_object"}. यह सुनिश्चित करता है कि प्रतिक्रिया मान्य JSON हो। एप्लिकेशन में डेटा पार्स करने के लिए उपयोगी।

मॉडल प्रदान की गई स्कीमा का पालन करता है। JSON संरचना में त्रुटियां दुर्लभ हैं लेकिन संभव हैं। सुरक्षा के लिए अपने एप्लिकेशन परत में आउटपुट की सत्यापन करें।

रेट लिमिट्स और संदर्भ विंडो

प्रत्येक API कुंजी प्रति मिनट 300 अनुरोधों और 8 समवर्ती अनुरोधों का समर्थन करती है। प्रॉम्प्ट और कंप्लीशन के लिए संयुक्त रूप से 100,000 टोकन के लिए कंटैक्स्ट विंडो है। अधिकतम आउटपुट 16,000 टोकन है।

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