એક નજરમાં

આ દસ્તાવેજ CLEVI ડેવલપર દસ્તાવેજો માટેનો પ્રારંભિક બિંદુ છે. Clevi-X-Platform ની રચના, API દ્વારા કૉલ કરી શકાય તેવા બે મોડેલ, પ્રમાણીકરણ પદ્ધતિ અને વિનંતી તથા પ્રતિસાદના ફોર્મેટને એક જ જગ્યાએ સંક્ષિપ્ત કરવામાં આવ્યા છે. વિનંતી અને પ્રતિસાદ OpenAI Chat Completions ફોર્મેટનું પાલન કરે છે, તેથી હાલના OpenAI SDK માં base_url અને api_key આ બે મૂલ્યો બદલીને કનેક્ટ કરો. ઇન્સ્ટોલેશન વિના પ્રથમ કૉલ સુધીની પ્રક્રિયા Quick Start દસ્તાવેજમાં છે.

પ્લેટફોર્મની રચના

Clevi-X-Platform મોડેલ, એજન્ટ, સેમેન્ટિક ડેટાબેઝ અને ભૌતિક AI ને એક જ એક્ઝિક્યુશન પર્યાવરણમાં રાખે છે. આમાંથી ડેવલપર હાલમાં HTTP દ્વારા સીધો કૉલ કરી શકે છે તે મોડેલ સ્તર છે. બાકીનાં સ્તરો પ્લેટફોર્મની અંદર અને કન્સોલમાં કાર્ય કરે છે, અને જાહેર API નીચેના કોષ્ટકમાં દર્શાવેલી મર્યાદા સુધી ઉપલબ્ધ છે.

મોડેલ શ્રેણી

વિનંતીના બૉડીના model ફીલ્ડમાં નીચેના બે નામમાંથી એક નામ જેમનું તેમ દાખલ કરો. બંને મોડેલ સમાન સરનામું, સમાન પ્રમાણીકરણ અને સમાન વિનંતી ફોર્મેટનો ઉપયોગ કરે છે.

• 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 કાર્યો માટે આ મોડેલને સમાયોજિત કરવામાં આવ્યું છે.

મોડેલ પસંદ કરો

અન્ય મોડેલ્સ

પ્લેટફોર્મમાં નીચેના મોડેલ્સ પણ ઉપલબ્ધ છે. તેમની જમાવટની રીતો અને ઍક્સેસ માર્ગો અલગ હોવાથી, જાહેર API નામો અલગથી દર્શાવવામાં આવ્યા છે.

મૂળભૂત માહિતી અને પ્રમાણીકરણ

કી વર્કસ્પેસના આધારે જારી કરવામાં આવે છે અને દરેક વિનંતીમાં Authorization હેડરમાં Bearer તરીકે ઉમેરવામાં આવે છે. નીચેના કોષ્ટકમાં આપેલા છ મૂલ્યો સાથે પ્રથમ કૉલ માટે જરૂરી સેટિંગ પૂર્ણ થાય છે.

કોષ્ટક અને ઉદાહરણમાંનું 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 હોવા જોઈએ.

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 માં હોય છે.

ભૂલ

નિષ્ફળ ગયેલી વિનંતીઓનું કારણ HTTP સ્ટેટસ કોડ દ્વારા જાણવા મળે છે. નીચેના ઉપાયો પહેલાં તપાસો અને જો એ જ કોડ વારંવાર આવે, તો રિસ્પોન્સનું id અને વિનંતીનો સમય નોંધો.

ડિપ્લોયમેન્ટના પ્રકારો

એ જ મોડેલનો ઉપયોગ ક્લાઉડ API અને ઑન-પ્રેમાઇસ ઇન્સ્ટોલેશન એમ બે રીતે થાય છે. વિનંતીનું ફોર્મેટ અને પ્રમાણીકરણની પદ્ધતિ બંને કિસ્સામાં સમાન છે, પરંતુ સરનામું અને કી મેનેજમેન્ટ સ્ક્રીન અલગ છે.

ડેટા ગવર્નન્સ

પ્લેટફોર્મ નીચેની ચાર બાબતોને મૂળભૂત વર્તન તરીકે રાખે છે. વર્કસ્પેસ વિભાજિત કરવાની રીત નક્કી કરતી વખતે આ બાબતો પણ તપાસો.

• અધિકાર આધારિત નિયંત્રણ — વર્કસ્પેસના આધારે ઍક્સેસ અધિકારો અને કીઓ અલગ પાડવામાં આવે છે.
• અલગ કાર્યસ્થળ — વર્કસ્પેસ વચ્ચે ડેટા ભળી જતો નથી.
• રીઅલ-ટાઇમ ડેટા કનેક્શન — બાહ્ય સિસ્ટમ સાથે જોડાયેલ ડેટા 조회ના સમયે લાવવામાં આવે છે.
• પ્રક્રિયા મુજબ રેકોર્ડ જાળવણી — ચલાવવામાં આવેલા કાર્યના એકમ પ્રમાણે રેકોર્ડ રાખવામાં આવે છે.

પ્રારંભનો ક્રમ

પ્રથમ વખત કનેક્ટ કરી રહ્યા હો, તો નીચેના ક્રમમાં આગળ વધો. પગલું 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 કી જારી કરો

પ્લેગ્રાઉન્ડ ખોલો