Autentimine API-võtmega

CLEVI värav autentib OpenAI-ga ühilduva tee ja Anthropicuga ühilduva tee ühe API-võtmega.
Kliendis tuleb seadistada kaks väärtust: autentimispäis, mis sisaldab võtit, ja SDK base URL. Lubatud päise vorming ja base URL erinevad spetsifikatsiooni järgi.
Pärast seadistamise lõpetamist saate autentimise kohe kontrollida, pärides mudelite loendi.
Kui autentimine ebaõnnestub, tagastatakse 401; kui pärast autentimise läbimist ei ole õiguste või limiidi tingimused täidetud, tagastatakse 403.

Väljastage API-võti konsooli API-võtmete lehel. Samal lehel saate hallata võtme tühistamist ja kasutusulatust.

Autentimispäis

Mõlemad spetsifikatsioonid sisaldavad API-võtit ühes päringu päises. Kasutada saab kas X-API-Key päist või Authorization päist ning lubatud vorming sõltub spetsifikatsioonist.

OpenAI-ga ühilduval teel on Authorization päise kasutamisel vajalik Bearer-prefiks. Kui saadate ainult võtme ilma prefiksita, lükkab värav päringu tagasi.

Päise nimed ei ole tõstutundlikud, seega töötab ka Anthropic SDK saadetav x-api-key päis muutmata kujul. Kui määrate mõlemad päised, rakendatakse esmalt X-API-Key väärtust.

base URL

Varem kasutatud SDK-d saate endiselt kasutada, muutes ainult base URL-i allolevaks aadressiks. Need kaks aadressi erinevad selle poolest, kas need sisaldavad /v1, seega määrake spetsifikatsioonile vastav aadress muutmata kujul.

Autentimise kontroll

Pärast võtme ja base URL-i seadistamist saate autentimise õnnestumist kontrollida mudelite loendi päringu abil. Allolevates näidetes tehakse sama päringut curl-i, OpenAI SDK ja Anthropic SDK abil. Asendage sk-... API-võtme lehel väljastatud võtmega.

curl-iga päringu tegemisel määrake mõlema spetsifikatsiooni puhul täielik tee kuni /v1/models. Esimene käsk kasutab OpenAI-ühilduva tee puhul päist X-API-Key, teine käsk aga Anthropic-ühilduva tee puhul päist Authorization.

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 puhul määrake base_url-i aadress, mis sisaldab ka /v1.

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 puhul määrake base_url-i aadress, mis lõpeb enne /v1.
Autentimiseks kasutage SDK saadetavat päist x-api-key muutmata kujul.

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)

Kui vastus on ükskõik millise näite puhul 200, on autentimine õnnestunud ning vastuse data sisaldab selle võtmega kutsutavate mudelite loendit. Kui vastus on 401, kontrollige põhjust järgmises jaotises kirjeldatud järjekorras.

Autentimise ebaõnnestumine

Kui saadate puuduva, aegunud või tühistatud võtme, tagastatakse 401. Kui OpenAI-ühilduval teel tehakse päring ilma võtmeta, tagastatakse allolev sisu; Anthropic-ühilduval teel on error.type väärtus authentication_error.

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

Kui saate vastuse 401, kontrollige järgmist.

1. Kontrollige võtme olekut API-võtme lehel. Kui võti on aegunud või tühistatud, väljastage uus võti.
2. Kontrollige, kas päise nimi on X-API-Key või Authorization.
3. Kui kasutate OpenAI-ühilduval teel päist Authorization, kontrollige, kas sellel on eesliide Bearer.

Pärast paranduste tegemist käivitage autentimise kontrollimise jaotises olev mudelite loendi päring uuesti ning kontrollige, kas vastuseks saadakse 200.

Ühiselt kasutatavad päised

Kõik järgmised päised on valikulised. Soovitame määrata X-Request-Id, et probleeme oleks võimalik jälgida.

Kui 5xx-tõrked korduvad, andke sellest abikeskuse ja kontaktivormi kaudu koos X-Request-Id-ga teada. Kui väärtus määrati otse, saab seda kohe kliendi logidega võrrelda.