एक नज़र में

यह दस्तावेज़ CLEVI डेवलपर दस्तावेज़ का प्रारंभिक बिंदु है। इसमें Clevi-X-Platform की संरचना, API के माध्यम से कॉल किए जा सकने वाले दो मॉडल, प्रमाणीकरण विधि तथा अनुरोध और प्रतिक्रिया प्रारूप का एक साथ सारांश दिया गया है। अनुरोध और प्रतिक्रियाएँ OpenAI Chat Completions प्रारूप का पालन करती हैं, इसलिए मौजूदा OpenAI SDK में केवल base_url और api_key के इन दो मानों को बदलकर कनेक्ट करें। बिना इंस्टॉल किए पहली कॉल तक पहुँचने की प्रक्रिया Quick Start दस्तावेज़ में है।

प्लेटफ़ॉर्म संरचना

Clevi-X-Platform मॉडल, एजेंट, सिमेंटिक डेटाबेस और भौतिक AI को एक ही निष्पादन वातावरण में रखता है। इनमें से डेवलपर अभी HTTP के माध्यम से सीधे जिस स्तर को कॉल कर सकते हैं, वह मॉडल स्तर है। शेष स्तर प्लेटफ़ॉर्म के भीतर और कंसोल में संचालित होते हैं, और सार्वजनिक API की सीमा नीचे दी गई तालिका तक है।

मॉडल लाइनअप

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

• cip-5.5-im
• cip-5.5-mm

cip-5.5-im

दस्तावेज़ों, छवियों, आरेखों और कार्य डेटा को अर्थगत इकाइयों के आधार पर जोड़कर खोज परिणाम और ज्ञान संरचनाएँ बनाता है। Physical AI की योजना बनाने और पुनःयोजना बनाने के चरणों में इनपुट की व्याख्या करने के लिए भी यही मॉडल उपयोग किया जाता है। आंतरिक पहचानकर्ता के रूप में RB-IM का उपयोग किया जाता है, जबकि API में केवल cip-5.5-im ही मान्य नाम है।

cip-5.5-mm

यह टेक्स्ट, छवियों और कई दस्तावेज़ों में मौजूद जटिल संदर्भों को एक साथ पढ़कर उत्तर तैयार करता है। इसे टूल कॉल और कार्यप्रवाह निष्पादन सहित Agentic कार्यों के लिए अनुकूलित किया गया है।

मॉडल चुनें

अन्य मॉडल

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

मूल जानकारी और प्रमाणीकरण

कुंजियाँ वर्कस्पेस के आधार पर जारी की जाती हैं और प्रत्येक अनुरोध में Authorization हेडर के साथ Bearer के रूप में जोड़ी जाती हैं। नीचे दी गई तालिका में छह मान भरने पर पहली कॉल के लिए आवश्यक सेटअप पूरा हो जाता है।

तालिका और उदाहरण में sk-... जारी की गई कुंजी डालने का स्थान है। नीचे दिए गए कमांड से इसे पर्यावरण चर में सेट कर लें, तो आप इस दस्तावेज़ के उदाहरणों को ज्यों का त्यों कॉपी करके चला सकते हैं।

export CLEVI_API_KEY="sk-..."

POST /api/services/v1/aiservice/openai/v1/chat/completions

यह संदेशों की ऐरे और मॉडल का नाम प्राप्त करके, मॉडल द्वारा बनाए गए एक संदेश को choices ऐरे में रखकर लौटाता है। पूरा पता https://platform.clevi.net/api/services/v1/aiservice/openai/v1/chat/completions है। messages में कम से कम 1 संदेश ऑब्जेक्ट होना चाहिए, और प्रत्येक ऑब्जेक्ट में role और content होते हैं।

curl https://platform.clevi.net/api/services/v1/aiservice/openai/v1/chat/completions \
  -H "Authorization: Bearer $CLEVI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "cip-5.5-mm",
    "messages": [
      {"role": "system", "content": "사내 문서를 요약하는 도우미로 답한다."},
      {"role": "user", "content": "이 API 의 인증 방식을 한 문장으로 설명해 줘."}
    ]
  }'

# pip install openai
import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["CLEVI_API_KEY"],
    base_url="https://platform.clevi.net/api/services/v1/aiservice/openai/v1",
)

completion = client.chat.completions.create(
    model="cip-5.5-mm",
    messages=[
        {"role": "system", "content": "사내 문서를 요약하는 도우미로 답한다."},
        {"role": "user", "content": "이 API 의 인증 방식을 한 문장으로 설명해 줘."},
    ],
)

print(completion.choices[0].message.content)

// npm install openai
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.CLEVI_API_KEY,
  baseURL: "https://platform.clevi.net/api/services/v1/aiservice/openai/v1",
});

const completion = await client.chat.completions.create({
  model: "cip-5.5-mm",
  messages: [
    { role: "system", content: "사내 문서를 요약하는 도우미로 답한다." },
    { role: "user", content: "이 API 의 인증 방식을 한 문장으로 설명해 줘." },
  ],
});

console.log(completion.choices[0].message.content);

{
  "id": "chatcmpl-7d21b4e0",
  "object": "chat.completion",
  "created": 1755500000,
  "model": "cip-5.5-mm",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Authorization 헤더에 Bearer 와 발급받은 API 키를 넣어 인증합니다."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 38,
    "completion_tokens": 24,
    "total_tokens": 62
  }
}

रिस्पॉन्स फ़ील्ड

रिस्पॉन्स में शीर्ष स्तर के छह फ़ील्ड होते हैं। जनरेट किया गया वाक्य choices ऐरे के पहले तत्व में होता है, और टोकन उपयोग usage में होता है।

त्रुटि

विफल अनुरोध कारण की जानकारी HTTP स्टेटस कोड के माध्यम से देते हैं। पहले नीचे दिए गए उपायों की जाँच करें और यदि वही कोड बार-बार आता है, तो रिस्पॉन्स का id और अनुरोध का समय दर्ज करके रखें।

परिनियोजन रूप

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

डेटा गवर्नेंस

प्लेटफ़ॉर्म निम्नलिखित चार को डिफ़ॉल्ट व्यवहार के रूप में रखता है। वर्कस्पेस विभाजित करने के मानदंड तय करते समय इन्हें भी जाँचें।

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

आरंभ करने का क्रम

यदि आप पहली बार कनेक्ट कर रहे हैं, तो नीचे दिए गए क्रम में आगे बढ़ें। चरण 3 तक पूरा करने के बाद, आप एक ही कुंजी से दोनों मॉडलों को कॉल कर सकते हैं।

1. https://platform.clevi.net/account/login पर लॉग इन करें या खाता बनाएँ।
2. https://clevi.app/cloud पर वर्कस्पेस जोड़ें।
3. https://clevi.app/cloud/keys पर कुंजी जारी करें और उसे पर्यावरण चर में सहेजें।
4. https://clevi.app/cloud/playground पर cip-5.5-im और cip-5.5-mm की प्रतिक्रियाओं की तुलना करें।
5. Quick Start दस्तावेज़ में दिए गए अनुरोध उदाहरण को कॉपी करके पहला कॉल भेजें।

वर्कस्पेस बनाएँ

API कुंजी जारी करें

प्लेलैंड खोलें