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 | Чакан түзмөктөрдө жана edge чөйрөлөрүндө иштеген түзмөктөгү жеңил LLM |
| Ivy-4-mm | Текстти, сүрөттөрдү жана үндү бир убакта иштеткен чоң көлөмдүү non-reasoning модели |
Негизги маалымат жана аутентификация
Ачкыч workspace деңгээлинде берилет жана ар бир суроодо 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 кеминде 1 билдирүү объектин камтышы керек, ал эми ар бир объект 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 документиндеги суроо-талаптын мисалын көчүрүп, биринчи чакырууну жөнөтүңүз.
