API کال کرنا

CLEVI گیٹ وے کے کال راستے OpenAI کے موافق معیار اور Anthropic کے موافق معیار میں تقسیم ہیں۔
دونوں معیارات ایک ہی API key استعمال کرتے ہیں، اور مکالماتی استدلال کے ماڈلز کو کسی بھی معیار کے ذریعے کال کیا جا سکتا ہے۔
ایمبیڈنگ اور آڈیو و وائس کے راستے صرف OpenAI کے موافق معیار میں موجود ہیں،
جبکہ Anthropic کے موافق معیار میں messages، count_tokens اور models کے تین راستے فراہم کیے جاتے ہیں۔

اسٹریمنگ کو درخواست کے باڈی میں stream کے ذریعے فعال کیا جاتا ہے، اور ایمبیڈنگز اور کچھ ماڈلز و راستے اسے سپورٹ نہیں کرتے۔ آڈیو و وائس کے راستے آڈیو براہِ راست واپس کرتے ہیں اور آؤٹ پٹس کو CleviDrive میں 3 دن تک محفوظ رکھتے ہیں، اس لیے ان کے قواعد عام استدلال سے مختلف ہیں۔

ماڈل ID اور ہر ماڈل کے لیے قابلِ اجازت کالز ماڈل صفحے پر موجود ہیں، جبکہ توثیقی ہیڈر اور base URL، API key کے ذریعے توثیق کرنے کے صفحے پر موجود ہیں۔

راستے کا انتخاب

آپ جو کام کرنا چاہتے ہیں اور جو SDK استعمال کر رہے ہیں، اس کے مطابق راستہ منتخب کریں۔ جدول میں دیے گئے راستے ہر معیار کے base URL کے بعد آنے والے نسبتی راستے ہیں۔

OpenAI کے موافق راستہ

OpenAI کے موافق معیار کا base URL https://platform.clevi.net/api/v2/aiservice/openai/v1 ہے۔ درخواست اور جواب کے باڈیز OpenAI کے معیار کی پیروی کرتے ہیں۔ نیچے دیے گئے جدول میں استدلال اور ماڈل کے راستے میزبان کی بنیاد پر مکمل راستوں کے طور پر درج ہیں، جبکہ آڈیو و وائس کے راستے بعد کے آڈیو اور وائس کے راستوں والے حصے میں بیان کیے گئے ہیں۔

chat/completions کو کال کرنے کی کم سے کم مثال ہے۔ sk-... کی جگہ API کلید کے صفحے سے جاری کردہ کلید درج کریں، اور model میں ماڈل صفحے کی ID درج کریں۔

curl https://platform.clevi.net/api/v2/aiservice/openai/v1/chat/completions \
  -H "X-API-Key: sk-..." \
  -H "Content-Type: application/json" \
  -d '{
    "model": "cip-5.5-im",
    "messages": [{"role": "user", "content": "안녕하세요"}]
  }'

دیگر راستے

درج ذیل راستے تشخیص، لیگیسی مطابقت اور ریلے کے لیے ہیں۔

درخواست اور جواب کے تمام فیلڈز OpenAPI 3.0 دستاویز https://platform.clevi.net/api/v2/console/openapi/cloud-inference-v1 میں دیکھے جا سکتے ہیں۔ راستوں کی فہرست اسی دستاویز سے تیار کی جاتی ہے، اور دستاویز صرف کنسول میں لاگ اِن سیشن کے ذریعے کھولی جا سکتی ہے۔ اسی دستاویز سے کلائنٹ تیار کیا جا سکتا ہے۔

Anthropic سے ہم آہنگ راستے

Anthropic سے ہم آہنگ معیار کا base URL https://platform.clevi.net/api/v2/aiservice/anthropic ہے، اور Anthropic SDK درخواست کے راستے میں /v1 براہِ راست شامل کرتا ہے۔ درخواست اور جواب کے باڈیز Anthropic Messages کے معیار کے مطابق ہیں۔

messages کو کال کرنے کی کم سے کم مثال ہے۔

curl https://platform.clevi.net/api/v2/aiservice/anthropic/v1/messages \
  -H "X-API-Key: sk-..." \
  -H "anthropic-version: 2023-06-01" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "cip-5.5-im",
    "max_tokens": 1024,
    "messages": [{"role": "user", "content": "안녕하세요"}]
  }'

اگر anthropic-version ہیڈر شامل نہ کیا جائے تو اسے 2023-06-01 تصور کیا جاتا ہے۔ گیٹ وے anthropic-version اور anthropic-beta ہیڈرز کو جوں کا توں آگے بھیجتا ہے۔

اسٹریمنگ (SSE)

اگر درخواست کے باڈی میں stream کو true پر سیٹ کیا جائے تو سرور Server-Sent Events کے ذریعے جواب دیتا ہے۔ معاونت دستیاب ہونے یا نہ ہونے کی صورتِ حال پاتھ اور ماڈل کے لحاظ سے درج ذیل ہے۔

پہلے چنک کے ساتھ درج ذیل تین ہیڈرز بھیجے جاتے ہیں۔ اس کے بعد ہر چنک کے ساتھ data: لائن بھیجی جاتی ہے اور فوراً flush کیا جاتا ہے، جبکہ اپ اسٹریم ایونٹ کا نام فراہم کرے تو ہی event: لائن بھیجی جاتی ہے۔

• Content-Type: text/event-stream
• Cache-Control: no-cache
• X-Accel-Buffering: no

Anthropic کے موافق پاتھ کے چنکس میں event لائن اور data لائن ایک جوڑے کی صورت میں ہوتی ہیں۔

event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":"안"}}

chat/completions کے چنکس data لائن کے طور پر آتے ہیں، اور آخر میں data: [DONE] کو جوں کا توں آگے بھیجا جاتا ہے۔

data: {"id":"chatcmpl-...","object":"chat.completion.chunk","choices":[...]}

data: [DONE]

اسٹریمنگ کے دوران خرابی پیش آنے پر عام کال کی طرح خرابی کا JSON data: کی ایک لائن کے طور پر بھیجا جاتا ہے، اور HTTP اسٹیٹس کوڈ بھی تبدیل ہو جاتا ہے۔

آواز اور وائس پاتھ

TTS·STT اور Cosa وائس مینجمنٹ پاتھ OpenAI کے موافق معیار پر ہیں، اور عام استنباط سے مختلف چند قواعد لاگو ہوتے ہیں۔ کون سا ماڈل کس پاتھ کی اجازت دیتا ہے، یہ ماڈل کے صفحے پر موجود Cosa جدول میں دیکھیں۔

درج ذیل قواعد صرف آواز اور وائس کے راستوں پر لاگو ہوتے ہیں۔