Op ee Bléck

Dëst Dokument ass den Ausgangspunkt vun der CLEVI-Entwécklerdokumentatioun. Et faasst d’Struktur vun der Clevi-X-Platform, déi zwee Modeller, déi iwwer API opgeruff kënne ginn, d’Authentifizéierung an d’Format vun Ufroen an Äntwerten zesummen. Well Ufroen an Äntwerten dem OpenAI Chat Completions-Format follegen, musst Dir am bestehende OpenAI SDK nëmmen d’Wäerter base_url an api_key änneren, fir d’Verbindung hierzestellen. D’Prozedur, déi Iech ouni Installatioun bis zum éischten Opruff féiert, fannt Dir am Quick Start-Dokument.

Plattformstruktur

D’Clevi-X-Platform bréngt Modeller, Agenten, eng semantesch Datebank a Physical AI an eng eenzeg Ausféierungsëmfeld. Vun dësen ass d’Modellschicht dat, wat Entwéckler aktuell direkt iwwer HTTP opruffen. Déi aner Schichte lafen intern an der Plattform an an der Konsole; déi ëffentlech API deckt de Beräich of, deen an der Tabell hei drënner gewise gëtt.

Modellopstellung

Setzt am model-Feld vum Ufrotext genee ee vun den zwee folgenden Nimm an. Béid Modeller benotzen déiselwecht Adress, déiselwecht Authentifizéierung an datselwecht Ufroformat.

• cip-5.5-im
• cip-5.5-mm

cip-5.5-im

Dokumenter, Biller, technesch Zeechnungen a Geschäftsdonnéeë ginn op Basis vu Bedeitung verknëppt, fir Sichresultater a Wëssensstrukturen ze erstellen. Dee selwechte Modell gëtt och benotzt, fir d'Inputen an de Planungs- a Replanungsphasen vu Physical AI ze interpretéieren. Intern gëtt RB-IM als Identifikateur benotzt; an der API ass nëmmen cip-5.5-im als Numm gülteg.

cip-5.5-mm

Liest Text a Biller, souwéi komplex Kontext iwwer verschidde Dokumenter, zesummen a generéiert Äntwerten. De Modell ass fir agentesch Aufgaben ugepasst, dorënner Tool-Uriff an d'Ausféierung vu Geschäftsprozesser.

Modell auswielen

Aner Modeller

D'Plattform enthält och déi folgend Modeller. Well d'Deployment-Formen an d'Zougangsweeër sech ënnerscheeden, ginn d'Nimm vun der ëffentlecher API separat uginn.

Basisinformatioun an Authentifikatioun

D'Schlëssele ginn pro Workspace ausgestallt a bei all Ufro als Bearer am Authorization-Header iwwermëttelt. Mat de sechs Wäerter an der Tabell hei drënner ass d'Konfiguratioun fir den éischten Opruff ofgeschloss.

Déi sk-... an der Tabell an an den Beispiller ass d'Plaz, wou Dir Ären ausgestallte Schlëssel asetzt. Wann Dir en mam Kommando hei drënner an eng Ëmfeldvariabel setzt, kënnt Dir d'Beispiller an dësem Dokument kopéieren an direkt ausféieren.

export CLEVI_API_KEY="sk-..."

POST /api/services/v1/aiservice/openai/v1/chat/completions

Dëse Endpunkt hëlt en Array vu Messagen an en Numm vum Modell entgéint a gëtt eng eenzeg vum Modell generéiert Noriicht am choices-Array zeréck. Déi komplett Adress ass https://platform.clevi.net/api/services/v1/aiservice/openai/v1/chat/completions . messages muss mindestens ee Message-Objet enthalen, an all Objet huet role a content.

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
  }
}

Äntwertfelder

D'Äntwert besteet aus sechs Felder op der ieweschter Niveau. De generéierte Saz steet am éischten Element vum choices-Array, an d'Token-Notzung steet an usage.

Feeler

Feelerhaft Ufroe ginn d'Ursaach iwwer den HTTP-Statuscode un. Iwwerpréift fir d'éischt déi hei ënnendrënner beschriwwe Schrëtt, a wann dee selwechte Code widderholl optrëtt, notéiert d'id an d'Zäit vun der Ufro.

Deployment-Form

Dee selwechte Modell gëtt a béide Formen agesat: als Cloud-API an als On-Premises-Installatioun. D'Ufroformat an d'Authentifizéierung si bei béide Varianten d'selwecht, awer d'Adress an d'Verwaltung vum Schlëssel sinn ënnerschiddlech.

Dategouvernance

D'Plattform setzt déi folgend véier Punkten als Standardverhalen fest. Betruecht se zesumme wann Dir d'Critèrë fir d'Opdeelung vun de Workspaces definéiert.

• Zougrëffskontroll op Basis vu Berechtegungen — D'Zougrëffsrechter an d'Schlësselen ginn op Workspace-Niveau getrennt.
• Isoléiert Aarbechtsberäicher — D'Date ginn net tëscht de Workspaces vermëscht.
• Datenverbindung an Echtzäit — D'Donnéeë vun externe Systemer ginn zum Zäitpunkt vun der Ufro ofgeruff.
• Prozessbezunnen Opbewahrung vu Protokoller — Fir all ausgefouert Aufgab ginn d'Opzeechnunge gespäichert.

Reiefolleg vum Start

Wann Dir fir d'éischt eng Verbindung hierstellt, befollegt d'Reiefolleg hei ënnen. Wann Dir bis Schrëtt 3 fäerdeg sidd, kënnt Dir béid Modeller mat engem eenzege Schlëssel opruffen.

1. Mellt Iech op https://platform.clevi.net/account/login un oder erstellt e Kont.
2. Füügt op https://clevi.app/cloud e Workspace derbäi.
3. Generéiert op https://clevi.app/cloud/keys e Schlëssel a späichert en an enger Ëmweltvariabel.
4. Vergläicht op https://clevi.app/cloud/playground d'Äntwerte vun cip-5.5-im an cip-5.5-mm.
5. Kopéiert d'Ufrobeispill aus der Quick Start-Dokumentatioun a schéckt den éischten Opruff.

Workspace erstellen

API-Schlëssel generéieren

Playground opmaachen