Developer guide
بە کلیلی API پشتڕاستکردنەوە بکە
ئەو سەرپۆشەی کلیلی API تێدەخەیت و ئەو base URL ـەی لە SDK دادەنێیت
ئەم لاپەڕەیە شێوازی پشتڕاستکردنەوە بە کلیلی API لە ڕێڕەوی CLEVI باس دەکات.
هەردوو ڕێڕەوی هاوشێوەی OpenAI و هاوشێوەی Anthropic بە یەک کلیل پشتڕاست دەکرێنەوە،
بەڵام مەودای ڕێگەپێدراوی سەرپۆشی کلیلی API و ئەو base URL ـەی لە SDK دادەنرێت بە پێی ستانداردەکە جیاوازە.
سەرپۆشی پشتڕاستکردنەوە
هەردوو ستانداردی هاوشێوە بە یەک کلیلی API پشتڕاست دەکرێنەوە. کلیلەکە لە پەڕەی کلیلی API ـی کۆنسۆڵ وەردەگیرێت، و لە هەمان پەڕەدا هەڵوەشاندنەوە و بەڕێوەبردنی مەودای بەکارهێنان بەڕێوەدەبرێت.
| سەرپۆش | هاوشێوەی OpenAI | هاوشێوەی Anthropic |
|---|---|---|
| X-API-Key: <کلیل> | بەردەستە | بەردەستە |
| Authorization: Bearer <کلیل> | بەردەستە | بەردەستە |
| Authorization: <کلیل> (بەبێ Bearer) | ڕەتدەکرێتەوە | بەردەستە |
ناوی سەرپۆشەکان جیاوازیی گەورە و بچووک نابینێت. x-api-key ـی نێردراو لەلایەن Anthropic SDK ـەوەش بە هەمان شێوە کار دەکات.
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 | چونکە Anthropic SDK خۆی /v1 بۆ ڕێڕەوەکە زیاد دەکات، لە پێش /v1 کۆتایی پێدەهێنێت. |
پشتڕاستکردنەوەی پشتڕاستی
کلیل و base URL دابنێ و لیستی مۆدێلەکان بخوێنەوە؛ بەوە دەتوانیت دەستبەجێ بزانیت پشتڕاستکراویتەوە یان نا. سێ نموونەی خوارەوە هەمان خوێندنەوە بە curl، OpenAI SDK و Anthropic SDK ئەنجام دەدەن.
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"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)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)لە شوێنی sk-... ئەو کلیلییە دابنێ کە لە پەڕەی کلیلی API وەرتگرتووە.
- ئەگەر وەڵامەکە 200 بێت، پشتڕاستکردنەوە ئەنجام دراوە. لە data ـدا لیستی ئەو مۆدێلانە هەیە کە بەو کلیلە دەتوانیت بانگیان بکەیت.
- ئەگەر وەڵامەکە 401 بێت، بە ڕیزبەندی بەشی شکستی پشتڕاستکردنەوەی خوارەوە پشکنین بکە.
سەرپۆشە بەکارهێنراوەکان
هەموویان هەڵبژاردەن. بۆ شوێنکەوتنی کێشەکان، باشترە 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 بە model ـی ناوەڕۆک Product هەڵدەبژێرن. |
| anthropic-version / anthropic-beta | لە ڕێڕەوی گونجاو لەگەڵ Anthropic ـدا بە هەمان شێوە دەگوازرێتەوە. | وەشانەکە 2023-06-01 ـە. |
شکستی ڕەسەناندن
ئەگەر کلیلت نەبێت یان کلیلی بەسەرچوو یان هەڵوەشاوە بنێردرێت، 401 ـە. لە ڕێڕەوی گونجاو لەگەڵ OpenAI ـدا، ئەگەر بەبێ کلیلی بانگ بکەیت، ناوەڕۆکی خوارەوە دێت و لە ڕێڕەوی گونجاو لەگەڵ Anthropic ـدا، error.type بریتییە لە authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- لە پەڕەی کلیلی API ـدا دۆخی کلیلی پشکنین بکە. ئەگەر کلیلەکە بەسەرچوو یان هەڵوەشاوە بێت، نوێیەک دابین بکە.
- دڵنیابە ناوی هێدەرەکە X-API-Key یان Authorization ـە.
- ئەگەر لە ڕێڕەوی گونجاو لەگەڵ OpenAI ـدا Authorization بەکاربهێنیت، پێشگری Bearer بپشکنە.
