Developer guide
Gabaabumatti ilaali
Gabaabumatti ilaali
Dokumantiin kun bakka jalqabaa dokumantoota misoomsitootaa CLEVI ti. Qindaa'ina Clevi-X-Platform, moodeelota lama API'n waamamuu danda'an, mala mirkaneessaa, akkasumas bifa gaaffii fi deebii bakka tokkotti ibsa. Gaaffii fi deebiin bifa OpenAI Chat Completions hordofu; kanaaf, OpenAI SDK duraan jiru keessatti gatiiwwan lama qofa, jechuun base_url fi api_key, jijjiiruun wal qunnamsiisu dandeessa. Adeemsa waamicha jalqabaa fe'iinsa malee hordofuuf, dokumantii Quick Start ilaali.
Qindaa'ina pilaataformii
Clevi-X-Platform moodeelota, ejentoota, kuusdeetaa semaantikaa fi AI fiizikaalaa naannoo raawwii tokko keessa kaa'a. Isaan keessaa, wanti misoomsitoonni amma HTTP'n kallattiin waaman sadarkaa moodeelotaa ti. Sadarkaan hafan pilaataformii keessaa fi konsolii irratti hojjetu; API ummataaf baname daangaa gabatee armaan gadii irratti agarsiifametti qofa daanga'a.
| Sadarkaa | Waan irratti hojjetamu | Daangaa amma ummataaf baname |
|---|---|---|
| Moodeela | Galtee barruu fi suuraa fudhatee tokenii deebii uuma | Endpointii chat completions tiin ummataaf banaa |
| Ejentii | Xiinxala kaayyoo irratti hundaa'e, waamicha meeshaalee fi ragaa tarkaanfiiwwanitti qoodame uuma | Konsolii fi playground |
| DB semaantikaa | Dokumantoota, suuraawwan, fakkiiwwan teeknikaa fi deetaa hojii tokkoon tokkoon hiikaatiin walqabsiisa | Konsolii |
| AI fiizikaalaa | Karoora sochii roboototaa fi karoora haaraa qopheessa | Waliigaltee irratti hundaa'uun waamamuu qaba |
Tarree moodeelotaa
Dirree model qaama gaaffii keessatti maqaa lamaan armaan gadii keessaa tokko akkuma jirutti galchi. Moodeelonni lamaan teessoo, mirkaneessaa fi bifa gaaffii wal fakkaataa fayyadamu.
- cip-5.5-im
- cip-5.5-mm
| Moodeela | Amala | Galtee | Bakka irra caalaa itti fayyadaman |
|---|---|---|---|
| cip-5.5-im | Barbaacha fi beekumsa multimoodeelaa | Barruu, suuraa, dokumantii, fakkii teeknikaa | Barbaacha hiika irratti hundaa'e, walqunnamtii beekumsaa, fi deeggarsa karoora sochii roobootii |
| cip-5.5-mm | Xiinxala multimoodeelaa | Barruu, suuraa, qabiyyee walxaxaa | Gaaffilee qorannoo fi xiinxalaa, waamicha meeshaalee, hojiiwwan sadarkaa hedduu |
cip-5.5-im
Sanadoota, suuraawwan, dizaayinoota, fi daataa hojii walitti dhufeenya hiikaatiin walqabsiisee, bu’aa barbaachaafi caasaa beekumsaa uuma. Physical AI’n sadarkaa karoora baasuufi irra deebi’anii karoora baasan keessatti galtee hiikuufis moodeela walfakkaatu fayyadama. Adda himaan keessaa RB-IM jedhamee fayyada; API keessatti maqaan sirrii ta’e cip-5.5-im qofa.
cip-5.5-mm
Barruu, suuraa, akkasumas haala walxaxaa sanadoota hedduu keessa jiru waliin dubbisee deebii uuma. Waamicha meeshaalee fi raawwii adeemsa hojii dabalatuuf, hojii Agentic irratti kan qophaa’e moodeeladha.
Moodeela filadhu
| Hojii raawwachuu barbaaddu | Moodeela filatamu |
|---|---|
| Sanadoota keessaa fi dizaayinoota keessaa keeyyata ragaa barbaaduu | cip-5.5-im |
| Bu’aawwan barbaachaa hiikaan walqabsiisanii beekumsa uumuu | cip-5.5-im |
| Galtee karoora hojii roobootii hiikuu | cip-5.5-im |
| Suuraa fi barruu waliin dubbisanii murteessuu | cip-5.5-mm |
| Hojii sadarkaa hedduu waamicha meeshaalee barbaadu | cip-5.5-mm |
| Deebii xiinxalaa sanadoota hedduu walitti qabee barreessuu | cip-5.5-mm |
Moodeelota biroo
Waltajjii kana irratti moodeelotni armaan gadii waliin jiru. Akkaataa raabsaafi karaa itti qaqqabamuun isaanii adda waan ta’eef, maqaan API ifa ta’e addaan ibsameera.
| Moodeela | Amala |
|---|---|
| Cip-5-X | Moodeela xiinxala walxaxaa multimodaalaa, ragaa sadarkaa sadarkaan dhiyeessu |
| Cip-5-Agent | Moodeela yaada baasuu irratti addaa ta’e, murtee haala irratti hundaa’eefi hojiiwwan irra deddeebi’aman raawwatu |
| Cip-5-Vision | Moodeela mul’ataa, suuraa, viidiyoo, barruu fi daataa yeroo walitti dhufeenya qabu waliin hiiku |
| Ivy-3-Text | LLM salphaa, meeshaalee xixiqqoo fi naannoo edge irratti meeshaa keessaa hojjetu |
| Ivy-4-mm | Moodeela non-reasoning guddaa, barruu, suuraa fi sagalee yeroo tokkoon qindeessu |
Odeeffannoo bu’uuraa fi mirkaneessa eenyummaa
Furtuun tokkoon tokkoon workspace tiin kennama; gaaffii hunda keessatti mata-duree Authorization jalatti Bearer jedhamee maxxanfama. Gatiiwwan jahan gabatee armaan gadii keessa jiran qofa yoo qabaatte, qophiin waamicha jalqabaa barbaachisu xumurama.
| Qabxii | Gatii |
|---|---|
| Teessoo bu'uuraa | https://platform.clevi.net/api/services/v1/aiservice/openai/v1 |
| Mata-duree mirkaneessaa | Authorization: Bearer sk-... |
| Bifa qaama gaaffii | application/json |
| Istaandardii gaaffii fi deebii | OpenAI Chat Completions waliin walsimu |
| Moodeelota waamamuu danda'an | cip-5.5-im, cip-5.5-mm |
| Fuula furtuu itti kennan | https://clevi.app/cloud/keys |
sk-... kan gabatee fi fakkeenya keessa jiru bakka furtuu kenname galchitani dha. Ajaja armaan gadii fayyadamuun yoo jijjiiramaa naannoo keessa kaa'ame, fakkeenya galmee kana akkuma jirutti waraabanii raawwachuu dandeessu.
export CLEVI_API_KEY="sk-..."POST /api/services/v1/aiservice/openai/v1/chat/completions
Tarree ergaa fi maqaa moodeelii fudhatee, ergaa moodeeliin uume tokko tarree choices keessa kaa'ee deebisa. Teessoon guutuun https://platform.clevi.net/api/services/v1/aiservice/openai/v1/chat/completions dha. messages yoo xiqqaate wanta ergaa tokko qabaachuu qaba; wanti tokkoon tokkoon isaas role fi content qaba.
| Maqaa | Bifa | Dirqama | Ibsa |
|---|---|---|---|
| model | string | Eeyyee | cip-5.5-im ykn cip-5.5-mm |
| messages | array | Eeyyee | Tarree wantoota ergaa haasawa. Yoo xiqqaate 1 |
| messages[].role | string | Eeyyee | system · user · assistant keessaa tokko |
| messages[].content | string | Eeyyee | Qabiyyee ergaa |
| stream | boolean | Lakki | Yoo true ta'e, deebii kutaa server-sent events ta'een qoodamee fudhatama |
| max_tokens | integer | Lakki | Baay'ina tokenii deebii keessatti uumamu keessaa olaanaa |
| temperature | number | Lakki | Gatiin isaa yoo guddate, gaaffii walfakkaataa keessatti deebiiwwan garaagaraa argamuun isaanii ni mala |
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
}
}Dirreewwan deebii
Deebiin dirreewwan saddeetii sadarkaa olaanaa irraa ijaarama. Himni uumame wanta jalqabaa tarree choices keessa jira; baay'inni token itti fayyadame immoo usage keessa jira.
| Maqaa | Bifa | Ibsa |
|---|---|---|
| id | string | Eenyummaa gaaffii tokko agarsiisu. Yeroo waa'ee dogoggoraa gaafattan waliin dabarsaa |
| object | string | chat.completion. Qoodawwan yaa'aa chat.completion.chunk dha |
| created | integer | Yeroo deebiin uumame, sekondii Unix |
| model | string | Maqaa moodeela deebii uume |
| choices | array | Tarree bu'aa uumame |
| choices[].index | integer | Tartiiba tarree keessa jiru. 0 irraa eegala |
| choices[].message.role | string | assistant |
| choices[].message.content | string | Qabiyyee deebii uumame |
| choices[].finish_reason | string | Sababa uumamni itti dhaabbate. Hanga dhumaatti yoo uumame stop |
| usage.prompt_tokens | integer | Baay'ina token galtee ta'ee fayyadame |
| usage.completion_tokens | integer | Baay'ina token uumame |
| usage.total_tokens | integer | Walitti qabama gatiiwwan lamaan armaan olii |
Dogoggora
Gaaffiin kufe sababaa isaa koodii haala HTTP tiin beeksisa. Jalqaba tarkaanfiiwwan armaan gadii ilaalaa; koodiin walfakkaataan yoo irra deddeebi'ame, id deebii fi yeroo gaaffii galmeessaa.
| Koodii | Hiika | Tarkaanfii |
|---|---|---|
| 400 | Qaamni gaafataa bifa sirrii hin qabu | model fi messages jiraachuu isaanii, akkasumas JSON cufamuu isaa mirkaneessi |
| 401 | Furtuun hin jiru ykn sirrii miti | mata-dureen Bearer irraa jalqabamuu fi gatiin furtuu akkuma jirutti waraabamuu isaa mirkaneessi |
| 403 | Furtuu kanaan seenuu hin dandeessu | workspaces furtuu baasee fi maqaa model gaafatame mirkaneessi |
| 404 | Daandiin hin jiru | dhuma teessoo /v1/chat/completions ta'uu isaa mirkaneessi |
| 429 | Yeroo gabaabaa keessatti gaaffileen baay'een dhufaniiru | yeroo irra deebi'anii yaalan dachaa dachaan dheeressuun irra deebi'ii ergi |
| 500 | Dogoggora gama sarvaraa ti | gaaffii walfakkaatu irra deebi'ii ergi; yoo irra deddeebi'ame, yeroo gaaffiin taasifame garee deeggarsaaf dabarsi |
Bifa ramaddii
Model walfakkaatu karaa API duumessaa fi karaa fe'iinsa on-premises lamaanitti fayyadama. Bifni gaaffii fi mala mirkaneessaa haalawwan lamaan keessatti walfakkaatu; teessoon fi fuulli bulchiinsa furtuu garuu adda adda.
| Qabxii | API duumessaa | On-premises |
|---|---|---|
| Teessoo durtii | platform.clevi.net | Teessoo networkii dhuunfaa fe'ame |
| Furtuu baasuu | https://clevi.app/cloud/keys | Konsoolii bulchaa naannoo fe'ame |
| Mala mirkaneessaa | Bearer token | Bearer token |
| Bakka deetaa itti kuufamu | Duumessaa CLEVI | Keessa bu'uuraalee teeknooloojii maamilaa |
Bulchiinsa deetaa
Platformichi hojiiwwan armaan gadii afur akka amala durtii qaba. Ulaagaa workspaces itti qooddan murteessuu yeroo ilaaltan, kanas waliin mirkaneessi.
- To'annoo hayyama irratti hundaa'e — Hayyama seensaa fi furtuuwwan sadarkaa workspaces irratti qoodi.
- Iddoo hojii adda baafame — Deetaan workspaces gidduutti walitti hin makamu.
- Walitti hidhamiinsa deetaa yeroo qabatamaa — Deetaa sirnoota alaa waliin walqabate yeroo gaafatanitti fida.
- Kuusaa galmee adeemsa tokkoon tokkoon — Hojii raawwatame tokkoon tokkoon isaatiin galmee kaa'a.
Tartiiba jalqabaa
Yoo yeroo jalqabaaf wal qunnamsiisaa jirtu, tartiiba armaan gadii hordofi. Hanga 3 xumurtutti, furtuu tokkoon moodeelota lamaan waamuu ni dandeessa.
- https://platform.clevi.net/account/login irratti seeni ykn akkaawuntii uumi.
- https://clevi.app/cloud irratti workspace dabali.
- https://clevi.app/cloud/keys irratti furtuu baasiitii jijjiiramaa naannoo keessatti kuusi.
- https://clevi.app/cloud/playground irratti deebii cip-5.5-im fi cip-5.5-mm wal bira qabi.
- Fakkeenya gaaffii dokumantii Quick Start irraa ko’piy godhiitii waamicha jalqabaa ergi.
