Developer guide

Bi awirekê yekê dîtin

Bi awirekê yekê dîtin

Ev belge destpêka belgeyên pêşdebirên CLEVI ye. Ew pêkhateyên Clevi-X-Platform, du modelên ku dikarin bi API werin gazîkirin, awayê pejirandinê û formatên daxwaz û bersivê bi hev re berhev dike. Ji ber ku daxwaz û bersiv li gorî formata OpenAI Chat Completions in, di SDK-ya heyî ya OpenAI de tenê base_url û api_key biguherînin da ku girêbidin. Prosedûra ku bêyî sazkirin heta yekem gazîkirinê dişopîne di belgeya Quick Start de heye.

Pêkhateya platformê

Clevi-X-Platform model, ajan, databasa semantîk û AI-ya fîzîkî di hundirê hawîrdorekê ya yekane ya xebitandinê de dicivîne. Ji van qatên platformê, tiştê ku pêşdebir niha dikare rasterast bi HTTP gazî bike qata modelê ye. Qatên din di hundirê platformê û konsolê de dixebitin, û API-ya giştî heta sînorê ku di tabloya jêrîn de hatiye nîşandan vekirî ye.

Qatên platformê û qada giştî
QatTiştên ku têne birêvebirinQada giştî ya niha
ModelJi bo wergirtina têketinên nivîs û wêneyan û hilberandina tokenên bersivêBi endpoint-a chat completions re vekirî ye
AjanSuyê armancgir, gazîkirina amûran û hilberandina delîlên gav bi gavKonsol û playground
DB-ya semantîkGirêdana belge, wêne, nexşe û daneyên karî bi yekeyên wateyêKonsol
AI-ya fîzîkîPlankirina tevgerên robotan û ji nû ve plankirinLi gorî yekeya sazkirinê tê lihevkirin

Rêza modelan

Di qada model a bedena daxwazê de yek ji van her du navan bêyî guhertin binivîsin. Her du model heman navnîşan, heman pejirandin û heman formata daxwazê bi kar tînin.

  • cip-5.5-im
  • cip-5.5-mm
Modelên ku dikarin bi API werin gazîkirin
ModelTaybetmendîTêketinCihên sereke yên bikaranînê
cip-5.5-imLêgerîna multimodal û zanînkirinNivîs, wêne, belge, nexşeLêgerîna li ser bingeha wateyê, girêdana zanînê û piştgiriya plankirina tevgerên robotan
cip-5.5-mmSuyê multimodalNivîs, wêne, çarçoveya tevlihevPirsên lêkolîn û analîzê, gazîkirina amûran û karên pir-qonaxî

cip-5.5-im

Belge, wêne, xêz û daneyên karê bi yekîneyên wateyê ve girêdide û encamên lêgerînê û avahiya zanînê çêdike. Di qonaxên plansazkirin û ji nû ve plansazkirina Physical AI de jî heman model ji bo şîrovekirina têketinê tê bikaranîn. Nasnameya hundirîn RB-IM e, û di API de tenê cip-5.5-im navê derbasdar e.

cip-5.5-mm

Nivîs, wêne û çarçoveya tevlihev a li ser gelek belgeyan bi hev re dixwîne û bersivê çêdike. Ev model ji bo karên Agentic hatiye eyarkirin ku bangên amûran û pêkanîna rêzikên karê dihewîne.

Hilbijartina modelê

Hilbijartina modelê li gorî karê
Armanca weModela ku were hilbijartin
Dîtina paragrafên delîlê di belge û xêzên hundirîn decip-5.5-im
Girêdana encamên lêgerînê li gorî wateyê û veguherandina wan bo zanînêcip-5.5-im
Şîrovekirina têketinê ji bo plansazkirina karên robotêcip-5.5-im
Xwendin û biryardana li ser wêne û nivîsê bi hev recip-5.5-mm
Karên pir-qonaxî ku hewceyî bangên amûran incip-5.5-mm
Amadekirina bersivên analîtîk ên ku gelek belgeyan digihînin hevcip-5.5-mm

Modelên din

Di platformê de modelên jêrîn jî hene. Ji ber ku cureyên belavkirinê û rêyên gihiştinê ji hev cuda ne, navên API yên giştî cuda tên ragihandin.

Rêza modelên platformê
ModelTaybetmendî
Cip-5-XModela analîza tevlihev a multimodal ku delîlên gav bi gav pêşkêş dike
Cip-5-AgentModela ramana taybet a agentê ku biryargirtina li gorî rewşê û pêvajoya karên dubare dike
Cip-5-VisionModela dîtbarî ku wêne, vîdyo, nivîs û rêzeya demê bi hev re şîrove dike
Ivy-3-TextLLM-a sivik a li ser amûran ku di cîhazên biçûk û hawîrdorên edge de dixebite
Ivy-4-mmModela mezin a non-reasoning ku nivîs, wêne û deng di heman demê de pêvajoyê dike

Agahiyên bingehîn û pejirandin

Mifte li gorî workspaceê tên dayîn û di her daxwazê de bi Bearer di serê Authorization de tên zêdekirin. Bi şeş nirxên tabloya jêrîn, sazkirina ji bo bangên yekemîn temam dibe.

Agahiyên bingehîn ên API
HêmanNirx
Navnîşana bingehînhttps://platform.clevi.net/api/services/v1/aiservice/openai/v1
Sernavê pejirandinêAuthorization: Bearer sk-...
Formata laşê daxwazêapplication/json
Pîvanên daxwaz û bersivêLihevhatî bi OpenAI Chat Completions
Modelên ku dikarin werin bang kirincip-5.5-im, cip-5.5-mm
Rûpela derxistina kilîtêhttps://clevi.app/cloud/keys

sk-... di tablo û nimûneyan de cihê kilîta ku we stendî ye. Heke hûn wê bi fermana jêrîn di guhêrbarekî jîngehê de bihêlin, hûn dikarin nimûneyên vê belgeyê rasterast kopî bikin û bimeşînin.

export CLEVI_API_KEY="sk-..."

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

Ev rêzek peyaman û navê modelê werdigire û peyamekê ku model çêkiriye di rêzika choices de vedigerîne. Navnîşana tevahî https://platform.clevi.net/api/services/v1/aiservice/openai/v1/chat/completions ye. messages divê herî kêm 1 objeya peyamê dihewîne, û her objeyek role û content heye.

Parametreyên daxwazê
NavFormatPêwîstDanasîn
modelstringErêcip-5.5-im an cip-5.5-mm
messagesarrayErêRêzika objeyên peyamên axaftinê. Herî kêm 1
messages[].rolestringErêYek ji system · user · assistant
messages[].contentstringErêNaveroka peyamê
streambooleanNaHeke true be, bersiv wekî perçeyên server-sent events tê wergirtin
max_tokensintegerNaHejmara herî zêde ya tokenan ku di bersivê de têne çêkirin
temperaturenumberNaHer ku nirx mezintir be, îhtîmala ku di daxwaza heman de bersivên cuda derkevin zêdetir dibe
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
  }
}

Qadên bersivê

Bersiv ji şeş qadên asta jorîn pêk tê. Hevokên hatine çêkirin di yekem hêmanê rêzika choices de ne, û bikaranîna tokenan di usage de ye.

Qadên bersivê
NavFormatDanasîn
idstringNasnameya ku daxwazekê nîşan dide. Dema ku li ser xeletiyê dipirsin, wê jî bişînin
objectstringchat.completion. Parçeyên streaming chat.completion.chunk in
createdintegerDema Unix a çêkirina bersivê, bi saniyan
modelstringNavê modela ku bersiv çêkiriye
choicesarrayRêzika encamên hatine çêkirin
choices[].indexintegerRêza di hundirê rêzikê de. Ji 0 dest pê dike
choices[].message.rolestringassistant
choices[].message.contentstringNaveroka bersiva hatî çêkirin
choices[].finish_reasonstringSedema rawestandina çêkirinê. Heke heta dawiyê were çêkirin, stop
usage.prompt_tokensintegerHejmara tokenên ku wekî têketin hatine bikaranîn
usage.completion_tokensintegerHejmara tokenên hatine çêkirin
usage.total_tokensintegerKomika her du nirxan
total\_tokens=prompt\_tokens+completion\_tokens\text{total\_tokens} = \text{prompt\_tokens} + \text{completion\_tokens}

Xeletî

Daxwazên têkçûyî sedemê bi koda rewşa HTTP nîşan didin. Pêşî çareyên li jêr kontrol bikin û heke heman kod dubare bibe, id ya bersivê û dema daxwazê tomar bikin.

Koda rewşa HTTP
KodWateÇare
400Naveroka daxwazê li gorî formatê ne yeKontrol bikin ka model û messages hene û JSON girtî ye
401Mifte tune ye an ne derbasdar eKontrol bikin ka sernav bi Bearer dest pê dike û nirxa mifteyê bê guhertin hatiye kopîkirin
403Bi vê mif­teyê nikarin bigihîjinWorkspace-a ku mif­te daye û navê modela daxwazkirî kontrol bikin
404Rê tune yeKontrol bikin ka dawiya navnîşanê /v1/chat/completions e
429Di demeke kurt de gelek daxwaz hatine kirinNavbera dubarekirinê her car du qat bikin û paşê dîsa bişînin
500Di aliyê serverê de çewtiyek heyeHe­man daxwazê dîsa bişînin û heke dubare bibe, dema daxwazê ji tîmê piştgiriyê re ragihînin

Şêwaza belavkirinê

Em heman modelê bi du awayan bikar tînin: API-ya cloudê û sazkirina on-premises. Formata daxwazê û awayê pejirandinê di her du rewşan de wekhev in, lê navnîşan û rûpela rêvebirina mifteyan cuda ne.

Berawirdkirina cloud û on-premises
HêmanAPI-ya cloudêOn-premises
Navnîşana bingehînplatform.clevi.netNavnîşana tora taybet a sazkirî
Derxistina mifteyêhttps://clevi.app/cloud/keysKonsola rêvebirê ya hawîrdora sazkirinê
Awayê pejirandinêToken-a BearerToken-a Bearer
Cihê parastina daneyanCloud-a CLEVIDi hundirê binesaziya xerîdar de

Rêveberiya daneyan

Platform ji bo çalakiyên bingehîn çar tiştên jêrîn esas digire. Dema ku hûn standarda dabeşkirina workspace-an diyar dikin, wan jî bi hev re kontrol bikin.

  • Kontrola li ser bingeha destûran — Destûrên gihiştinê û mifteyan li gorî workspace-an parçe dikin.
  • Cihê karê veqetandî — Daneyên di navbera workspace-an de tevlihev nabin.
  • Girêdana daneyên zindî — Daneyên girêdayî pergalên derveyî di dema lêpirsînê de têne anîn.
  • Parastina tomarê li gorî pêvajoyê — Tomarê li gorî her karê hatî bicihanîn bihêlin.

Rêza destpêkirinê

Heke ev cara yekem e ku hûn girêdanê dikin, li gorî rêza jêrîn pêşde biçin. Piştî ku hûn heta gavê 3 biqedînin, hûn dikarin bi tenê yek kilîtê her du modelan jî bixebitînin.

  1. Li https://platform.clevi.net/account/login têkevin an hesabek çêbikin.
  2. Li https://clevi.app/cloud workspaceek zêde bikin.
  3. Li https://clevi.app/cloud/keys kilîtê bistînin û wê di guhêrbarekî jîngehê de tomar bikin.
  4. Li https://clevi.app/cloud/playground bersivên cip-5.5-im û cip-5.5-mm bidin ber hev.
  5. Mînakê daxwazê ji belgeya Quick Start kopî bikin û yekem bangê bişînin.

Workspace çêbikin

Kilîta API bistînin

Playground vekin

CLEVI

Ziman û herêm

Zimanên bi wergera makîneyê hatine wergerandin hatine nîşankirin. Berdestbûn li gorî pakêta malperê ya weşandî ye.

136 ziman

Pêşniyarkirî

1

Rojhilatê Asyayê

7

Başûrrojhilatê Asyayê

11

Başûrê Asyayê

18

Asyaya Navîn

5

Rojhilata Navîn û Kafkasya

10

Rojavayê Ewropayê û Başûrê Ewropayê

16

Qiralîyeta Yekbûyî û Îrlanda

4

Bakurê Ewropayê

10

Ewropaya Navîn û Balkan

14

Rojhilatê Ewropayê

5

Rojhilatê Afrîkayê

8

Rojavayê Afrîkayê û Afrîkaya Navîn

9

Başûrê Afrîkayê

8

Amerîka

5

Okyanûsya

5