Developer guide
एक नजरमे
एक नजरमे
ई दस्तावेज CLEVI डेवलपर दस्तावेजक शुरुआत अछि। एहिमे Clevi-X-Platform केर संरचना, API सँ कॉल कएल जा सकयवला दू मॉडल, प्रमाणीकरणक तरीका, आ अनुरोध आ प्रतिक्रियाक प्रारूपकेँ एक ठाम संक्षेपमे प्रस्तुत कएल गेल अछि। अनुरोध आ प्रतिक्रिया OpenAI Chat Completions प्रारूपक पालन करैत अछि, तेँ मौजूदा OpenAI SDK मे base_url आ api_key ई दू मान मात्र बदलि कऽ कनेक्ट करू। बिना इंस्टॉलेशन पहिल कॉल धरि पहुँचेबाक प्रक्रिया Quick Start दस्तावेजमे अछि।
प्लेटफॉर्मक संरचना
Clevi-X-Platform मॉडल, एजेन्ट, सिमेन्टिक डेटाबेस आ भौतिक AI केँ एकहि निष्पादन वातावरणमे रखैत अछि। एहि सभमे डेवलपर एखन HTTP सँ प्रत्यक्ष रूपेँ जे कॉल करैत छथि, से मॉडल स्तर अछि। बाकी स्तर प्लेटफॉर्मक भीतर आ कन्सोलमे चलैत अछि, आ सार्वजनिक API नीचाँक तालिकामे देखाओल सीमाधरि उपलब्ध अछि।
| स्तर | जे संभालल जाइत अछि | वर्तमान सार्वजनिक सीमा |
|---|---|---|
| मॉडल | टेक्स्ट आ इमेज इनपुट लऽ प्रतिक्रिया टोकन उत्पन्न करैत अछि | chat completions एन्डपॉइंट द्वारा सार्वजनिक |
| एजेन्ट | उद्देश्य-आधारित तर्क, टूल कॉल, आ चरणबद्ध आधार उत्पन्न करैत अछि | कन्सोल आ प्लेग्राउन्ड |
| सिमेन्टिक DB | दस्तावेज·इमेज·ड्रॉइङ·कार्य डेटा केँ अर्थक इकाइमे जोड़ैत अछि | कन्सोल |
| भौतिक AI | रोबोटक गतिविधिक योजना आ पुनःयोजना बनबैत अछि | इंस्टॉलेशन इकाइक आधारपर परामर्श |
मॉडल लाइनअप
अनुरोधक मुख्य भागक model फील्डमे नीचाँ देल गेल दू नाममे सँ कोनो एकटा ज्योंकात्यों राखू। दुनू मॉडल एकहि पता, एकहि प्रमाणीकरण, आ एकहि अनुरोध प्रारूपक उपयोग करैत अछि।
- cip-5.5-im
- cip-5.5-mm
| मॉडल | स्वरूप | इनपुट | मुख्य उपयोग |
|---|---|---|---|
| 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 कार्य लेल ई मॉडल अनुकूलित अछि।
मॉडल चुनू
| जे करय चाहैत छी | चुनबाक मॉडल |
|---|---|
| आंतरिक दस्तावेज आ ड्रॉइंग मे प्रमाण देनिहार अनुच्छेद खोजब | cip-5.5-im |
| खोज परिणाम सभ केँ अर्थक आधार पर जोड़ि कऽ ज्ञान मे बदलनाइ | cip-5.5-im |
| रोबोट कार्य योजनाक इनपुटक व्याख्या | cip-5.5-im |
| छवि आ पाठ केँ एकसाथ पढ़ि कऽ निर्णय लेनाइ | cip-5.5-mm |
| उपकरण कॉल आवश्यक बहु-चरणीय कार्य | cip-5.5-mm |
| अनेक दस्तावेज केँ जोड़ि कऽ विश्लेषणात्मक उत्तर लिखनाइ | cip-5.5-mm |
अन्य मॉडल
प्लेटफ़ॉर्म पर नीचाँ देल मॉडल सभ सेहो उपलब्ध अछि। तिनकर परिनियोजन रूप आ पहुँच मार्ग अलग-अलग अछि, तेँ सार्वजनिक API नाम अलग सँ देल गेल अछि।
| मॉडल | स्वरूप |
|---|---|
| Cip-5-X | चरण-दर-चरण प्रमाण प्रस्तुत करनिहार मल्टीमॉडल जटिल विश्लेषण मॉडल |
| Cip-5-Agent | परिस्थिति अनुसार निर्णय आ दोहराएल जाएवाला कार्यक निष्पादन करयवाला एजेंट-विशेषीकृत रीजनिंग मॉडल |
| Cip-5-Vision | छवि·वीडियो·पाठ·समय-श्रृंखला केँ एकसाथ व्याख्या करनिहार विज़न मॉडल |
| Ivy-3-Text | छोट उपकरण आ एज वातावरण मे चलयवाला ऑन-डिवाइस हल्का LLM |
| Ivy-4-mm | पाठ·छवि·ध्वनि केँ एकसाथ संसाधित करनिहार बड़का non-reasoning मॉडल |
मूलभूत जानकारी आ प्रमाणीकरण
की केँ वर्कस्पेसक आधार पर जारी कएल जाइत अछि आ प्रत्येक अनुरोध मे Authorization हेडर मे Bearer केर रूप मे जोड़ल जाइत अछि। नीचाँक तालिकाक छओटा मान सँ पहिल कॉल लेल आवश्यक सेटिंग पूरा भऽ जाइत अछि।
| आइटम | मान |
|---|---|
| मूल पता | https://platform.clevi.net/api/services/v1/aiservice/openai/v1 |
| प्रमाणीकरण हेडर | Authorization: Bearer sk-... |
| अनुरोध बॉडी प्रारूप | application/json |
| अनुरोध·प्रतिक्रिया विनिर्देशन | OpenAI Chat Completions संगत |
| कॉल कएल जा सकय वाला मॉडल | cip-5.5-im, cip-5.5-mm |
| कुंजी जारी करबाक पृष्ठ | https://clevi.app/cloud/keys |
तालिका आ उदाहरणमे देल 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 होयत।
| नाम | प्रारूप | आवश्यक | विवरण |
|---|---|---|---|
| model | string | हँ | cip-5.5-im अथवा cip-5.5-mm |
| messages | array | हँ | वार्तालापक संदेश ऑब्जेक्टसभक एरे। कम-सँ-कम 1टा |
| messages[].role | string | हँ | system · user · assistant मे सँ कोनो एक |
| messages[].content | string | हँ | संदेशक मुख्य पाठ |
| stream | boolean | नहि | true भेलापर प्रतिक्रियाकेँ server-sent events टुकड़ामे बाँटि कऽ प्राप्त करैत अछि |
| max_tokens | integer | नहि | प्रतिक्रियामे उत्पन्न करबाक अधिकतम टोकन संख्या |
| temperature | number | नहि | मान जतेक बेसी होयत, ओतेक बेसी संभावना रहत जे एकहि अनुरोधपर अलग-अलग प्रतिक्रिया भेटत |
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 मे अछि।
| नाम | प्रारूप | विवरण |
|---|---|---|
| id | string | एकटा अनुरोधकेँ सूचित करयवाला पहचानकर्ता। त्रुटिकेँ संबंधी पूछताछक समय एकरा संग पठाउ |
| object | string | chat.completion। स्ट्रीमिंग अंश chat.completion.chunk होइत अछि |
| created | integer | प्रतिक्रिया बनल समयक Unix सेकंड |
| model | string | प्रतिक्रिया बनौनिहार मॉडल केर नाम |
| choices | array | उत्पन्न परिणामक ऐरे |
| choices[].index | integer | ऐरे मे क्रमांक। 0 सँ शुरू होइत अछि |
| choices[].message.role | string | assistant |
| choices[].message.content | string | उत्पन्न प्रतिक्रियाक मुख्य पाठ |
| choices[].finish_reason | string | उत्पादन रुकबाक कारण। अन्त धरि उत्पादन भेलापर stop |
| usage.prompt_tokens | integer | इनपुटमे प्रयुक्त टोकनक संख्या |
| usage.completion_tokens | integer | उत्पन्न टोकनक संख्या |
| usage.total_tokens | integer | उपरोक्त दुनू मानक योग |
त्रुटि
विफल अनुरोध HTTP स्थिति कोड द्वारा कारण बतबैत अछि। पहिने नीचाँ देल उपाय जाँचू, आ जँ समान कोड दोहराइत रहय तँ प्रतिक्रियाक id आ अनुरोधक समय लिखि कऽ राखू।
| कोड | अर्थ | उपाय |
|---|---|---|
| 400 | अनुरोधको मुख्य भाग निर्धारित ढाँचासँग मेल खाएन | model आ messages अछि कि नहि, आ JSON बन्द भेल अछि कि नहि जाँचू |
| 401 | कुंजी अनुपस्थित वा अमान्य अछि | हेडर Bearer सँ शुरू होइत अछि कि नहि, आ कुंजीको मान जस्ताको तस्तै प्रतिलिपि भेल अछि कि नहि जाँचू |
| 403 | ई कुंजीसँ पहुँच प्राप्त नहि कऽ सकैत छी | कुंजी जारी करनिहार वर्कस्पेस आ अनुरोध कएल मॉडल नाम जाँचू |
| 404 | मार्ग उपलब्ध नहि अछि | ठेगानाक अन्त /v1/chat/completions अछि कि नहि जाँचू |
| 429 | कम समयमे बहुत रास अनुरोध आएल अछि | पुनः प्रयासक अन्तराल दुगुना करैत फेर पठाउ |
| 500 | सर्भर-पक्षमे त्रुटि अछि | समान अनुरोध फेर पठाउ, आ समस्या दोहराए तँ सहायता टीमकेँ अनुरोधक समय बताउ |
परिनियोजनक रूप
समान मॉडल cloud API आ on-premises स्थापना—दुनू रूपमे उपयोग होइत अछि। अनुरोधक ढाँचा आ प्रमाणीकरणक तरीका दुनूमे समान अछि, मुदा पता आ कुंजी व्यवस्थापनक पर्दा अलग अछि।
| मद | cloud API | on-premises |
|---|---|---|
| मूल पता | platform.clevi.net | स्थापित निजी नेटवर्कक पता |
| कुंजी जारीकरण | https://clevi.app/cloud/keys | स्थापना वातावरणक प्रशासक कन्सोल |
| प्रमाणीकरणक तरीका | Bearer टोकन | Bearer टोकन |
| डेटा भण्डारणक स्थान | CLEVI क्लाउड | ग्राहकक पूर्वाधारक भीतर |
डेटा शासन
प्लेटफॉर्म निम्न चारिटा बातकेँ मूलभूत व्यवहार मानैत अछि। वर्कस्पेस विभाजनक मापदण्ड तय करैत समय एकरा संगहि जाँचू।
- अधिकार-आधारित नियन्त्रण — वर्कस्पेसक आधार पर पहुँच अधिकार आ कुंजी अलग करैत अछि।
- पृथक कार्यक्षेत्र — वर्कस्पेससभक बीच डेटा मिश्रित नहि होइत अछि।
- रियल-टाइम डेटा कनेक्शन — बाहरी प्रणालीसँ जोड़ल डेटा देखबाक समयमे आनल जाइत अछि।
- प्रक्रियाक आधार पर अभिलेख संरक्षण — निष्पादित कार्यक एकाइका आधार पर अभिलेख राखल जाइत अछि।
प्रारम्भक क्रम
यदि अहाँ पहिल बेर कनेक्ट क' रहल छी, तँ नीचाँ देल क्रमसँ आगाँ बढ़ू। 3 धरि पूरा क' लेलापर एक्केटा की सँ दुनू मॉडल केँ कॉल क' सकैत छी।
- https://platform.clevi.net/account/login पर लॉगिन करू अथवा खाता बनाउ।
- https://clevi.app/cloud पर वर्कस्पेस जोड़ू।
- https://clevi.app/cloud/keys पर की जारी क' क' एकरा वातावरण चरमे सुरक्षित राखू।
- https://clevi.app/cloud/playground पर cip-5.5-im आ cip-5.5-mm केर प्रतिक्रियाक तुलना करू।
- Quick Start दस्तावेजक अनुरोध उदाहरण कॉपी क' पहिल कॉल पठाउ।
