Kuthibitisha kwa kutumia ufunguo wa API

Lango la CLEVI huthibitisha njia zinazooana na OpenAI na njia zinazooana na Anthropic kwa kutumia ufunguo mmoja wa API.
Thamani mbili za kusanidi kwenye mteja ni kichwa cha uthibitishaji kilicho na ufunguo na base URL ya SDK, na miundo ya vichwa inayoruhusiwa pamoja na base URL hutofautiana kulingana na kiwango.
Baada ya kukamilisha usanidi, unaweza kuthibitisha mara moja ikiwa uthibitishaji umefaulu kwa kupata orodha ya miundo.
Uthibitishaji ukishindikana, 401 itarejeshwa; baada ya uthibitishaji kufaulu, ikiwa masharti ya ruhusa au kikomo hayajatimizwa, 403 itarejeshwa.

Toa ufunguo wa API kwenye skrini ya funguo za API katika kiweko. Kwenye skrini hiyo hiyo unaweza kudhibiti kubatilisha ufunguo na wigo wa matumizi yake.

Kichwa cha uthibitishaji

Miundo yote miwili huweka ufunguo wa API katika kichwa kimoja cha ombi. Tumia mojawapo ya kichwa cha X-API-Key au Authorization, na muundo unaoruhusiwa hutofautiana kulingana na kiwango.

Unapotumia kichwa cha Authorization katika njia inayooana na OpenAI, kiambishi awali cha Bearer kinahitajika. Ukituma ufunguo pekee bila kiambishi awali, lango litakataa ombi.

Majina ya vichwa hayazingatii tofauti ya herufi kubwa na ndogo, kwa hivyo kichwa cha x-api-key kinachotumwa na Anthropic SDK pia hufanya kazi bila mabadiliko. Ukibainisha vichwa vyote viwili, thamani ya X-API-Key itapewa kipaumbele.

base URL

SDK uliyokuwa ukitumia hapo awali inaweza kuendelea kutumika kwa kubadilisha tu base URL kuwa anwani iliyo hapa chini. Anwani hizi mbili hutofautiana kwa kujumuisha au kutokujumuisha /v1, kwa hivyo bainisha anwani inayolingana na kiwango bila mabadiliko.

Kuthibitisha uthibitishaji

Baada ya kuweka ufunguo na base URL, unaweza kuthibitisha ikiwa uidhinishaji umefaulu kwa kupata orodha ya miundo. Mfano ulio hapa chini unaendesha ombi hilo kwa curl, OpenAI SDK na Anthropic SDK. Weka ufunguo uliotolewa kwenye skrini ya API key mahali pa sk-....

Unapotumia curl kupata orodha, bainisha njia kamili hadi /v1/models kwa viwango vyote viwili. Amri ya kwanza hutumia kichwa cha X-API-Key kwa njia inayooana na OpenAI, na amri ya pili hutumia kichwa cha Authorization kwa njia inayooana na 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 hubainisha anwani inayojumuisha /v1 katika 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 hubainisha base_url yenye kuishia kabla ya /v1.
Kwa uidhinishaji, tumia kichwa cha x-api-key kinachotumwa na SDK bila kukibadilisha.

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)

Ikiwa jibu la mfano wowote ni 200, uidhinishaji umefaulu, na data ya jibu ina orodha ya miundo inayoweza kuitwa kwa ufunguo huu. Ikiwa ni 401, chunguza sababu kwa kufuata mpangilio katika sehemu inayofuata.

Uidhinishaji umeshindwa

Ukituma ufunguo ambao haupo, umeisha muda wake au umebatilishwa, 401 itarejeshwa. Ukiita njia inayooana na OpenAI bila ufunguo, mwili ulio hapa chini utarejeshwa, na katika njia inayooana na Anthropic, error.type ni authentication_error.

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

Ukipokea 401, thibitisha kwa kufuata mpangilio ufuatao.

1. Thibitisha hali ya ufunguo kwenye skrini ya API key. Ikiwa umeisha muda wake au umebatilishwa, toa mpya.
2. Thibitisha kuwa jina la kichwa ni X-API-Key au Authorization.
3. Ikiwa unatumia kichwa cha Authorization katika njia inayooana na OpenAI, thibitisha kuwa kina kiambishi awali cha Bearer.

Baada ya kufanya marekebisho, endesha tena ombi la kupata orodha ya miundo katika sehemu ya kuthibitisha uidhinishaji na uthibitishe kuwa unapata 200.

Vichwa vinavyotumiwa pamoja

Vichwa vifuatavyo vyote ni vya hiari. Tunapendekeza uweke X-Request-Id ili kurahisisha ufuatiliaji wa matatizo.

Ikiwa 5xx inajirudia, tujulishe kupitia sehemu ya msaada na mawasiliano, pamoja na X-Request-Id. Ikiwa ni thamani uliyobainisha mwenyewe, unaweza kuilinganisha moja kwa moja na rekodi za mteja.