Developer guide

بە یەک نیگاکردن

بە یەک نیگاکردن

ئەم بەڵگەنامەیە خاڵی دەستپێکردنی بەڵگەنامەکانی گەشەپێدانی CLEVI ـە. پێکهاتەی Clevi-X-Platform، دوو مۆدێلی پەیوەندیکراو بە API، شێوازی پشتڕاستکردنەوە، و شێوەی داواکاری و وەڵام بە یەکجار ڕوون دەکاتەوە. داواکاری و وەڵامەکان شێوازی OpenAI Chat Completions پەیڕەو دەکەن، بۆیە لە SDK ـی کۆنی OpenAI تەنها base_url و api_key بگۆڕە بۆ پەیوەندیکردن. ڕێنمایی هەنگاو بە هەنگاو بۆ گەیشتن بە یەکەم بانگکردن بەبێ دامەزراندن لە بەڵگەنامەی Quick Start ـدایە.

پێکهاتەی پلاتفۆرم

Clevi-X-Platform مۆدێل، ئەجێنت، بنکەدراوەی سیمانتیک و زیرەکی فیزیکی لە یەک ژینگەی جێبەجێکردندا کۆدەکاتەوە. لەم نێوانەدا، ئەوەی گەشەپێدەر ئێستا بە ڕاستەوخۆ لە ڕێگەی HTTP ـەوە بانگی دەکات، چینەی مۆدێلە. چینەکانی دیکە لە ناو پلاتفۆرم و کۆنسۆڵدا کار دەکەن، و API ـی گشتی تا ئەو سنوورەیە کە لە خشتەی خوارەوە نیشان دراوە.

چینەکانی پلاتفۆرم و مەودای گشتی
چینئەوەی مامەڵەی لەگەڵ دەکرێتمەودای گشتیی ئێستا
مۆدێلوەرگرتنی تێکست و وێنە و دروستکردنی تۆکنی وەڵامبە کۆتایی‌نیشانەکانی chat completions بڵاوکراوەتەوە
ئەجێنتبیرکردنەوەی ئامانج‌ئامادە، بانگکردنی ئامراز و دروستکردنی بەڵگەی هەنگاو بە هەنگاوکۆنسۆڵ و یاریگای تاقیکردنەوە
بنکەدراوەی سیمانتیکبەستنەوەی بەڵگەنامە، وێنە، نەخشە و داتای کار بە یەکە سیمانتیکییەکانکۆنسۆڵ
زیرەکی فیزیکیدانانی پلان و پلاندانانەوەی جوڵەی ڕۆبۆتڕێککەوتن لەسەر بنەمای دامەزراندن

ڕیزبەندیی مۆدێلەکان

لە خانەی model ـی ناوەڕۆکی داواکارییەکەدا یەکێک لەو دوو ناوەی خوارەوە بە هەمان شێوە دابنێ. هەردوو مۆدێلەکە هەمان ناونیشان، هەمان پشتڕاستکردنەوە و هەمان شێوەی داواکاری بەکاردەهێنن.

  • cip-5.5-im
  • cip-5.5-mm
مۆدێلەکانی پەیوەندیکراو بە API
مۆدێلتایبەتمەندیوەرگرتنشوێنی بەکارهێنانی سەرەکی
cip-5.5-imگەڕانی فرەشێوە و زانیاریکردنتێکست، وێنە، بەڵگەنامە، نەخشەگەڕانی بنەما سیمانتیکییەکان، بەستنەوەی زانیاری، پشتگیریکردن لە پلاندانانی جوڵەی ڕۆبۆت
cip-5.5-mmبیرکردنەوەی فرەشێوەتێکست، وێنە، کۆنتێکستی ئاڵۆزپرسیارە توێژینەوەیی و شیکارییەکان، بانگکردنی ئامراز، کارە چەند هەنگاوییەکان

cip-5.5-im

بەڵگەنامە، وێنە، نەخشە و داتاکانی کار بە یەکەکانی مانا پەیوەست دەکات و ئەنجامەکانی گەڕان و پێکهاتەی زانیاری دروست دەکات. هەمان مۆدێل لە قۆناغەکانی دانانی پلانی Physical AI و دانانەوەی پلانی نوێشدا بەکاردێت بۆ لێکدانەوەی input. ناسێنەری ناوخۆیی RB-IM ـە و لە API ـدا تەنها ناوی cip-5.5-im دروستە.

cip-5.5-mm

دەق و وێنە، هەروەها کۆنتێکستی ئاڵۆز لەسەر چەندین بەڵگەنامە، پێکەوە دەخوێنێتەوە و وەڵام دروست دەکات. ئەم مۆدێلە بۆ کاری Agentic ڕێکخراوە کە بانگکردنی ئامراز و جێبەجێکردنی ڕەوتی کار لەخۆدەگرێت.

هەڵبژاردنی مۆدێل

هەڵبژاردنی مۆدێل بەپێی کار
ئەوەی دەتەوێت بیکەیتمۆدێلی هەڵبژێردراو
دۆزینەوەی پەرەگرافی بەڵگە لە بەڵگەنامە و نەخشەکانی ناوخۆی کۆمپانیاcip-5.5-im
بەستنەوەی ئەنجامەکانی گەڕان بە بنەمای مانا و گۆڕینیان بۆ زانیاریcip-5.5-im
لێکدانەوەی input ـی پلانی کارکردنی ڕۆبۆت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-TextLLM ـێکی سووکی on-device کە لە ئامێرە بچووکەکان و ژینگەکانی edge کار دەکات
Ivy-4-mmمۆدێلی non-reasoning ـی قەبارە گەورە کە دەق، وێنە و دەنگ لە هەمان کاتدا پرۆسە دەکات

زانیارییە سەرەتاییەکان و پشتڕاستکردنەوە

کلیلەکان بە ئاستی workspace دابین دەکرێن و لە هەر داواکارییەکدا بە شێوەی Bearer لە هێدەری Authorization ـدا دادەنرێن. بە شەش بەهای خشتەی خوارەوە، ڕێکخستنی پێویست بۆ یەکەم بانگکردن تەواو دەبێت.

زانیارییە سەرەتاییەکانی API
بابەتبەها
ناونیشانی بنەڕەت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 دەبێت لانیکەم یەک شتەی پەیام لەخۆ بگرێت، و هەر شتێک role و content ـی هەیە.

پارامەتەرەکانی داواکاری
ناوشێوازپێویستەڕوونکردنەوە
modelstringبەڵێcip-5.5-im یان cip-5.5-mm
messagesarrayبەڵێڕیزبەندی شتەکانی پەیامی گفتوگۆ. لانیکەم ١ دانە
messages[].rolestringبەڵێیەکێک لە system · user · assistant
messages[].contentstringبەڵێناوەڕۆکی پەیام
streambooleanنەخێرئەگەر true بێت، وەڵامەکە بە پارچەکانی server-sent events دابەشکراو وەردەگریت
max_tokensintegerنەخێرزۆرترین ژمارەی تۆکنەکان کە لە وەڵامدا دروست دەکرێن
temperaturenumberنەخێرهەرچی بەهاکە گەورەتر بێت، ئەگەری هاتنەدەرەوەی وەڵامی جیاواز لە هەمان داواکارییەوە زیاتر دەبێت
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 array ـدایە، و بەکارهێنانی تۆکن لە usage ـدایە.

خانەکانی وەڵام
ناوفۆرماتڕوونکردنەوە
idstringناسێنەرێک کە داواکارییەک دیاری دەکات. لە کاتی پرسیاری هەڵەدا لەگەڵی بنێرە.
objectstringchat.completion. پارچەکانی streaming بریتین لە chat.completion.chunk
createdintegerکاتی دروستکردنی وەڵام بە Unix چرکە
modelstringناوی مۆدێلی دروستکردنی وەڵام
choicesarrayڕیزبەندی ئەنجامە دروستکراوەکان
choices[].indexintegerژمارەی ڕیز لە ناو array ـەکەدا. لە 0 ـەوە دەست پێ دەکات
choices[].message.rolestringassistant
choices[].message.contentstringناوەڕۆکی وەڵامی دروستکراو
choices[].finish_reasonstringهۆکاری وەستانی دروستکردن. ئەگەر تا کۆتایی دروست بکرێت، stop ـە
usage.prompt_tokensintegerژمارەی تۆکنە بەکارهاتووەکان بۆ input
usage.completion_tokensintegerژمارەی تۆکنە دروستکراوەکان
usage.total_tokensintegerکۆی ئەو دوو بەهایە
total\_tokens=prompt\_tokens+completion\_tokens\text{total\_tokens} = \text{prompt\_tokens} + \text{completion\_tokens}

هەڵە

داواکارییە سەرکەوتوونەکان هۆکارەکە بە کۆدی دۆخی HTTP ڕادەگەیەنن. سەرەتا ڕێوشوێنی خوارەوە بپشکنە و ئەگەر هەمان کۆد دووبارە بووەوە، id ـی وەڵام و کاتی داواکارییەکە تۆمار بکە.

کۆدی دۆخی HTTP
کۆدواتاڕێوشوێن
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 雲端客戶基礎架構內部

資料治理

平台將以下四項設為基本行為。決定工作區劃分標準時,請一併確認。

  • 基於權限的控管 — 以工作區為單位區分存取權限與金鑰。
  • 隔離工作空間 — 工作區之間不會混入資料。
  • 即時資料連接 — 與外部系統連接的資料會在查詢時取得。
  • 依程序保留記錄 — 以執行的工作為單位保留記錄。

開始順序

ئەگەر بۆ یەکەم جارە پەیوەندی دەکەیت، بە ڕیزبەندیی خوارەوە پێش بچۆ. کاتێک هەتا خاڵی ٣ تەواو دەکەیت، دەتوانیت بە تەنها یەک کلیل هەردوو مۆدێلەکە بانگ بکەیت.

  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

کردنەوەی یاریگای تاقیکردنەوە

CLEVI

زمان و ناوچە

زمانە وەرگێڕدراوەکان بە ئامێر نیشانەکراون. بەردەستبوون پەیوەستە بە پەکەتی بڵاوکراوەی ماڵپەڕەکە.

١٣٦ زمان

پێشنیارکراو

1

ڕۆژهەڵاتی ئاسیا

7

باشووری ڕۆژھەڵاتی ئاسیا

11

باشووری ئاسیا

18

ناوەڕاستی ئاسیا

5

ڕۆژهەڵاتی ناوەڕاست و قەفقاس

10

ڕۆژاوای ئەورووپا and باشووری ئەورووپا

16

شانشینی یەکگرتوو and ئیرلەند

4

باکووری ئەورووپا

10

ئەورووپای ناوەندی و بالکان

14

ڕۆژهەڵاتی ئەورووپا

5

ڕۆژھەڵاتی ئەفریقا

8

ڕۆژاوای ئەفریقا and ناوەڕاستی ئەفریقا

9

باشووری ئەفریقا

8

ئەمەریکای باکوور و باشوور

5

ئۆقیانووسیا

5