Developer guide
بە کلیلی API پشتڕاستکردنەوە بکە
ئەو هێدەرەی کلیلی API تێدا دادەنرێت و base URL ـی بۆ ڕێکخستن لە SDK
ڕێڕەوی CLEVI بە شێوەیەکی گونجاو لەگەڵ OpenAI و بە شێوەیەکی گونجاو لەگەڵ Anthropic، بە تەنها یەک کلیلی API پشتڕاست دەکرێتەوە.
بەهاکانی ڕێکخستن لە لایەن کڕیارەوە دوو دانەن: هێدەری پشتڕاستکردنەوەی کلیلی تێدا هەڵدەگیرێت و base URL ـی SDK؛ شێوازی هێدەری ڕێگەپێدراو و base URL لە هەر ستانداردێکدا جیاوازن.
دوای تەواوکردنی ڕێکخستنەکان، بە وەرگرتنی لیستی مۆدێلەکان دەتوانیت دەستبەجێ پشتڕاستییەکە بپشکنیت.
ئەگەر پشتڕاستکردنەوە سەرکەوتوو نەبێت، 401 دەگەڕێنێتەوە؛ ئەگەر دوای تێپەڕبوون لە پشتڕاستکردنەوە، مەرجەکانی دەسەڵات یان سنووری بەکارهێنان جێبەجێ نەکرێن، 403 دەگەڕێنێتەوە.
کلیلی API لە پەڕەی کلیلی API لە کۆنسۆڵ وەربگرە. لە هەمان پەڕەدا دەتوانیت هەڵوەشاندنەوەی کلیلیش و مەودای بەکارهێنانی بەڕێوە ببەیت.
هێدەری پشتڕاستکردنەوە
هەردوو ستانداردەکە کلیلی API لە یەک هێدەری داواکاری‌دا هەڵدەگرن. یەکێک لە هێدەری X-API-Key و Authorization بەکاردەهێنرێت، و شێوازی ڕێگەپێدراو بەپێی ستانداردەکە جیاوازە.
| هێدەر | گونجاو لەگەڵ OpenAI | گونجاو لەگەڵ Anthropic |
|---|---|---|
| X-API-Key: <کلیل> | بەردەستە | بەردەستە |
| Authorization: Bearer <کلیل> | بەردەستە | بەردەستە |
| Authorization: <کلیل> (بێ Bearer) | ڕەت دەکرێتەوە | بەردەستە |
لە ڕێڕەوی گونجاو لەگەڵ OpenAI، کاتێک هێدەری Authorization بەکاردەهێنیت، پێشگرەی Bearer پێویستە. ئەگەر تەنها کلیلەکە بنێریت بەبێ پێشگر، گەیتوەی داواکارییەکە ڕەت دەکاتەوە.
ناوی هێدەرەکان جیاوازی نێوان پیتی گەورە و بچووک ناکەن، بۆیە هێدەری x-api-key ـی نێردراو لەلایەن Anthropic SDK ـەوەش بە هەمان شێوە کار دەکات. ئەگەر هەردوو هێدەرەکە دیاری بکرێن، بەهای X-API-Key پێشتر جێبەجێ دەکرێت.
base URL
SDK ـەکانی پێشوو کە بەکارت هێناون دەتوانن بە گۆڕینی تەنها base URL بۆ ناونیشانی خوارەوە، بە هەمان شێوە بەکاربهێنرێن. جیاوازیی دوو ناونیشانەکە لەوەدایە کە /v1 لەخۆدەگرن یان نا؛ بۆیە ناونیشانی گونجاو لەگەڵ ستانداردەکە بە هەمان شێوە دیاری بکە.
| ستاندارد | base URL | یاسای ڕێڕەو |
|---|---|---|
| گونجاو لەگەڵ OpenAI | https://platform.clevi.net/api/v2/aiservice/openai/v1 | تا /v1 لە base URL ـدا لەخۆ بگرە. |
| گونجاو لەگەڵ Anthropic | https://platform.clevi.net/api/v2/aiservice/anthropic | لە پێش /v1 کۆتایی دێت، چونکە Anthropic SDK خۆی /v1 بە ڕاستەوخۆ زیاد دەکات بۆ ڕێڕەوی داواکارییەکە. |
پشتڕاستکردنەوەی پشتڕاستییەکە
دوای ڕێکخستنی کلیل و base URL، بە پشکنینی لیستی مۆدێلەکان دەتوانیت دڵنیابیت لەوەی ڕێپێدانەکە سەرکەوتووە. نموونەی خوارەوە هەمان پشکنین بە curl، OpenAI SDK و Anthropic SDK جێبەجێ دەکات. لە شوێنی sk-... ئەو کلیلە دابنێ کە لە پەڕەی API key بەرهەم هێناویت.
لە کاتی پشکنین بە curl، بۆ هەردوو ستانداردەکە ڕێڕەوی تەواو تا /v1/models دیاری بکە. فەرمانی یەکەم لە ڕێڕەوی گونجاوی OpenAI هێدەری X-API-Key بەکاردهێنێت، فەرمانی دووەمیش لە ڕێڕەوی گونجاوی Anthropic هێدەری Authorization بەکاردهێنێت.
curl https://platform.clevi.net/api/v2/aiservice/openai/v1/models \
-H "X-API-Key: sk-..."
curl https://platform.clevi.net/api/v2/aiservice/anthropic/v1/models \
-H "Authorization: Bearer sk-..." \
-H "anthropic-version: 2023-06-01"OpenAI SDK لە base_url ناونیشانێک دیاری دەکات کە /v1 ـی تێدا هەیە.
from openai import OpenAI
client = OpenAI(
api_key="sk-...",
base_url="https://platform.clevi.net/api/v2/aiservice/openai/v1",
)
for model in client.models.list():
print(model.id)Anthropic SDK لە base_url ناونیشانێک دیاری دەکات کە پێش /v1 کۆتایی پێدێت.
بۆ ڕێپێدان، هێدەری x-api-key بە هەمان شێوەیەی SDK دەنێرێت بەکاربهێنە.
from anthropic import Anthropic
client = Anthropic(
api_key="sk-...",
base_url="https://platform.clevi.net/api/v2/aiservice/anthropic",
)
for model in client.models.list(limit=20).data:
print(model.id)لە هەر نموونەیەکدا، ئەگەر وەڵامەکە 200 بێت، ڕێپێدان سەرکەوتووە و data ـی وەڵامەکە لیستی ئەو مۆدێلانەی تێدایە کە دەتوانیت بەو کلیلە بانگیان بکەیت. ئەگەر 401 بوو، هۆکارەکە بە ڕیزبەندی بەشی داهاتوو پشکنین بکە.
ڕێپێدان سەرکەوتوو نەبوو
ئەگەر کلیل نەبێت یان کلیلێکی بەسەرچوو یان هەڵوەشێنراو بنێریت، 401 دەگەڕێنێتەوە. لە ڕێڕەوی گونجاوی OpenAI، ئەگەر بەبێ کلیل بانگ بکەیت، دەقی خوارەوە دەگەڕێنێتەوە؛ لە ڕێڕەوی گونجاوی Anthropic ـدا error.type بریتییە لە authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}ئەگەر 401 ـت وەرگرت، بە ڕیزبەندیی خوارەوە پشکنین بکە.
- دۆخی کلیلەکە لە پەڕەی API key پشکنین بکە. ئەگەر بەسەرچووە یان هەڵوەشێنراوەتەوە، کلیلێکی نوێ بەرهەم بهێنە.
- دڵنیابە لەوەی ناوی هێدەرەکە X-API-Key یان Authorization ـە.
- ئەگەر لە ڕێڕەوی گونجاوی OpenAI هێدەری Authorization بەکاردهێنیت، دڵنیابە لە بوونی پێشگری Bearer.✅
دوای چاککردنەوە، پشکنینی لیستی مۆدێلەکان لە بەشی پشکنینی ڕێپێدان دووبارە جێبەجێ بکە و دڵنیابە لەوەی 200 دێتەوە.
هێدەرە هاوبەشەکان
هەموو هێدەرەکانی خوارەوە هەڵبژاردەن. بۆ بەدواداچوونی کێشەکان، پێشنیار دەکەین X-Request-Id دیاری بکەیت.
| هێدەر | بەکارهێنان | ئەگەر جێی بهێڵیت |
|---|---|---|
| X-Request-Id | ناسنامەی شوێنکەوتنی داواکارییە. ڕێڕەوی هاوشێوەی Anthropic هەمان بەها لە هێدەری request-id ـی وەڵامدا دەگەڕێنێتەوە. | لە لایەن ڕاژەکارەوە دابین دەکرێت. |
| X-Region-Code | هەرێمی بانگکردن دیاری دەکات. | global ـە. |
| X-Product-Sku (هەروەها دەتوانرێت بە product_sku ـی query دیاری بکرێت) | Product SKU ـی بەکارهاتوو بۆ پسوڵەکردن ڕاستەوخۆ دیاری دەکات. هێدەر لە query پێش دەکەوێت و بە زۆری لە ڕێڕەوی دەنگ و ڤۆیسدا بەکاردێت. | لە ڕێڕەوی ڤۆیسدا ناتوانرێت بەجێبهێڵرێت. audio/speech و audio/transcriptions ـەکان Product بە model ـی ناوەڕۆکی داواکاری هەڵدەبژێرن. |
| anthropic-version / anthropic-beta | لە ڕێڕەوی هاوشێوەی Anthropic ـدا بە هەمان شێوە دەگوازرێتەوە. | وەشانەکە 2023-06-01 ـە. |
ئەگەر 5xx دووبارە ببێتەوە، تکایە لەگەڵ X-Request-Id بە یارمەتی و پەیوەندیکردن ئاگادارمان بکەنەوە. ئەگەر بەهایەکە بە دەستی دیاری کرابێت، دەتوانرێت ڕاستەوخۆ لەگەڵ تۆمارەکانی کلایەنت بەراورد بکرێت.