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
API аркылуу чакырылышы мүмкүн болгон моделдер
МодельМүнөздөмөсүКиргизүүНегизги колдонуу тармактары
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 катары кошулат. Төмөнкү таблицадагы алты маанини колдонуу менен биринчи чакыруу үчүн керектүү жөндөөлөр аяктайт.

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 кеминде 1 билдирүү объектин камтышы керек, ал эми ар бир объект role жана content талааларына ээ.

Сурам параметрлери
АталышыФорматыМилдеттүүСүрөттөмөсү
modelstringОобаcip-5.5-im же cip-5.5-mm
messagesarrayОобаДиалогдогу билдирүү объекттеринин массиви. Кеминде 1
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 массивинин биринчи элементинде, ал эми токендердин колдонулушу usage талаасында болот.

Жооп талаалары
АталышыФорматыСүрөттөмөсү
idstringБир сурамды көрсөткөн идентификатор. Ката тууралуу кайрылганда аны да жөнөтүңүз
objectstringchat.completion. Агымдык бөлүктөр үчүн chat.completion.chunk
createdintegerЖооп түзүлгөн убакыттын Unix секундалары
modelstringЖоопту түзгөн моделдин аталышы
choicesarrayТүзүлгөн натыйжалардын массиви
choices[].indexintegerМассивдеги иреттик номер. 0 ден башталат
choices[].message.rolestringassistant
choices[].message.contentstringТүзүлгөн жооптун негизги тексти
choices[].finish_reasonstringТүзүүнүн токтотулушунун себеби. Аягына чейин түзүлсө, stop
usage.prompt_tokensintegerКиргизүүдө колдонулган токендердин саны
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 булутуКардардын инфраструктурасынын ичинде

Маалыматтарды башкаруу

Платформа төмөнкү төрт функцияны демейки аракет катары колдонот. Воркспейстерди бөлүү критерийлерин аныктоодо муну да текшериңиз.

  • Уруксаттарга негизделген көзөмөл — кирүү уруксаттары менен ачкычтарды воркспейс деңгээлинде бөлүңүз.
  • Обочолонгон иш мейкиндиги — воркспейстердин ортосунда маалымат аралашпайт.
  • Реалдуу убакыттагы маалымат байланышы — тышкы системаларга туташкан маалыматтарды суроо учурунда алып келет.
  • Процесске жараша жазууларды сактоо — аткарылган иш бирдигине жараша жазууларды калтырат.

Баштоо тартиби

Эгер биринчи жолу туташып жатсаңыз, төмөнкү тартипте аткарыңыз. 3-кадамды бүткөндөн кийин бир эле ачкыч менен эки моделди тең чакыра аласыз.

  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 ачкычын алуу

Playground'ду ачуу

CLEVI

Тил жана аймак

Машина аркылуу которулган тилдер белгиленген. Жеткиликтүүлүк жарыяланган сайт топтомуна жараша болот.

136 тил

Сунушталат

1

Чыгыш Азия

7

Түштүк-Чыгыш Азия

11

Түштүк Азия

18

Борбор Азия

5

Жакынкы Чыгыш жана Кавказ

10

Батыш Европа жана Түштүк Европа

16

Улуу Британия жана Ирландия

4

Түндүк Европа

10

Борбордук Европа жана Балкан

14

Чыгыш Европа

5

Чыгыш Африка

8

Батыш Африка жана Борбордук Африка

9

Түштүк Африка

8

Америка

5

Океания

5