Otantifye avèk yon kle API

Pòtay CLEVI a otantifye wout ki konpatib ak OpenAI ak wout ki konpatib ak Anthropic avèk yon sèl kle API.
Gen de valè pou konfigire sou kliyan an: antèt otantifikasyon ki gen kle a ak base URL SDK a. Fòma antèt ak base URL ki akseptab yo diferan selon spesifikasyon an.
Apre konfigirasyon an fini, ou ka verifye otantifikasyon an imedyatman lè ou chèche lis modèl yo.
Si otantifikasyon an echwe, li retounen 401; si otantifikasyon an reyisi men kondisyon otorizasyon oswa limit yo pa satisfè, li retounen 403.

Jwenn kle API a sou ekran kle API a nan konsole a. Sou menm ekran an, ou ka jere anilasyon kle a ak dimansyon itilizasyon li.

Antèt otantifikasyon

Tou de spesifikasyon yo mete kle API a nan yon sèl antèt demann. Sèvi ak swa antèt X-API-Key la oswa antèt Authorization la; fòma ki akseptab la depann de spesifikasyon an.

Lè w ap itilize antèt Authorization nan wout ki konpatib ak OpenAI a, prefiks Bearer la obligatwa. Si ou voye sèlman kle a san prefiks la, pòtay la ap rejte demann lan.

Non antèt yo pa sansib a majiskil ak miniskil, kidonk antèt x-api-key Anthropic SDK voye a fonksyone jan li ye a. Si ou presize tou de antèt yo, valè X-API-Key la ap aplike an premye.

base URL

SDK ou te konn itilize deja yo ka kontinye fonksyone si ou chanje sèlman base URL la pou adrès ki anba a. De adrès yo diferan selon si yo gen /v1 ladan yo oswa non; presize adrès ki koresponn ak spesifikasyon an jan li ye a.

Verifye otantifikasyon an

Apre ou fin konfigire kle a ak URL baz la, ou ka verifye otantifikasyon an lè ou konsilte lis modèl yo. Egzanp ki anba a egzekite menm demann lan avèk curl, OpenAI SDK ak Anthropic SDK. Mete kle ou te bay sou ekran kle API a nan plas sk-....

Lè w ap konsilte lis la avèk curl, presize chemen konplè a jiska /v1/models pou toude espesifikasyon yo. Premye kòmand lan sèvi ak antèt X-API-Key sou chemen konpatib ak OpenAI a, epi dezyèm kòmand lan sèvi ak antèt Authorization sou chemen konpatib ak Anthropic la.

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 mande pou ou presize yon adrès ki gen /v1 ladan l nan 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 mande pou ou presize yon adrès nan base_url ki fini anvan /v1.
Pou otantifikasyon, sèvi dirèkteman ak antèt x-api-key SDK a voye a.

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)

Pou nenpòt nan egzanp yo, si repons lan se 200, sa vle di otantifikasyon an reyisi; data repons lan gen lis modèl ou ka rele avèk kle sa a. Si repons lan se 401, verifye kòz la nan lòd ki nan seksyon ki vin apre a.

Echèk otantifikasyon

Si ou voye yon kle ki pa egziste, ki ekspire oswa ki revoke, yo retounen 401. Si ou fè yon apèl sou chemen konpatib ak OpenAI a san kle, yo retounen kò sa a; sou chemen konpatib ak Anthropic la, error.type se authentication_error.

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

Si ou resevwa 401, verifye bagay sa yo nan lòd sa a.

1. Verifye estati kle a sou ekran kle API a. Si kle a ekspire oswa li revoke, bay yon nouvo kle.
2. Verifye si non antèt la se X-API-Key oswa Authorization.
3. Si w ap itilize antèt Authorization sou chemen konpatib ak OpenAI a, verifye si li gen prefiks Bearer la.

Apre ou fin fè koreksyon yo, egzekite ankò demann lis modèl ki nan seksyon Verifikasyon otantifikasyon an pou verifye si ou resevwa 200.

Antèt pou itilize ansanm

Tout antèt ki annapre yo opsyonèl. Nou rekòmande pou ou toujou presize X-Request-Id pou fasilite swivi pwoblèm yo.

Si 5xx yo repete, tanpri fè nou konnen sa nan èd la ak nan demann lan, ansanm ak X-Request-Id. Si se yon valè ou te presize dirèkteman, ou ka konpare li imedyatman ak anrejistreman kliyan an.