Developer guide
API ကီးဖြင့် အတည်ပြုခြင်း
API ကီးထည့်ရမည့် ဟက်ဒါနှင့် SDK တွင် သတ်မှတ်ရမည့် base URL
ဤစာမျက်နှာတွင် CLEVI ဂိတ်ဝေးသို့ API ကီးဖြင့် အတည်ပြုနည်းကို ဖော်ပြထားသည်။
OpenAI နှင့် ကိုက်ညီသည့် လမ်းကြောင်းနှင့် Anthropic နှင့် ကိုက်ညီသည့် လမ်းကြောင်းနှစ်ခုစလုံးတွင် ကီးတစ်ခုတည်းဖြင့် အတည်ပြုနိုင်သော်လည်း၊
ကီးထည့်ရမည့် ဟက်ဒါ၏ ခွင့်ပြုသည့် နယ်ပယ်နှင့် SDK တွင် သတ်မှတ်ရမည့် base URL သည် သတ်မှတ်ချက်အလိုက် ကွာခြားသည်။
အတည်ပြုရေးဟက်ဒါ
ကိုက်ညီသည့် သတ်မှတ်ချက်နှစ်ခုစလုံးတွင် API ကီးတစ်ခုတည်းဖြင့် အတည်ပြုပါသည်။ ကီးကို ကွန်ဆိုးလ်ရှိ API ကီးစာမျက်နှာမှ ထုတ်ပေးနိုင်ပြီး၊ ထိုစာမျက်နှာတစ်ခုတည်းတွင် ပယ်ဖျက်ခြင်းနှင့် အသုံးပြုနိုင်သည့် နယ်ပယ်ကို စီမံနိုင်သည်။
| ဟက်ဒါ | OpenAI နှင့် ကိုက်ညီသော | Anthropic နှင့် ကိုက်ညီသော |
|---|---|---|
| X-API-Key: <키> | အသုံးပြုနိုင်သည် | အသုံးပြုနိုင်သည် |
| Authorization: Bearer <키> | အသုံးပြုနိုင်သည် | အသုံးပြုနိုင်သည် |
| Authorization: <키> (Bearer မပါဘဲ) | ငြင်းပယ်သည် | အသုံးပြုနိုင်သည် |
ဟက်ဒါအမည်သည် စာလုံးအကြီးအသေး မခွဲခြားပါ။ 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 | 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 ကို ထည့်ထားခြင်းက ပိုကောင်းပါသည်။
| Header | အသုံးပြုမှု | ချန်လှပ်ပါက |
|---|---|---|
| X-Request-Id | တောင်းဆိုမှုကို ခြေရာခံရန် သတ်မှတ်ချက်။ Anthropic နှင့် ကိုက်ညီသော တုံ့ပြန်မှုတွင် request-id header အဖြစ် ပြန်လည်ပါဝင်လာပါသည်။ | ဆာဗာက ထုတ်ပေးပါသည်။ |
| X-Region-Code | ခေါ်ဆိုသည့် ဒေသ | global ဖြစ်ပါသည်။ |
| X-Product-Sku (query တွင် product_sku အဖြစ်လည်း အသုံးပြုနိုင်သည်) | ငွေတောင်းခံရန် အသုံးပြုမည့် Product SKU ကို တိုက်ရိုက်သတ်မှတ်ပါသည်။ Header သည် query ထက် ဦးစားပေးပြီး အသံ·voice လမ်းကြောင်းများတွင် အဓိကအသုံးပြုပါသည်။ | Voice လမ်းကြောင်းတွင် လိုအပ်ပါသည်။ audio/speech နှင့် audio/transcriptions တွင် request body ၏ model ဖြင့် Product ကို ရွေးချယ်ပါသည်။ |
| anthropic-version / anthropic-beta | Anthropic နှင့် ကိုက်ညီသော လမ်းကြောင်းတွင် မူရင်းအတိုင်း ပေးပို့ပါသည်။ | ဗားရှင်းမှာ 2023-06-01 ဖြစ်ပါသည်။ |
အတည်ပြုခြင်း မအောင်မြင်ခြင်း
Key မရှိခြင်း သို့မဟုတ် သက်တမ်းကုန်ဆုံး·ရုပ်သိမ်းထားသော key ကို ပေးပို့ခြင်းဖြစ်ပါက 401 ဖြစ်ပါသည်။ OpenAI နှင့် ကိုက်ညီသော လမ်းကြောင်းတွင် key မပါဘဲ ခေါ်ဆိုပါက အောက်ပါ body ကို ရရှိပြီး Anthropic နှင့် ကိုက်ညီသော လမ်းကြောင်း၏ error.type မှာ authentication_error ဖြစ်ပါသည်။
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- API key စာမျက်နှာတွင် key ၏ အခြေအနေကို စစ်ဆေးပါ။ သက်တမ်းကုန်ဆုံး·ရုပ်သိမ်းထားသော key ဖြစ်ပါက အသစ်ပြန်ထုတ်ပါ။
- Header အမည်မှာ X-API-Key သို့မဟုတ် Authorization ဟုတ်မဟုတ် စစ်ဆေးပါ။
- OpenAI နှင့် ကိုက်ညီသော လမ်းကြောင်းတွင် Authorization ကို အသုံးပြုပါက Bearer prefix ကို စစ်ဆေးပါ။