API दस्तावेज़: OpenAI-Compatible Endpoints

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

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

Copycurl https://api.apikeykimi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "convert this json object to python dictionary syntax"}]
  }'

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

मानक का उपयोग करके मॉडल को संदेश भेजें /v1/chat/completions एंडपॉइंट। मॉडल आईडी को uncensored अनुरोध बॉडी में। API आपके प्रॉम्प्ट इतिहास के आधार पर जनरेटेड टेक्स्ट लौटाता है। आप रचनाशीलता को नियंत्रित करने के लिए तापमान और top_p जैसे पैरामीटर समायोजित कर सकते हैं। मॉडल संरचित आउटपुट के लिए फंक्शन कॉलिंग और JSON मोड का समर्थन करता है।

Copyfrom openai import OpenAI

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

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

रियल-टाइम टोकन डिलीवरी को सक्षम करने के लिए सेटिंग करें stream: true आपके अनुरोध में। सर्वर एक Server-Sent Events स्ट्रीम लौटाता है। प्रत्येक chunk में आंशिक पाठ होता है जब तक कि प्रतिक्रिया पूर्ण न हो जाए। यह चैट इंटरफ़ेस और लाइव कोडिंग प्रदर्शनों के लिए आदर्श है। टोकन उपयोग विवरण स्ट्रीम के अंतिम chunk में दिखाई देते हैं।

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)

फंक्शन कॉलिंग & JSON मोड

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

टोकन सीमाएँ & बाधाएँ

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

त्रुटि हैंडलिंग & उपयोग सीमाएँ

HTTP स्टेटस कोड की जांच करके त्रुटियों को हैंडल करें। A 401 एक अमान्य या समाप्त API कुंजी को संकेत देता है। A 402 त्रुटि का अर्थ है कि आपका प्रीपेड क्रेडिट समाप्त हो गया है। A 429 रिस्पॉन्स संकेत देता है कि आप प्रति मिनट 300 अनुरोधों की दर सीमा से अधिक चले गए हैं। त्रुटियां और अस्वीकृतियां टोकन खर्च नहीं करतीं। रुकावटों से बचने के लिए डैशबोर्ड पर अपना बैलेंस जांचें।

Node.js

Copyimport OpenAI from "openai";

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