डेवलपर्स के लिए वेनेस आईएपीएआई दस्तावेज़ीकरण

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

तुरंत कनेक्ट करें बेस URL को सेट करके https://api.veniceapi.com/v1 और अपने API की को शामिल करें Authorization हेडर। आप Google या ईमेल से साइनअप करने के तुरंत बाद इस कुंजी को प्राप्त करते हैं। यह एकल मॉडल सभी टेक्स्ट जनरेशन को बिना रूटिंग लॉजिक के संभालता है। आपको कई एंडपॉइंट्स या प्रॉक्सी कॉन्फ़िगरेशन प्रबंधित करने की आवश्यकता नहीं है।

अपनी कुंजी सुरक्षित रखें। प्रत्येक खाते में एक समय में केवल एक सक्रिय कुंजी की अनुमति होती है; एक नई कुंजी जनरेट करने से पिछली कुंजी अमान्य हो जाती है। यह टोकन उपयोग और बिलिंग के लिए स्पष्ट एट्रिब्यूशन सुनिश्चित करता है।

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

टेक्स्ट अनुरोध को /v1/chat/completions मानक HTTP POST विधियों का उपयोग करने वाला एंडपॉइंट। API एक JSON पेलोड स्वीकार करता है जिसमें मॉडल का नाम, सिस्टम निर्देश और उपयोगकर्ता संदेश शामिल हैं।

एक बेसिक अनुरोध संरचना:

Copycurl https://api.veniceapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Check if the service blocks adult content in the test endpoint"}]
  }'

प्रतिक्रिया उत्पन्न टेक्स्ट, टोकन उपयोग सांख्यिकी और पूर्णता फ्लैग लौटाती है। आप पैरामीटर जैसे कि का उपयोग करके व्यवहार को समायोजित कर सकते हैं temperature या top_p. ये सेटिंग्स आउटपुट में रचनात्मकता और यादृच्छिकता को नियंत्रित करती हैं।

त्रुटियाँ मानक HTTP कोड लौटाती हैं। एक 401 अमान्य कुंजी को दर्शाता है, जबकि 402 अपर्याप्त क्रेडिट को संकेत देता है। अपने ऑटोमेशन वर्कफ़्लो में विफलताओं को सहजता से संभालने के लिए इन कोड का उपयोग करें।

Python SDK एकीकरण

अनसेंसर्ड LLM के साथ इंटरैक्ट करने के लिए आधिकारिक OpenAI Python लाइब्रेरी का उपयोग करें। वेनिहा बेस URL और अपनी API कुंजी के साथ क्लाइंट को कॉन्फ़िगर करें। यह दृष्टिकोण अनुरोध निर्माण और प्रतिक्रिया पार्सिंग को सरल बनाता है।

Copyfrom openai import OpenAI

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

यह विधि OpenAI के लिए डिज़ाइन किए गए मौजूदा कोडबेस के साथ सहजता से काम करती है। आप बिना अपनी एप्लिकेशन लॉजिक में महत्वपूर्ण बदलाव किए बेस यूआरएल बदल सकते हैं। लाइब्रेरी स्वचालित रूप से सीरियलाइजेशन और नेटवर्क कनेक्शन संभालती है।

याद रखें कि मॉडल ID को सेट किया जाना चाहिए uncensored. यह सुनिश्चित करता है कि आप Venice द्वारा प्रदान किए गए विशिष्ट ट्यून्ड मॉडल का उपयोग कर रहे हैं। अन्य मॉडल समान व्यवहार पैटर्न प्रदर्शित नहीं कर सकते हैं।

Node SDK एकीकरण

OpenAI Node SDK का उपयोग करके JavaScript या TypeScript प्रोजेक्ट्स में API इंटीग्रेट करें। सेट करें baseURL Venice एंडपॉइंट पर जाएं और अपना API कुंजी प्रदान करें। यह सेटअप सिंक्रोनस और असिंक्रोनस दोनों संचालनों का समर्थन करता है।

Copyimport OpenAI from "openai";

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

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

सुनिश्चित करें कि आप SDK के सही संस्करण को इम्पोर्ट करते हैं। पुराने संस्करण Venice API में उपलब्ध सभी फीचर्स का समर्थन नहीं कर सकते हैं। संगतता विवरण के लिए दस्तावेज़ीकरण की जांच करें।

SSE के माध्यम से स्ट्रीमिंग प्रतिक्रियाएं

रियल-टाइम आउटपुट को सक्षम करने के लिए सेटिंग करें stream पैरामीटर को true. API एक पूर्ण JSON ऑब्जेक्ट के बजाय एक सर्वर-सेंट इवेंट्स (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 यह गारंटी नहीं देती कि यदि एक साथ कई स्ट्रीम सक्रिय हों तो क्रम बना रहेगा। उच्च ट्राफिक के दौरान अपनी रेट लिमिट की निकट से निगरानी करें।

त्रुटि हैंडलिंग और सीमाएँ

API प्रति मिनट प्रति कुंजी 300 अनुरोधों की रेट लिमिट लागू करता है। समवर्ती अनुरोध प्रति कुंजी 8 तक सीमित हैं। अनुरोध बॉडी 8 MB से अधिक नहीं होनी चाहिए। इन सीमाओं को पार करने पर 429 Too Many Requests त्रुटि लौटाई जाती है।

प्रॉम्प्ट और पूर्णता के संयुक्त लिए संदर्भ विंडो का आकार 100,000 टोकन है। प्रति अनुरोध अधिकतम आउटपुट 16,000 टोकन है। यदि max_tokens अनसेट है, लिमिट 2,048 टोकन पर डिफ़ॉल्ट होती है। ट्रंक्शन से बचने के लिए अपने इनपुट्स की योजना बनाएं।

सामान्य त्रुटियों में अमान्य कुंजियों के लिए 401 और अपर्याप्त क्रेडिट के लिए 402 शामिल है। इन कोड्स को हैंडल करें ताकि उपयोगकर्ताओं से टॉप-अप का अनुरोध किया जा सके। बिलिंग समस्याओं के लिए सपोर्ट पेज का उपयोग करें। क्रेडिट कभी एक्सपायर नहीं होता है, इसलिए आप बाद में टॉप अप कर सकते हैं।