API दस्तावेज़: Quickstart Guide

बेस URL और प्रमाणीकरण

Heretic AI API पूरी तरह से OpenAI-संगत है। आप इसे इस प्रकार इंटरैक्ट करते हैं कि अपने क्लाइंट को हमारे बेस यूआरएल की ओर इशारा करें: https://api.hereticai.cc/v1. प्रमाणीकरण खाते के लिए एकल API कुंजी पर निर्भर करता है, जो Google या ईमेल के माध्यम से साइनअप के तुरंत जनरेट होता है। इस कुंजी को Authorization हेडर को Bearer टोकन के रूप में सेट करें। मॉडल पहचानकर्ता बस uncensored. यह एकल मॉडल सभी आपके अनुरोधों को रूटिंग जटिलता के बिना संभालता है। 401 जैसे त्रुटियां एक अमान्य कुंजी को इंगित करती हैं, जबकि 402 का अर्थ है कि आपको अधिक प्रीपेड क्रिप्टो क्रेडिट की आवश्यकता है।

Copycurl https://api.hereticai.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "generate twenty test cases"}]
  }'

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

मानक का उपयोग करके टेक्स्ट अनुरोध भेजें POST /v1/chat/completions एंडपॉइंट। एपीआई आपके संवाद इतिहास या प्रॉम्प्ट वाले एक मानक संदेशों के सरली की उम्मीद करता है। यह उत्पन्न टेक्स्ट को choices array. यह एक शुद्ध यूटिलिटी API है: टेक्स्ट इन, टेक्स्ट आउट। आप केवल खपत किए गए टोकन के लिए भुगतान करते हैं। प्रीपेड क्रेडिट कभी समाप्त नहीं होता है, और अस्वीकार या त्रुटियां टोकन नहीं खर्च करतीं। यह दृष्टिकोण सब्सक्रिप्शन लॉक और अप्रत्याशित फ्री टियर्स को समाप्त करता है।

Copyfrom openai import OpenAI

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

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

रियल-टाइम टोकन स्ट्रीमिंग सक्षम करने के लिए stream: true अपने अनुरोध में। API प्रत्येक जनरेटेड टोकन के लिए सर्वर-सेंटेड इवेंट्स (SSE) लौटाता है। यह आपको आउटपुट को प्रगतिशील रूप से प्रदर्शित करने की अनुमति देता है, जो विलंबता-संवेदी एप्लिकेशन के लिए महत्वपूर्ण है। टोकन उपयोग आंकड़े स्ट्रीम के अंतिम चंक में दिखाई देते हैं। यह सुविधा मानक OpenAI SDKs के साथ सहजता से काम करती है जो SSE को स्वचालित रूप से हैंडल करते हैं। यह पूरी कंप्लीशन की प्रतीक्षा किए बिना तत्क प्रतिक्रिया प्रदान करता है।

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)

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

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

JSON मोड

सुनिश्चित करें निर्धारक आउटपुट सेट करके response_format को {"type": "json_object"}. मॉडल अपनी प्रतिक्रिया को वैध JSON तक सीमित करेगा, जो प्रोग्रामेटिक पार्सिंग के लिए महत्वपूर्ण है। इससे पोस्ट-प्रोसेसिंग रेगेक्स फिक्स की आवश्यकता कम हो जाती है। यह गारंटी देता है कि आउटपुल को सीधे आपके कोड द्वारा उपभोग किया जा सकता है। यह संरचित डेटा एक्सट्रैक्शन या कॉन्फ़िगरेशन जनरेशन कार्यों के लिए विशेष रूप से उपयोगी है।

पैरामीटर और सीमाएं

तापमान और top_p जैसे मानक पैरामीटर के साथ जनरेशन को नियंत्रित करें। temperature, top_p, और seed. कॉन्टेक्स्ट विंडो प्रॉम्प्ट plus कंप्लीशन के लिए 100,000 टोकन है। अधिकतम आउटपुट प्रति अनुरोध 16,000 टोकन है, या 2,048 यदि max_tokens अनसेट है। रेट लिमिट्स प्रति मिनट 300 अनुरोध और प्रति कुंजी 8 समवर्ती अनुरोध हैं। अनुरोध बॉडी 8 MB से कम रहनी चाहिए। ये सीमाएं डेवलपर्स के लिए स्थिर उच्च-वॉल्यूम उपयोग को सुनिश्चित करती हैं।

Node.js

Copyimport OpenAI from "openai";

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