Bi mifteya API-ê xwe nas bikin

Dergehê CLEVI rêyên lihevhatî bi OpenAI û rêyên lihevhatî bi Anthropic bi tenê mifteyek API-ê nas dike.
Di xerîdar de du nirx hene ku divê werin saz kirin: sernavê nasnameyê ku mifte tê de tê danîn û base URL-a SDK-ê; şêwazên sernavê û base URL-ên destûrdar li gorî standardê cuda ne.
Piştî ku sazkirin qediya, lîsteya modelan bixwînin da ku hûn bikarin yekser piştrast bikin ka nasname hatiye pejirandin an na.
Ger nasname bi ser nekeve, 401 vedigere; ger nasname were pejirandin lê mercên destûrê an sînorê nehatin bicîh anîn, 403 vedigere.

Mifteya API-ê ji rûpela mifteyên API-ê ya konsolê bistînin. Di heman rûpelê de hûn dikarin betal kirin û qada bikaranîna mifteyê birêve bibin.

Sernavê nasnameyê

Di her du standardan de jî mifteya API-ê di yek sernavê daxwazê de tê danîn. Yek ji sernavên X-API-Key an Authorization tê bikaranîn, û forma destûrdar li gorî standardê cuda ye.

Dema ku di rêya lihevhatî bi OpenAI de sernavê Authorization tê bikaranîn, pêşgira Bearer pêwîst e. Ger tenê mifte bêyî pêşgirê were şandin, dergeh daxwazê red dike.

Navên sernavan ji hêla mezin û biçûk-bûna tîpan ve ne cudahî ne, ji ber vê yekê sernavê x-api-key ku Anthropic SDK dişîne jî rasterast dixebite. Ger her du sernav bêne destnîşankirin, nirxa X-API-Key dê pêşî were sepandin.

base URL

SDK-ya ku berê bikar dianîn hûn dikarin bi tenê guherandina base URL-ê bi navnîşana jêrîn berdewam bikin. Ji ber ku her du navnîşan dihewînin an na /v1 cuda ne, navnîşana li gorî standardê rasterast destnîşan bikin.

Piştrastkirina nasnameyê

Piştî ku mifte û URL-ya bingehîn saz bikin û navnîşa modelan bixwînin, hûn dikarin kontrol bikin ka autentîkasyon pêk hatiye an na. Mînaka jêrîn heman xwendinê bi curl, OpenAI SDK û Anthropic SDK pêk tîne. Li şûna sk-... mifteya ku di rûpela API key de hatiye çêkirin binivîsin.

Dema bi curl dixwînin, ji bo her du standardan rêça tevahî heta /v1/models diyar bikin. Fermana yekem di rêça lihevhatî bi OpenAI de sernavê X-API-Key, û fermana duyem di rêça lihevhatî bi Anthropic de sernavê Authorization bi kar tîne.

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 li base_url navnîşana ku /v1 dihewîne diyar dike.

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 base_url li navnîşana ku berî /v1 bi dawî dibe diyar dike.
Ji bo autentîkasyonê sernavê x-api-key ku SDK dişîne bê guhertin bi kar bînin.

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)

Di her mînakê de, heke bersiv 200 be, autentîkasyon serkeftî ye û di data ya bersivê de navnîşa modelên ku hûn dikarin bi vê miftê bang bikin heye. Heke 401 be, sedemê li gorî rêza beşa paşîn kontrol bikin.

Autentîkasyon biserneket

Heke mifte tune be an mifteyek derbasbûyî yan betalokirî bişînin, 401 vedigere. Heke di rêça lihevhatî bi OpenAI de bê mifte bang bikin, nivîsa jêrîn vedigere; di rêça lihevhatî bi Anthropic de, error.type authentication_error e.

{
  "error": {
    "message": "API key is required.",
    "type": "invalid_request_error"
  }
}

Heke 401 bistînin, bi rêza jêrîn kontrol bikin.

1. Rewşa miftê di rûpela API key de kontrol bikin. Heke ew derbasbûyî yan betalokirî ye, mifteyek nû derxin.
2. Kontrol bikin ka navê sernavê X-API-Key an Authorization e.
3. Heke di rêça lihevhatî bi OpenAI de sernavê Authorization bi kar tînin, kontrol bikin ka pêşgira Bearer heye.

Piştî sererastkirinê, xwendina navnîşa modelan di beşa kontrolkirina autentîkasyonê de ji nû ve bimeşînin û piştrast bikin ka 200 tê.

Sernavên hevpar

Hemû sernavên jêrîn bijartî ne. Ji bo şopandina pirsgirêkan, em pêşniyar dikin ku X-Request-Id diyar bikin.

Heke 5xx dubare bibin, ji kerema xwe bi alîkarî û pirsê re, X-Request-Id jî tê de, agahdar bikin. Heke nirxê bi destê we hatiye diyarkirin, hûn dikarin wê rasterast bi tomarên clientê re bidin berhev.