Developer guide
Kutsimikizira pogwiritsa ntchito kiyi ya API
Mutu womwe muyenera kuyikamo kiyi ya API ndi base URL yomwe muyenera kukhazikitsa mu SDK
Njira ya CLEVI imatsimikizira njira zogwirizana ndi OpenAI ndi njira zogwirizana ndi Anthropic pogwiritsa ntchito kiyi imodzi ya API.
Mfundo ziwiri zomwe muyenera kukhazikitsa ku kasitomala ndi mutu wotsimikizira womwe uli ndi kiyi ndi base URL ya SDK, ndipo mawonekedwe a mitu ololedwa ndi base URL zimasiyana malinga ndi muyezo.
Mukamaliza kukhazikitsa, mutha kutsimikizira nthawi yomweyo ngati kutsimikizira kwachitika pofunsa mndandanda wa ma model.
Ngati kutsimikizira kwalephera, imabwezera 401; ngati kutsimikizira kwadutsa koma zofunikira za chilolezo kapena malire sizinakwaniritsidwe, imabwezera 403.
Pezani kiyi ya API patsamba la makiyi a API mu console. Patsamba lomwelo, mutha kuyang'anira kuthetsa kwa kiyi ndi kuchuluka kwa ntchito yomwe imaloledwa.
Mutu wotsimikizira
Miyezo yonseyi imayika kiyi ya API mumutu umodzi wa pempho. Gwiritsani ntchito mutu wa X-API-Key kapena Authorization, ndipo mawonekedwe ololedwa amasiyana malinga ndi muyezo.
| Mutu | Wogwirizana ndi OpenAI | Wogwirizana ndi Anthropic |
|---|---|---|
| X-API-Key: <kiyi> | Wololedwa | Wololedwa |
| Authorization: Bearer <kiyi> | Wololedwa | Wololedwa |
| Authorization: <kiyi> (popanda Bearer) | Wakanidwa | Wololedwa |
Mukamagwiritsa ntchito mutu wa Authorization pa njira yogwirizana ndi OpenAI, chiyambi cha Bearer ndichofunikira. Mukatumiza kiyi yokha popanda chiyambi chimenechi, njira imakana pempholo.
Mayina a mitu sasiyanitsa zilembo zazikulu ndi zing'onozing'ono, choncho mutu wa x-api-key womwe Anthropic SDK imatumiza umagwiranso ntchito momwe ulili. Mukatchula mitu yonseyi, mtengo wa X-API-Key ndiwo umagwiritsidwa ntchito poyamba.
base URL
Ma SDK omwe mumagwiritsa ntchito kale angapitirize kugwiritsidwa ntchito pongosintha base URL kukhala adilesi ili pansipa. Maadiresi awiriwa amasiyana pa kukhala ndi /v1 kapena ayi, choncho tchulani adilesi yogwirizana ndi muyezo momwe ilili.
| Muezo | base URL | Malamulo a njira |
|---|---|---|
| Wogwirizana ndi OpenAI | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Phatikizani /v1 mu base URL. |
| Wogwirizana ndi Anthropic | https://platform.clevi.net/api/v2/aiservice/anthropic | Imathera /v1 isanayambe, chifukwa Anthropic SDK imawonjezera /v1 yokha munjira ya pempho. |
Kutsimikizira kutsimikizira
Mukakhazikitsa kiyi ndi base URL, mutha kutsimikizira ngati mwalowa polowa powerenga mndandanda wa ma model. Chitsanzo chili pansipa chikuyendetsa kuwerengaku pogwiritsa ntchito curl, OpenAI SDK, ndi Anthropic SDK. M’malo mwa sk-... ikani kiyi yomwe mwapanga patsamba la ma API key.
Mukawerenga pogwiritsa ntchito curl, tchulani njira yonse mpaka /v1/models pamitundu yonse iwiri. Lamulo loyamba limagwiritsa ntchito mutu wa X-API-Key pa njira yogwirizana ndi OpenAI, ndipo lamulo lachiwiri limagwiritsa ntchito mutu wa Authorization pa njira yogwirizana ndi Anthropic.
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"Mu OpenAI SDK, tchulani adilesi yomwe ili ndi /v1 mu base_url.
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)Mu Anthropic SDK, tchulani adilesi ya base_url yomwe imathera musanafike pa /v1.
Pa kutsimikizira, gwiritsani ntchito mutu wa x-api-key womwe SDK imatumiza monga ulili.
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)Ngati yankho la chitsanzo chilichonse lili 200, kutsimikizira kwachitika bwino, ndipo data mu yankho ili ndi mndandanda wa ma model omwe mungayitane pogwiritsa ntchito kiyi imeneyi. Ngati pali 401, fufuzani chifukwa chake motsatira dongosolo la gawo lotsatira.
Kutsimikizira kwalephera
Ngati mutumiza kiyi yomwe ilibe, yatha ntchito, kapena yathetsedwa, mudzalandira 401. Mukayimba popanda kiyi pa njira yogwirizana ndi OpenAI, thupi ili pansipa limabwezedwa; pa njira yogwirizana ndi Anthropic, error.type imakhala authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}Mukalandira 401, fufuzani motsatira dongosolo ili.
- Yang’anani momwe kiyi ilili patsamba la ma API key. Ngati yatha ntchito kapena yathetsedwa, pangani ina.
- Tsimikizirani kuti dzina la mutu ndi X-API-Key kapena Authorization.
- Ngati mukugwiritsa ntchito mutu wa Authorization pa njira yogwirizana ndi OpenAI, tsimikizirani kuti ili ndi choyambirira cha Bearer.
Mukakonza, bwerezaninso kuwerenga mndandanda wa ma model mu gawo la kutsimikizira ndikutsimikizira kuti mukulandira 200.
Mitu yogwiritsidwa ntchito limodzi
Mitu yonse yotsatirayi ndi yosankha. Tikulimbikitsa kuti muyike X-Request-Id kuti zithandize kutsatira mavuto.
| Mutu | Ntchito yake | Ngati wasiyidwa |
|---|---|---|
| X-Request-Id | Ichi ndi chizindikiritso chotsatira pempho. Njira yogwirizana ndi Anthropic imabwezeranso mtengo womwewo mu mutu wa request-id wa yankho. | Imaperekedwa ndi seva. |
| X-Region-Code | Imatchula dera lomwe pempholo liyenera kupita. | Ndi global. |
| X-Product-Sku (쿼리 product_sku로도 지정 가능) | Imatchula mwachindunji Product SKU yomwe igwiritsidwe ntchito polipiritsa. Mutuwu umakhala patsogolo kuposa query, ndipo umagwiritsidwa ntchito makamaka m'njira za mawu ndi voice. | Sichingasiyidwe m'njira za voice. audio/speech ndi audio/transcriptions zimasankha Product pogwiritsa ntchito model yomwe ili m'thupi la pempho. |
| anthropic-version / anthropic-beta | Imadutsa momwe ilili mu njira yogwirizana ndi Anthropic. | Mtunduwu ndi 2023-06-01. |
Ngati 5xx zibwerezabwereza, tiuzeni kudzera pa Thandizo ndi Lumikizanani nafe pamodzi ndi X-Request-Id. Ngati ndi mtengo womwe munatchula mwachindunji, tingauyerekezere nthawi yomweyo ndi zolemba za kasitomala.