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Жижиг төхөөрөмж болон захын орчинд ажилладаг төхөөрөмж дээрх хөнгөн 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[].message.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Энэ түлхүүрээр хандах боломжгүй байнаТүлхүүр олгосон 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-р алхмыг дуусгасны дараа нэг түлхүүрээр хоёр загварыг хоёуланг нь дуудах боломжтой.

  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