KiApi प्रलेखन: 5 मिनट में एकीकरण

शुरुआत: बेस URL और प्रमाणीकरण

KiApi OpenAI API के साथ पूर्णतः संगत है। आप base_url को अनुकूलित करके SDKs और क्लाइंट्स के मौजूदा पारिस्थितिकी तंत्र का उपयोग कर सकते हैं। सभी अनुरोधों के लिए बेस URL https://api.kiapis.com/v1 है। प्रमाणीकरण केवल एक API कुंजी के माध्यम से होता है, जिसे आप पंजीकरण के बाद अपने डैशबोर्ड पृष्ठ पर प्राप्त करते हैं। इस कुंजी को HTTP हेडर Authorization: Bearer <IHR_API_SCHLÜSSEL> में भेजा जाना चाहिए। आप किसी भी समय एक नई कुंजी उत्पन्न कर सकते हैं, जिससे पुरानी कुंजी अमान्य हो जाती है।

अन्य सेवाओं के विपरीत, हम एम्बेडिंग या फाइन-ट्यूनिंग के लिए जटिल एंडपॉइंट्स नहीं प्रदान करते हैं। हमारा फोकस शुद्ध टेक्स्ट जनरेशन पर है। KiApi एक ऐसे मॉडल के लिए आपका सीधा कनेक्शन है जो बिना सेंसर उत्तरों के लिए अनुकूलित है। अपनी पहली अनुरोध भेजने से पहले सुनिश्चित करें कि आपने अपनी पर्यावरण को सही ढंग से कॉन्फ़िगर किया है।

POST /v1/chat/completions: टेक्स्ट जनरेशन

API का हृदय एंडपॉइंट POST /v1/chat/completions है। यहाँ आप संदेशों की एक सूची (सिस्टम, उपयोगकर्ता, सहायक) भेजते हैं और एक पाठ्य उत्तर प्राप्त करते हैं। मॉडल ID पैरामीटर को uncensored पर सेट किया जाना चाहिए। उत्तर सिंक्रोनस होता है और तुरंत जनरेटेड टेक्स्ट खंड और टोकन उपयोग से संबंधित मेटाडेटा प्रदान करता है।

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

Kopierencurl https://api.kiapis.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

प्रतिक्रिया में जनरेटेड सामग्री के साथ एक JSON ऑब्जेक्ट होता है। सुनिश्चित करें कि आप अपनी अनुप्रयोग में आगे उपयोग के लिए प्रतिक्रिया से content क्षेत्र को निकालें। मानक प्रतिक्रिया में अनुरोध प्रति लागत जैसे अतिरिक्त मेटाडेटा नहीं लौटाए जाते, ये डैशबोर्ड पर पाए जाते हैं।

SSE के साथ स्ट्रीमिंग

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

यह विशेष रूप से चैट इंटरफ़ेस के लिए उपयोगी है, जहाँ तुरंत प्रतिक्रिया उपयोगकर्ता अनुभव को बेहतर बनाती है। KiApi एक स्ट्रीमिंग API के रूप में आपको लेटेंसी कम करने और एक वास्तविक समय की बातचीत का अनुभव उत्पन्न करने की अनुमति देती है। क्लाइंट को डेटा स्ट्रीम को पार्स करना चाहिए और स्ट्रीम के अंत के संकेत मिलने तक खंडों को जोड़ना चाहिए।

Kopierenstream = 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)

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

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

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

टूल परिभाषाओं की संरचना OpenAI मानक का पालन करती है। आप कई टूल्स निर्दिष्ट कर सकते हैं, और मॉडल सबसे उपयुक्त का चयन करता है। प्रतिक्रिया में टूल कॉल्स की एक सूची होती है जिसे आप अपनी बैकएंड लॉजिक में निष्पादित कर सकते हैं। यह KiApi की क्षमताओं को शुद्ध टेक्स्ट जनरेशन से कहीं अधिक बढ़ा देता है।

Kopierenfrom openai import OpenAI

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

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

GET /v1/models: उपलब्ध मॉडल

एंडपॉइंट GET /v1/models उन उपलब्ध मॉडल की सूची प्रदान करता है जिन्हें API के माध्यम से एक्सेस किया जा सकता है। यह गतिशील रूप से जाँचने के लिए उपयोगी है कि कौन से मॉडल उपलब्ध हैं, या मॉडल ID की पुष्टि करने के लिए। आमतौर पर आपको मॉडल uncensored की एक सूची प्राप्त होती है।

प्रतिक्रिया में मॉडल के बारे में मेटाडेटा शामिल है, जैसे ID, मालिक और निर्माण तिथि। कुछ अन्य APIs के विपरीत, मानक प्रतिक्रिया में सीधे अधिकतम कॉन्टेक्स्ट विंडो लंबाई या विशिष्ट मूल्य नहीं शामिल होते हैं। इन जानकारी को दस्तावेज़ीकरण या डैशबोर्ड से लिया जाना चाहिए। हालांकि, यह एंडपॉइंट क्लाइंट्स के स्वचालित कॉन्फ़िगरेशन के लिए अत्यंत आवश्यक है।

Kopierenimport OpenAI from "openai";

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

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

रेट लिमिट और त्रुटि कोड

सेवा की स्थिरता को सुनिश्चित करने के लिए, कुछ सीमाएँ लागू होती हैं। प्रति API कुंजी प्रति मिनट 300 अनुरोध अनुमत हैं। अधिकतम अनुरोध बॉडी 8 MB है। यदि आप इन सीमाओं को पार करते हैं, तो आपको HTTP स्टेटस कोड 429 Too Many Requests प्राप्त होगा। अपनी अनुप्रयोग को इसी अनुसार योजनाबद्ध करें ताकि एक्सपोनेंशियल बैकऑफ़ के साथ पुनः प्रयास लागू किया जा सके।

अन्य सामान्य त्रुटि कोड 401 Unauthorized हैं, जब API कुंजी अमान्य होती है, और 402 Payment Required हैं, जब आपका क्रेडिट समाप्त हो जाता है। KiApi एक प्रीपेड मॉडल का उपयोग करता है, इसलिए बिना क्रेडिट के अनुरोध तुरंत अस्वीकार कर दिए जाते हैं। सुनिश्चित करें कि आप अपने खाता शेष की नियमित जाँच करते हैं।

कॉन्टेक्स्ट विंडो इनपुट और आउटपुट के लिए मिलाकर 100,000 टोकन है। यदि आप इस सीमा को पार करते हैं, तो एक त्रुटि संदेश लौटाया जाता है। KiApi उन डेवलपर्स के लिए एक विश्वसनीय समाधान है जो स्पष्ट नियम और पारदर्शी सीमाओं की सराहना करते हैं।