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
| مۆدێل | تایبەتمەندی | وەرگرتن | شوێنی بەکارهێنانی سەرەکی |
|---|---|---|---|
| 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-Text | LLM ـێکی سووکی on-device کە لە ئامێرە بچووکەکان و ژینگەکانی edge کار دەکات |
| Ivy-4-mm | مۆدێلی non-reasoning ـی قەبارە گەورە کە دەق، وێنە و دەنگ لە هەمان کاتدا پرۆسە دەکات |
زانیارییە سەرەتاییەکان و پشتڕاستکردنەوە
کلیلەکان بە ئاستی workspace دابین دەکرێن و لە هەر داواکارییەکدا بە شێوەی Bearer لە هێدەری Authorization ـدا دادەنرێن. بە شەش بەهای خشتەی خوارەوە، ڕێکخستنی پێویست بۆ یەکەم بانگکردن تەواو دەبێت.
| بابەت | بەها |
|---|---|
| ناونیشانی بنەڕەت | 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 ـی هەیە.
| ناو | شێواز | پێویستە | ڕوونکردنەوە |
|---|---|---|---|
| model | string | بەڵێ | cip-5.5-im یان cip-5.5-mm |
| messages | array | بەڵێ | ڕیزبەندی شتەکانی پەیامی گفتوگۆ. لانیکەم ١ دانە |
| 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 array ـدایە، و بەکارهێنانی تۆکن لە usage ـدایە.
| ناو | فۆرمات | ڕوونکردنەوە |
|---|---|---|
| id | string | ناسێنەرێک کە داواکارییەک دیاری دەکات. لە کاتی پرسیاری هەڵەدا لەگەڵی بنێرە. |
| object | string | chat.completion. پارچەکانی streaming بریتین لە chat.completion.chunk |
| created | integer | کاتی دروستکردنی وەڵام بە Unix چرکە |
| model | string | ناوی مۆدێلی دروستکردنی وەڵام |
| choices | array | ڕیزبەندی ئەنجامە دروستکراوەکان |
| choices[].index | integer | ژمارەی ڕیز لە ناو array ـەکەدا. لە 0 ـەوە دەست پێ دەکات |
| choices[].message.role | string | assistant |
| choices[].message.content | string | ناوەڕۆکی وەڵامی دروستکراو |
| choices[].finish_reason | string | هۆکاری وەستانی دروستکردن. ئەگەر تا کۆتایی دروست بکرێت، stop ـە |
| usage.prompt_tokens | integer | ژمارەی تۆکنە بەکارهاتووەکان بۆ input |
| 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 雲端 | 客戶基礎架構內部 |
資料治理
平台將以下四項設為基本行為。決定工作區劃分標準時,請一併確認。
- 基於權限的控管 — 以工作區為單位區分存取權限與金鑰。
- 隔離工作空間 — 工作區之間不會混入資料。
- 即時資料連接 — 與外部系統連接的資料會在查詢時取得。
- 依程序保留記錄 — 以執行的工作為單位保留記錄。
開始順序
ئەگەر بۆ یەکەم جارە پەیوەندی دەکەیت، بە ڕیزبەندیی خوارەوە پێش بچۆ. کاتێک هەتا خاڵی ٣ تەواو دەکەیت، دەتوانیت بە تەنها یەک کلیل هەردوو مۆدێلەکە بانگ بکەیت.
- لە 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 کۆپی بکە و یەکەم بانگکردن بنێرە.
