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 загвар |
Үндсэн мэдээлэл ба баталгаажуулалт
Түлхүүрийг 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[].message.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 | Энэ түлхүүрээр хандах боломжгүй байна | Түлхүүр олгосон workspace болон хүсэлтэд ашигласан model-ийн нэрийг шалгана уу |
| 404 | Зам олдсонгүй | Хаягийн төгсгөл /v1/chat/completions мөн эсэхийг шалгана уу |
| 429 | Богино хугацаанд хэт олон хүсэлт ирсэн байна | Дахин оролдох хоорондын зайг хоёр дахин нэмэгдүүлээд дахин илгээнэ үү |
| 500 | Серверийн талд алдаа гарлаа | Ижил хүсэлтийг дахин илгээнэ үү. Давтагдвал дэмжлэгийн багт хүсэлт илгээсэн цагийг мэдэгдэнэ үү |
Байршуулалтын хэлбэр
Ижил model-ийг үүлэн API болон газар дээрх суурилуулалт гэсэн хоёр хэлбэрээр ашиглана. Хүсэлтийн формат болон нэвтрэлт танилтын арга нь ижил боловч хаяг болон түлхүүрийн удирдлагын дэлгэц өөр байна.
| Зүйл | Үүлэн API | Газар дээрх суурилуулалт |
|---|---|---|
| Үндсэн хаяг | platform.clevi.net | Суурилуулсан хувийн сүлжээний хаяг |
| Түлхүүр олгох | https://clevi.app/cloud/keys | Суурилуулалтын орчны администраторын консол |
| Нэвтрэлт танилтын арга | Bearer токен | Bearer токен |
| Өгөгдөл хадгалах байршил | CLEVI-ийн үүлэн орчин | Харилцагчийн дэд бүтцийн дотор |
Өгөгдлийн засаглал
Платформ нь доорх дөрвөн үйлдлийг үндсэн байдлаар дэмжинэ. Workspace-үүдийг хуваах шалгуурыг тогтоохдоо хамт шалгана уу.
- Эрхийн түвшинд суурилсан хяналт — workspace-ийн түвшинд хандах эрх болон түлхүүрүүдийг хуваарилна.
- Тусгаарлагдсан ажлын орчин — workspace-үүдийн хооронд өгөгдөл холилдохгүй.
- Бодит цагийн өгөгдлийн холболт — гадаад системтэй холбосон өгөгдлийг лавлах үед татаж авна.
- Процесс тус бүрийн бүртгэл хадгалалт — гүйцэтгэсэн ажил бүрээр бүртгэл үлдээнэ.
Эхлүүлэх дараалал
Анх удаа холбогдож байгаа бол доорх дарааллын дагуу үргэлжлүүлнэ үү. 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 баримт бичиг дэх хүсэлтийн жишээг хуулж, эхний дуудлагыг илгээнэ үү.
