Developer guide
Fíordheimhniú le heochair API
An ceanntásc ina gcuirtear an eochair API agus an base URL le socrú in SDK
Clúdaíonn an leathanach seo an chaoi le fíordheimhniú a dhéanamh ar gheata CLEVI le heochair API.
Úsáideann na cosáin atá comhoiriúnach le OpenAI agus Anthropic eochair amháin le haghaidh fíordheimhnithe,
ach tá raonta ceadaithe an cheanntáisc ina gcuirtear an eochair agus an base URL le socrú in SDK difriúil de réir na sonraíochta.
Ceanntásc fíordheimhnithe
Úsáideann an dá shonraíocht chomhoiriúnach eochair API amháin le haghaidh fíordheimhnithe. Eisítear an eochair ar an scáileán eochracha API sa chonsól, agus bainistítear a cúlghairm agus a raon úsáide ar an scáileán céanna.
| Ceanntásc | Comhoiriúnach le OpenAI | Comhoiriúnach le Anthropic |
|---|---|---|
| X-API-Key: <키> | Ceadaithe | Ceadaithe |
| Authorization: Bearer <키> | Ceadaithe | Ceadaithe |
| Authorization: <키> (gan Bearer) | Diúltaithe | Ceadaithe |
Níl ainmneacha na gceanntáscanna íogair do chás na litreacha. Oibríonn x-api-key a sheolann Anthropic SDK mar atá sé freisin.
base URL
Ní gá ach an base URL a athrú go dtí an seoladh thíos chun leanúint ar aghaidh ag úsáid an SDK a bhí in úsáid agat. Is é an difríocht idir an dá sheoladh ná an gcuirtear /v1 san áireamh nó nach gcuirtear.
| Sonraíocht | base URL | Riail an chosáin |
|---|---|---|
| Comhoiriúnach le OpenAI | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Cuirtear suas go dtí /v1 san áireamh sa base URL. |
| Comhoiriúnach le Anthropic | https://platform.clevi.net/api/v2/aiservice/anthropic | Cuireann Anthropic SDK /v1 leis an gcosán leis féin, mar sin críochnaíonn sé roimh /v1. |
Fíordheimhniú a dhearbhú
Is féidir leat a fháil amach láithreach an bhfuil fíordheimhniú déanta trí eochair agus base URL a chur isteach agus liosta na múnlaí a cheistiú. Déanann na trí shampla thíos an cheist chéanna le curl, OpenAI SDK agus 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)Cuir an eochair a eisíodh ar an scáileán eochracha API in ionad sk-....
- Má tá an freagra 200, tá fíordheimhniú déanta. Tá liosta na múnlaí is féidir a ghlaoch leis an eochair seo in data.
- Má tá an freagra 401, seiceáil é san ord atá sa rannán maidir le teip fíordheimhnithe thíos.
Ceanntásc a úsáidtear le chéile
Tá siad go léir roghnach. Chun fadhbanna a rianú, moltar X-Request-Id a chur san áireamh.
| Ceanntásc | Úsáid | Mura bhfágtar ar lár é |
|---|---|---|
| X-Request-Id | Aitheantóir chun iarratais a rianú. I bhfreagraí atá comhoiriúnach le Anthropic, seoltar ar ais é mar cheanntásc request-id. | Eisíonn an freastalaí é. |
| X-Region-Code | Réigiún an ghlao | Is é global é. |
| X-Product-Sku (ar fáil freisin mar product_sku sa cheist) | Sonraíonn sé go díreach an Product SKU atá le húsáid le haghaidh billeála. Tá tosaíocht ag an gceanntásc ar an gceist agus úsáidtear é go príomha i mbealaí fuaime agus gutha. | Tá sé riachtanach i mbealaí gutha. Roghnaíonn audio/speech agus audio/transcriptions an Product leis an model sa chorp. |
| anthropic-version / anthropic-beta | Cuirtear ar aghaidh mar atá i mbealaí atá comhoiriúnach le Anthropic. | Is é 2023-06-01 an leagan. |
Teip fíordheimhnithe
Má sheoltar eochair atá in easnamh, imithe in éag nó cúlghairthe, faightear 401. Má dhéantar glao gan eochair i mbealach atá comhoiriúnach le OpenAI, faightear an corp thíos; i mbealach atá comhoiriúnach le Anthropic, is é authentication_error an error.type.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Seiceáil stádas na heochrach ar scáileán eochracha API. Má tá sí imithe in éag nó cúlghairthe, eisigh ceann nua.
- Seiceáil an é X-API-Key nó Authorization ainm an cheanntáisc.
- Má úsáideann tú Authorization i mbealach atá comhoiriúnach le OpenAI, seiceáil an réimír Bearer.