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

क्विकस्टार्ट: अपना पहला अनुरोध कनेक्ट करें

डैशबोर्ड पर अपनी कुंजी जनरेट करें। सभी अनुरोधों के लिए बेस URL HTTPS://api.filterno.cc/v1 है। अपनी कुंजी को bearer टोकन के रूप में Authorization हेडर में पास करें। यह सेटअप किसी भी मानक OpenAI-संगत क्लाइंट के साथ काम करता है।

एक सरल कंप्लीशन रिक्वेस्ट के तुरंत कनेक्टिविटी का परीक्षण करें। एंडपॉइंट स्टैंडर्ड चैट फॉर्मेट्स को स्वीकार करता है और कंटेंट फिल्टर्स के बिना रॉ टेक्स्ट लौटाता है।

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

एंडपॉइंट: POST /v1/chat/completions

अपने प्रॉम्प्ट्स POST /v1/chat/completions पर भेजें। यह एकमात्र चैट एंडपॉइंट है जो हम सपोर्ट करते हैं। आप एक सिस्टम निर्देश और सरलीकृत फॉर्मेट में यूजर मेसेज प्रदान करते हैं।

मॉडल पहचानकर्ता "uncensored" है। यह टेक्स्ट इनपुट प्रोसेस करता है और टेक्स्ट आउटपुट लौटाता है। यहाँ छवि या ऑडियो जनरेशन की उम्मीद न करें।

यादृच्छिकता को नियंत्रित करने के लिए तापमान सेट करें। उच्च मान अधिक रचनात्मक आउटपुट उत्पन्न करते हैं। निम्न मान निर्धारक परिणाम देते हैं। API इस एंडपॉइंट के लिए कठोरता से ओपनएआई स्कीमा का पालन करता है।

एंडपॉइंट: GET /v1/models

/v1/models पर GET अनुरोध करके उपलब्ध मॉडलों की पुष्टि करें। यह एंडपॉइंट समर्थित मॉडल IDs की एक सूची लौटाता है। आपको प्रतिक्रिया में "uncensored" देखना चाहिए।

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

प्रतिक्रिया में मॉडल ID और ऑब्जेक्ट प्रकार शामिल होता है। इसमें कीमत या सीमाएँ सूचीबद्ध नहीं होतीं। टोकन दरों के लिए दस्तावेज़ीकरण जाँचें।

पैरामीटर: तापमान, Top-P, और टूल्स

तापमान और top_p के साथ जनरेशन विविधता को नियंत्रित करें। तापमान प्रायिकता वितरण को समायोजित करता है। Top_p कम-प्रायिकता वाले टोकन को फ़िल्टर करता है। वे एक साथ रचनात्मकता और फोकस के बीच संतुलन बनाते हैं।

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

स्टॉप सीक्वेंस को जेनरेशन को जल्दी समाप्त करने के लिए सेट करें। पुनरुत्पादक परिणामों के लिए seed का उपयोग करें। उपस्थिति और आवृत्ति दंड दोहराव को कम करते हैं। ये पैरामीटर मानक OpenAI अनुमानों का पालन करते हैं।

स्ट्रीमिंग रिस्पॉन्सेस (SSE) और टोकन उपयोग

अपने अनुरोध में stream को true सेट करके स्ट्रीमिंग सक्षम करें। API सर्वर-सेंट इवेंट्स (SSE) लौटाता है। प्रत्येक चंक में आंशिक टोकन डेटा होता है।

टोकन उपयोग अंतिम चंक में दिखाई देता है। लागत ट्रैक करने के लिए इसे पढ़ें। स्ट्रीमिंग लंबे उत्तरों के लिए अनुपलब्ध विलंबता को कम करती है। यह रियल-टाइम एप्लिकेशन के लिए आदर्श है।

SSE डेटा संरचना को सावधानी से पार्स करें। नेटवर्क विघटनों को सहजता से हैंडल करें। API चंक सीमाओं के माध्यम से डेटा अखंडता सुनिश्चित करती है।

सीमाएं, त्रुटियां, और टोकन अंकगणित

आपको प्रति कुंजी 300 अनुरोध प्रति मिनट मिलते हैं। सह-संचालन 8 समानांतर अनुरोधों तक सीमित है। अधिकतम अनुरोध बॉई आकार 8 MB है।

संदर्भ विंडो 100,000 टोकन की है। इसमें प्रॉम्प्ट और कम्पलीशन शामिल हैं। अधिकतम आउटपुट 16,000 टोकन है। उपयोग को सीमित करने के लिए max_tokens सेट करें।

स्टेटस कोड्स की जांच करके त्रुटियों को हैंडल करें। 401 का अर्थ है अमान्य कुंजी। 402 का संकेत है कि कोई क्रेडिट नहीं है। 429 दर सीमा को संकेत देता है। 429 के लिए एक्सपोनेंशियल बैकऑफ़ के साथ रीट्राई करें।

cURL

Copycurl https://api.filterno.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top five risks in a standard React application."}]
  }'

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

स्ट्रीमिंग

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)