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 | सर्व्हरच्या बाजूने त्रुटी आली आहे | तीच विनंती पुन्हा पाठवा; त्रुटी पुन्हा आल्यास विनंतीची वेळ सपोर्ट टीमला कळवा |
तैनातीचे प्रकार
तेच मॉडेल क्लाउड API आणि ऑन-प्रिमाइसेस इंस्टॉलेशन या दोन्ही प्रकारे वापरता येते. विनंतीचे स्वरूप आणि प्रमाणीकरणाची पद्धत दोन्ही ठिकाणी समान आहे; मात्र पत्ता आणि की व्यवस्थापन स्क्रीन वेगवेगळ्या आहेत.
| घटक | क्लाउड API | ऑन-प्रिमाइसेस |
|---|---|---|
| मूलभूत पत्ता | 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 दस्तऐवजातील विनंतीचे उदाहरण कॉपी करून पहिला कॉल पाठवा.
