Developer guide
Go netefatša ka senotlelo sa API
Hlogo yeo e tsenyago senotlelo sa API le base URL yeo e tlago go beakanywa go SDK
Kgoro ya CLEVI e netefatša ditsela tšeo di sepelelanago le OpenAI le ditsela tšeo di sepelelanago le Anthropic ka senotlelo se tee sa API.
Ditekanyetšo tše pedi tšeo di swanetšego go beakanywa go moreki ke hlogo ya netefatšo yeo e swerego senotlelo le base URL ya SDK, gomme sebopego sa hlogo le base URL tšeo di dumeletšwego di fapana go ya ka maemo.
Ka morago ga go fetša peakanyo, o ka lekola ka pela ge e ba netefatšo e šomile ka go nyaka lenaneo la dimodeli.
Ge netefatšo e palelwa, go bušetšwa 401; ge netefatšo e atlegile eupša maemo a tumelelo goba a tekanyetšo a sa fihlelelwe, go bušetšwa 403.
Hwetša senotlelo sa API go skrine ya dinotlelo tša API ka khonsoleng. Skrineng sona seo o ka laola go phumola senotlelo le tekanyo ya tšhomišo ya sona.
Hlogo ya netefatšo
Maemo ka bobedi a tsenya senotlelo sa API go hlogo e tee ya kgopelo. Šomiša e tee ya dihlogo tša X-API-Key le Authorization, gomme sebopego se se dumeletšwego se fapana go ya ka maemo.
| Hlogo | E sepelelanago le OpenAI | E sepelelanago le Anthropic |
|---|---|---|
| X-API-Key: <senotlelo> | E a dumelelwa | E a dumelelwa |
| Authorization: Bearer <senotlelo> | E a dumelelwa | E a dumelelwa |
| Authorization: <senotlelo> (ntle le Bearer) | E a ganwa | E a dumelelwa |
Ge o šomiša hlogo ya Authorization tseleng yeo e sepelelanago le OpenAI, hlogo ya Bearer e a nyakega. Ge o romela senotlelo se nnoši ntle le hlogo ye, kgoro e tla gana kgopelo.
Maina a dihlogo ga a šetše phapano magareng ga ditlhaka tše dikgolo le tše nnyane, ka gona hlogo ya x-api-key yeo e romelwago ke Anthropic SDK le yona e šoma ka mokgwa wo e lego ka gona. Ge o laetša dihlogo ka bobedi, boleng bja X-API-Key bo dirišwa pele.
base URL
SDK yeo o bego o e šomiša pele o ka tšwela pele go e šomiša ka go fetoša base URL feela go aterese ye e lego ka mo tlase. Diaterese tše pedi di fapana ka gore di akaretša /v1 goba ga di e akaretše, ka gona laetša aterese ye e swanetšego maemo ka mokgwa wo e lego ka gona.
| Maemo | base URL | Molao wa tsela |
|---|---|---|
| E sepelelanago le OpenAI | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Akaretša go fihla go /v1 go base URL. |
| E sepelelanago le Anthropic | https://platform.clevi.net/api/v2/aiservice/anthropic | Ka ge Anthropic SDK e oketša /v1 ka boyona tseleng ya kgopelo, e felela pele ga /v1. |
Netefatša netefatšo
Ka morago ga go beakanya senotlelo le base URL, o ka netefatša ge e ba o netefaditšwe ka go hwetša lenaneo la dimotlolo. Mohlala wa ka mo tlase o dira kgopelo yeo ka curl, OpenAI SDK le Anthropic SDK. Mo lefelong la sk-... tsenya senotlelo seo se filwego leqepheng la dinotlelo tša API.
Ge o dira kgopelo ka curl, laetša tsela ka botlalo go fihla go /v1/models go ditlhalošo ka bobedi. Taelo ya mathomo e diriša hlogo ya X-API-Key tseleng yeo e dumelelanago le OpenAI, gomme taelo ya bobedi e diriša hlogo ya Authorization tseleng yeo e dumelelanago le 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"OpenAI SDK e laetša aterese yeo e akaretšago /v1 go 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)Anthropic SDK e laetša base_url ka aterese yeo e felelago pele ga /v1.
Bakeng sa netefatšo, diriša hlogo ya x-api-key yeo SDK e e romelago ka tsela yeo e lego ka yona.
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)Ge karabo e le 200 mohlaleng ofe goba ofe, netefatšo e atlegile, gomme data ya karabo e na le lenaneo la dimotlolo tšeo di ka bitšwago ka senotlelo se. Ge e le 401, hlahloba sebaki ka tatelano yeo e lego karolong ye e latelago.
Netefatšo e paletšwe
Ge o romela senotlelo se se lego gona goba se feletšwe ke nako/gafetšwe, go bušetšwa 401. Ge o dira kgopelo ntle le senotlelo tseleng yeo e dumelelanago le OpenAI, mmele wo o lego ka mo tlase o a bušetšwa, mola tseleng yeo e dumelelanago le Anthropic error.type e lego authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}Ge o amogela 401, hlahloba ka tatelano ye e latelago.
- Lekola boemo bja senotlelo leqepheng la dinotlelo tša API. Ge senotlelo se feletšwe ke nako goba se gafilwe, hwetša se sefsa.
- Netefatša ge e ba leina la hlogo e le X-API-Key goba Authorization.
- Ge o diriša hlogo ya Authorization tseleng yeo e dumelelanago le OpenAI, netefatša ge e ba e na le sehlongwapele sa Bearer.
Ka morago ga go lokiša, dira gape kgopelo ya lenaneo la dimotlolo karolong ya netefatšo gomme netefatša ge e ba o amogela 200.
Dihlogo tše di dirišwago mmogo
Dihlogo tše di latelago ka moka ke tša boikgethelo. Re kgothaletša gore o beakanye X-Request-Id gore go kgonege go latišiša mathata.
| Hlogo | Tirišo | Ge e tlogetšwe |
|---|---|---|
| X-Request-Id | Ke sekgetholli sa go latela kgopelo. Tselana yeo e sepelelanago le Anthropic e bušetša boleng bjo bo swanago ka hlogong ya request-id ya karabo. | Se fiwa ke seabi. |
| X-Region-Code | E laetša tikologo ya kgopelo. | Ke global. |
| X-Product-Sku (e ka laetšwa gape ka product_sku ya query) | E laetša ka go lebanya Product SKU yeo e tlago dirišetšwa tefišo. Hlogo e tla pele ga query, gomme e dirišwa kudu ditseleng tša lentšu le voice. | Ga se ya swanela go tlogelwa ditseleng tša voice. audio/speech le audio/transcriptions di kgetha Product ka model ya mmele wa kgopelo. |
| anthropic-version / anthropic-beta | Di fetišetšwa di sa fetolwa tseleng yeo e sepelelanago le Anthropic. | Phetolelo ke 2023-06-01. |
Ge 5xx e tšwela pele go ipoeletša, re tsebiše ka thušo le dikgopelo, o akaretše X-Request-Id. Ge o laeditše boleng ka go lebanya, bo ka bapetšwa ka pela le direkoto tša moreki.
