ਤੇਜ਼ ਸ਼ੁਰੂਆਤ

ਇਹ ਦਸਤਾਵੇਜ਼ CLEVI API ਕੁੰਜੀ ਜਾਰੀ ਕਰਵਾਉਣ, ਪਹਿਲੀ ਬੇਨਤੀ ਭੇਜਣ ਅਤੇ ਜਵਾਬ ਪ੍ਰਾਪਤ ਕਰਨ ਤੱਕ ਦੀ ਪ੍ਰਕਿਰਿਆ ਦੱਸਦਾ ਹੈ। ਇੱਕ ਪਤੇ ਅਤੇ ਇੱਕ ਕੁੰਜੀ ਨਾਲ cip-5.5-im ਅਤੇ cip-5.5-mm ਨੂੰ ਕਾਲ ਕੀਤਾ ਜਾ ਸਕਦਾ ਹੈ। ਬੇਨਤੀਆਂ ਅਤੇ ਜਵਾਬ OpenAI Chat Completions ਫਾਰਮੈਟ ਦੀ ਪਾਲਣਾ ਕਰਦੇ ਹਨ, ਇਸ ਲਈ ਤੁਸੀਂ ਵਰਤ ਰਹੇ OpenAI SDK ਵਿੱਚ ਸਿਰਫ਼ base_url ਅਤੇ api_key ਦੀਆਂ ਦੋ ਮੁੱਲਾਂ ਨੂੰ ਬਦਲਣਾ ਹੈ। Anthropic SDK ਲਈ ਪਾਥ ਅਤੇ ਐਮਬੈਡਿੰਗ・ਆਵਾਜ਼ ਵਾਲੇ ਪਾਥ API ਕਾਲ ਕਰਨਾ ਦਸਤਾਵੇਜ਼ ਵਿੱਚ ਹਨ।

API ਕੁੰਜੀ ਜਾਰੀ ਕਰਵਾਉਣਾ

ਕੁੰਜੀ CLEVI Cloud ਕੰਸੋਲ ਦੀ API ਕੁੰਜੀ ਸਕ੍ਰੀਨ ਤੋਂ ਜਾਰੀ ਕੀਤੀ ਜਾਂਦੀ ਹੈ। ਇਸੇ ਸਕ੍ਰੀਨ ਤੋਂ ਤੁਸੀਂ ਕੁੰਜੀ ਰੱਦ ਕਰ ਸਕਦੇ ਹੋ ਅਤੇ ਇਸਦੀ ਵਰਤੋਂ ਦੀ ਸੀਮਾ ਪ੍ਰਬੰਧਿਤ ਕਰ ਸਕਦੇ ਹੋ। ਹੇਠਾਂ ਦਿੱਤੇ ਕ੍ਰਮ ਦੀ ਪਾਲਣਾ ਕਰਕੇ ਤੁਹਾਨੂੰ ਬੇਨਤੀਆਂ ਲਈ ਵਰਤਣ ਵਾਲੀ ਇੱਕ ਕੁੰਜੀ ਮਿਲ ਜਾਵੇਗੀ।

1. https://platform.clevi.net/account/login 'ਤੇ ਲੌਗ ਇਨ ਕਰੋ ਜਾਂ ਖਾਤਾ ਬਣਾਓ।
2. https://clevi.app/cloud 'ਤੇ ਵਰਕਸਪੇਸ ਸ਼ਾਮਲ ਕਰੋ।
3. https://clevi.app/cloud/keys 'ਤੇ ਜਾਓ।
4. ਨਵੀਂ ਕੁੰਜੀ ਜਾਰੀ ਕਰੋ ਅਤੇ ਇਸਦਾ ਮੁੱਲ ਕਾਪੀ ਕਰੋ।
5. ਕਾਪੀ ਕੀਤੇ ਮੁੱਲ ਨੂੰ ਵਾਤਾਵਰਣ ਚਲ ਵਿੱਚ ਸੁਰੱਖਿਅਤ ਕਰੋ।

ਇਸ ਦਸਤਾਵੇਜ਼ ਦੇ ਉਦਾਹਰਣਾਂ ਵਿੱਚ sk-... ਦੀ ਥਾਂ ਜਾਰੀ ਕਰਵਾਈ ਕੁੰਜੀ ਦਰਜ ਕਰੋ। ਹੇਠਾਂ ਦਿੱਤੀ ਕਮਾਂਡ ਨਾਲ ਇਸਨੂੰ ਵਾਤਾਵਰਣ ਚਲ ਵਿੱਚ ਸੁਰੱਖਿਅਤ ਕਰ ਲੈਣ 'ਤੇ ਤੁਸੀਂ ਅਗਲੇ ਉਦਾਹਰਣਾਂ ਨੂੰ ਜਿਵੇਂ ਦਾ ਤਿਵੇਂ ਕਾਪੀ ਕਰਕੇ ਚਲਾ ਸਕਦੇ ਹੋ।

export CLEVI_API_KEY="sk-..."

ਮਾਡਲ ਚੁਣਨਾ

ਬੇਨਤੀ ਦੇ ਮੁੱਖ ਭਾਗ ਦੇ model ਫੀਲਡ ਵਿੱਚ ਹੇਠਾਂ ਦਿੱਤੇ ਨਾਮ ਜਿਵੇਂ ਦੇ ਤਿਵੇਂ ਦਰਜ ਕਰੋ। ਦੋਵੇਂ ਮਾਡਲ ਇੱਕੋ ਪਤੇ ਅਤੇ ਇੱਕੋ ਬੇਨਤੀ ਫਾਰਮੈਟ ਦੀ ਵਰਤੋਂ ਕਰਦੇ ਹਨ ਅਤੇ ਇਨਪੁੱਟ ਵਜੋਂ ਟੈਕਸਟ ਅਤੇ ਚਿੱਤਰ ਲੈਂਦੇ ਹਨ।

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

ਤੁਹਾਡੇ ਖਾਤੇ ਤੋਂ ਅਸਲ ਵਿੱਚ ਕਾਲ ਕੀਤੇ ਜਾ ਸਕਣ ਵਾਲੇ ਮਾਡਲਾਂ ਲਈ ਪਲੇਗ੍ਰਾਊਂਡ ਵਿੱਚ ਮਾਡਲਾਂ ਦੀ ਸੂਚੀ ਅਤੇ GET /models ਦੇ ਜਵਾਬ ਨੂੰ ਮਾਪਦੰਡ ਮੰਨੋ। ਪੂਰੀ ਮਾਡਲ ਸੂਚੀ ਅਤੇ ਹਰੇਕ ਮਾਡਲ ਲਈ ਮਨਜ਼ੂਰਸ਼ੁਦਾ ਕਾਲਾਂ ਮਾਡਲ ਦਸਤਾਵੇਜ਼ ਵਿੱਚ ਹਨ, ਜਦਕਿ ਅਨੁਮਾਨਿਤ ਕੱਟੇ ਜਾਣ ਵਾਲੇ ਕ੍ਰੈਡਿਟ ਕੰਸੋਲ ਦੀ ਵਰਤੋਂ ਸਕ੍ਰੀਨ 'ਤੇ ਹਨ।

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

ਸੁਨੇਹਿਆਂ ਦੀ ਐਰੇ ਅਤੇ ਮਾਡਲ ਦਾ ਨਾਮ ਲੈ ਕੇ, ਮਾਡਲ ਵੱਲੋਂ ਬਣਾਏ ਸੁਨੇਹਿਆਂ ਨੂੰ choices ਐਰੇ ਵਿੱਚ ਸ਼ਾਮਲ ਕਰਕੇ ਵਾਪਸ ਕਰਦਾ ਹੈ। ਪੂਰਾ ਪਤਾ https://platform.clevi.net/api/v2/aiservice/openai/v1/chat/completions ਹੈ। ਬੇਨਤੀ ਦਾ ਮੁੱਖ ਭਾਗ application/json ਹੈ, ਅਤੇ ਪ੍ਰਮਾਣੀਕਰਨ ਲਈ Authorization ਹੈਡਰ ਵਿੱਚ Bearer ਪ੍ਰੀਫਿਕਸ ਅਤੇ ਕੁੰਜੀ ਸ਼ਾਮਲ ਕਰੋ। ਤੁਸੀਂ X-API-Key ਹੈਡਰ ਰਾਹੀਂ ਵੀ ਕੁੰਜੀ ਭੇਜ ਸਕਦੇ ਹੋ; ਜੇ ਦੋਵੇਂ ਹੈਡਰ ਨਿਰਧਾਰਤ ਕੀਤੇ ਜਾਣ, ਤਾਂ X-API-Key ਦਾ ਮੁੱਲ ਪਹਿਲ ਦਿੱਤਾ ਜਾਂਦਾ ਹੈ।

curl https://platform.clevi.net/api/v2/aiservice/openai/v1/chat/completions \
  -H "Authorization: Bearer $CLEVI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "cip-5.5-im",
    "messages": [
      {"role": "user", "content": "CLEVI API를 한 문장으로 설명해 줘."}
    ]
  }'

import os
import requests

url = "https://platform.clevi.net/api/v2/aiservice/openai/v1/chat/completions"

response = requests.post(
    url,
    headers={"Authorization": f"Bearer {os.environ['CLEVI_API_KEY']}"},
    json={
        "model": "cip-5.5-im",
        "messages": [{"role": "user", "content": "CLEVI API를 한 문장으로 설명해 줘."}],
    },
    timeout=60,
)

print(response.json()["choices"][0]["message"]["content"])

const url =
  "https://platform.clevi.net/api/v2/aiservice/openai/v1/chat/completions";

const response = await fetch(url, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.CLEVI_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    model: "cip-5.5-im",
    messages: [{ role: "user", content: "CLEVI API를 한 문장으로 설명해 줘." }],
  }),
});

const data = await response.json();
console.log(data.choices[0].message.content);

ਇਹ ਜਵਾਬ ਦੀ ਉਦਾਹਰਨ ਹੈ। id, created, usage ਦੇ ਮੁੱਲ ਹਰ ਬੇਨਤੀ ਨਾਲ ਵੱਖਰੇ ਹੁੰਦੇ ਹਨ।

{
  "id": "chatcmpl-3f0a9c72",
  "object": "chat.completion",
  "created": 1755500000,
  "model": "cip-5.5-im",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "CLEVI API는 주소 하나로 여러 모델을 호출하는 채팅 완료 API입니다."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 21,
    "completion_tokens": 19,
    "total_tokens": 40
  }
}

OpenAI SDK ਨਾਲ ਕਾਲ ਕਰਨਾ

OpenAI SDK ਦਾ base_url https://platform.clevi.net/api/v2/aiservice/openai/v1 ਵਿੱਚ ਬਦਲੋ ਅਤੇ api_key ਵਿੱਚ CLEVI ਕੁੰਜੀ ਪਾਓ। ਬਾਕੀ ਕਾਲ ਕੋਡ ਨੂੰ ਜਿਉਂ ਦਾ ਤਿਉਂ ਰੱਖੋ।

# 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/v2/aiservice/openai/v1",
)

completion = client.chat.completions.create(
    model="cip-5.5-mm",
    messages=[{"role": "user", "content": "CLEVI 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/v2/aiservice/openai/v1",
});

const completion = await client.chat.completions.create({
  model: "cip-5.5-mm",
  messages: [{ role: "user", content: "CLEVI API를 한 문장으로 설명해 줘." }],
});

console.log(completion.choices[0].message.content);

ਸਟ੍ਰੀਮਿੰਗ ਰਾਹੀਂ ਪ੍ਰਾਪਤ ਕਰਨਾ

ਜੇਕਰ ਬੇਨਤੀ ਦੇ ਬਾਡੀ ਵਿੱਚ stream ਨੂੰ true ਸੈੱਟ ਕੀਤਾ ਜਾਂਦਾ ਹੈ, ਤਾਂ ਸਰਵਰ Server-Sent Events ਰਾਹੀਂ ਜਵਾਬ ਦਿੰਦਾ ਹੈ। ਪਹਿਲੇ ਹਿੱਸੇ ਦੇ ਨਾਲ Content-Type: text/event-stream, Cache-Control: no-cache, X-Accel-Buffering: no ਹੈਡਰ ਭੇਜੇ ਜਾਂਦੇ ਹਨ, ਅਤੇ ਇਸ ਤੋਂ ਬਾਅਦ ਹਰ ਹਿੱਸੇ ਵਿੱਚ data: ਲਾਈਨ ਵਿੱਚ chat.completion.chunk ਆਬਜੈਕਟ ਸ਼ਾਮਲ ਹੁੰਦਾ ਹੈ। ਆਖਰੀ ਲਾਈਨ data: [DONE] ਹੁੰਦੀ ਹੈ। ਹੇਠਾਂ ਦਿੱਤੇ Python ਅਤੇ TypeScript ਉਦਾਹਰਨ ਪਿਛਲੇ ਭਾਗ ਵਿੱਚ ਬਣਾਏ client ਨੂੰ ਜਿਵੇਂ ਦਾ ਤਿਵੇਂ ਵਰਤਦੇ ਹਨ।

curl -N https://platform.clevi.net/api/v2/aiservice/openai/v1/chat/completions \
  -H "Authorization: Bearer $CLEVI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "cip-5.5-im",
    "messages": [{"role": "user", "content": "CLEVI API를 한 문장으로 설명해 줘."}],
    "stream": true
  }'

stream = client.chat.completions.create(
    model="cip-5.5-im",
    messages=[{"role": "user", "content": "CLEVI API를 한 문장으로 설명해 줘."}],
    stream=True,
)

for chunk in stream:
    delta = chunk.choices[0].delta.content
    if delta:
        print(delta, end="")

const stream = await client.chat.completions.create({
  model: "cip-5.5-im",
  messages: [{ role: "user", content: "CLEVI API를 한 문장으로 설명해 줘." }],
  stream: true,
});

for await (const chunk of stream) {
  process.stdout.write(chunk.choices[0]?.delta?.content ?? "");
}

ਇਹ ਹਿੱਸੇ ਦਾ ਉਦਾਹਰਨ ਹੈ।

data: {"id":"chatcmpl-3f0a9c72","object":"chat.completion.chunk","model":"cip-5.5-im","choices":[{"index":0,"delta":{"content":"CLEVI"},"finish_reason":null}]}

data: {"id":"chatcmpl-3f0a9c72","object":"chat.completion.chunk","model":"cip-5.5-im","choices":[{"index":0,"delta":{"content":" API는"},"finish_reason":null}]}

data: {"id":"chatcmpl-3f0a9c72","object":"chat.completion.chunk","model":"cip-5.5-im","choices":[{"index":0,"delta":{},"finish_reason":"stop"}]}

data: [DONE]

ਜੇਕਰ ਸਟ੍ਰੀਮਿੰਗ ਦੌਰਾਨ ਕੋਈ ਗਲਤੀ ਆਉਂਦੀ ਹੈ, ਤਾਂ ਉਹੀ ਗਲਤੀ JSON data: ਦੀ ਇੱਕ ਲਾਈਨ ਵਜੋਂ ਆਉਂਦਾ ਹੈ ਅਤੇ HTTP ਸਟੇਟਸ ਕੋਡ ਵੀ ਬਦਲ ਜਾਂਦਾ ਹੈ।

ਗਲਤੀਆਂ

ਅਸਫਲ ਬੇਨਤੀ ਦਾ ਕਾਰਨ HTTP ਸਟੇਟਸ ਕੋਡ ਰਾਹੀਂ ਦੱਸਿਆ ਜਾਂਦਾ ਹੈ। ਜੇਕਰ ਅੱਪਸਟ੍ਰੀਮ 4xx·5xx ਵਾਪਸ ਕਰਦਾ ਹੈ, ਤਾਂ ਉਹੀ ਕੋਡ ਜਿਉਂ ਦਾ ਤਿਉਂ ਅੱਗੇ ਭੇਜਿਆ ਜਾਂਦਾ ਹੈ। ਪਹਿਲਾਂ ਹੇਠਾਂ ਦਿੱਤੀ ਸਾਰਣੀ ਵਿੱਚ ਦਿੱਤੇ ਉਪਾਅ ਜਾਂਚੋ, ਅਤੇ ਜੇਕਰ ਉਹੀ ਕੋਡ ਵਾਰ-ਵਾਰ ਆਵੇ, ਤਾਂ ਬੇਨਤੀ ਦਾ ਸਮਾਂ, ਭੇਜਿਆ ਗਿਆ ਬਾਡੀ ਅਤੇ X-Request-Id ਦਰਜ ਕਰਕੇ ਰੱਖੋ।

402 ਵਾਪਸ ਨਹੀਂ ਕੀਤਾ ਜਾਂਦਾ। ਕ੍ਰੈਡਿਟ ਦੀ ਘਾਟ ਅਤੇ ਵਰਤੋਂ ਸੀਮਾ ਤੋਂ ਵੱਧ ਜਾਣਾ 403 ਵਜੋਂ ਆਉਂਦਾ ਹੈ। ਗਲਤੀ ਦਾ ਮੁੱਖ ਭਾਗ ਹੇਠਾਂ ਦਿੱਤੇ ਫਾਰਮੈਟ ਵਿੱਚ ਹੁੰਦਾ ਹੈ ਅਤੇ ਕਾਰਨ error.message ਵਿੱਚ ਸ਼ਾਮਲ ਹੁੰਦਾ ਹੈ।

{"error":{"message":"API key is required.","type":"invalid_request_error"}}

ਜੇ ਤੁਸੀਂ ਬੇਨਤੀ ਵਿੱਚ X-Request-Id ਹੈਡਰ ਸ਼ਾਮਲ ਕਰਦੇ ਹੋ, ਤਾਂ ਸੰਪਰਕ ਕਰਦੇ ਸਮੇਂ ਉਸ ਮੁੱਲ ਰਾਹੀਂ ਟ੍ਰੈਕ ਕੀਤਾ ਜਾ ਸਕਦਾ ਹੈ। ਜੇ ਇਹ ਨਹੀਂ ਭੇਜਿਆ ਜਾਂਦਾ, ਤਾਂ ਸਰਵਰ ਇਸਨੂੰ ਜਾਰੀ ਕਰਦਾ ਹੈ।

ਅਗਲੇ ਕਦਮ

ਮਾਡਲ ਦੇ ਨਾਮ ਅਤੇ ਪੈਰਾਮੀਟਰ ਬਦਲ ਕੇ ਨਤੀਜਿਆਂ ਦੀ ਤੁਲਨਾ ਪਲੇਗ੍ਰਾਊਂਡ ਵਿੱਚ ਕਰੋ। ਨਵੀਂ ਕੁੰਜੀ ਬਣਾਉਣ ਜਾਂ ਕੁੰਜੀ ਰੱਦ ਕਰਨ ਲਈ API ਕੁੰਜੀ ਸਕ੍ਰੀਨ ਦੀ ਵਰਤੋਂ ਕਰੋ। ਅੱਗੇ ਪੜ੍ਹਨ ਲਈ ਦਸਤਾਵੇਜ਼ ਇਹ ਹਨ।

• ਮਾਡਲ: ਮਾਡਲਾਂ ਦੀ ਪੂਰੀ ਸੂਚੀ, ਹਰੇਕ ਮਾਡਲ ਦੀਆਂ ਵਿਸ਼ੇਸ਼ਤਾਵਾਂ ਅਤੇ ਮਨਜ਼ੂਰਸ਼ੁਦਾ ਕਾਲਾਂ
• API ਕਾਲ ਕਰਨਾ: Anthropic-ਅਨੁਕੂਲ ਮਾਰਗ, ਐਂਬੈਡਿੰਗ ਅਤੇ ਆਵਾਜ਼ ਦੇ ਮਾਰਗ, ਸਟ੍ਰੀਮਿੰਗ ਨਿਯਮ
• ਗਲਤੀ ਕੋਡ: ਸਥਿਤੀ ਕੋਡਾਂ ਦੀ ਪੂਰੀ ਸਾਰਣੀ ਅਤੇ ਮੁੜ ਕੋਸ਼ਿਸ਼ ਦੇ ਨਿਯਮ

ਪਲੇਗ੍ਰਾਊਂਡ ਖੋਲ੍ਹੋ

API ਕੁੰਜੀਆਂ ਪ੍ਰਬੰਧਿਤ ਕਰੋ