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 ቢያንስ አንድ የመልዕክት ነገር መያዝ አለበት፣ እያንዳንዱ ነገርም 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 ሰነድ ውስጥ ያለውን የጥያቄ ምሳሌ በመቅዳት የመጀመሪያ ጥሪዎን ይላኩ።
