Todennus API-avaimella

CLEVI-yhdyskäytävä todentaa OpenAI-yhteensopivan reitin ja Anthropic-yhteensopivan reitin yhdellä API-avaimella.
Asiakkaassa määritettävät arvot ovat avaimen sisältävä todennusotsake ja SDK:n base URL. Sallitut otsakemuodot ja base URL -osoitteet vaihtelevat määrityksen mukaan.
Kun määritykset on tehty, voit tarkistaa todennuksen heti hakemalla malliluettelon.
Jos todennus epäonnistuu, palautetaan 401. Jos todennus onnistuu, mutta käyttöoikeudet tai käyttörajoitukset eivät täyty, palautetaan 403.

Luo API-avain konsolin API-avaimet-näkymässä. Samassa näkymässä voit hallita avaimen käytöstä poistamista ja käyttöaluetta.

Todennusotsake

Molemmat määritykset sisältävät API-avaimen yhdessä pyyntöotsakkeessa. Käytä joko X-API-Key-otsaketta tai Authorization-otsaketta; sallittu muoto vaihtelee määrityksen mukaan.

Kun Authorization-otsaketta käytetään OpenAI-yhteensopivalla reitillä, Bearer-etuliite on pakollinen. Jos lähetät pelkän avaimen ilman etuliitettä, yhdyskäytävä hylkää pyynnön.

Otsakkeiden nimissä kirjainkoolla ei ole merkitystä, joten myös Anthropic SDK:n lähettämä x-api-key-otsake toimii sellaisenaan. Jos määrität molemmat otsakkeet, X-API-Key-arvoa käytetään ensisijaisesti.

base URL

Aiemmin käyttämäsi SDK toimii sellaisenaan, kun vaihdat vain base URL -osoitteeksi alla olevan osoitteen. Osoitteet eroavat siinä, sisältävätkö ne /v1-polun, joten määritä määrityksen mukainen osoite sellaisenaan.

Todennuksen tarkistaminen

Kun olet määrittänyt avaimen ja base URL:n ja hakenut malliluettelon, voit varmistaa, onko todennus onnistunut. Alla olevissa esimerkeissä sama haku suoritetaan curlilla, OpenAI SDK:lla ja Anthropic SDK:lla. Korvaa sk-... API-avainten sivulla luodulla avaimella.

Kun teet haun curlilla, määritä molemmissa määrityksissä koko polku /v1/models asti. Ensimmäinen komento käyttää OpenAI-yhteensopivassa polussa X-API-Key-otsaketta, ja toinen komento Anthropic-yhteensopivassa polussa Authorization-otsaketta.

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:ssa määritä base_url-osoite niin, että se sisältää myös /v1-osan.

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:ssa määritä base_url-osoite päättymään ennen /v1-osaa.
Käytä todennukseen sellaisenaan x-api-key-otsaketta, jonka SDK lähettää.

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)

Jos vastaus on missä tahansa esimerkissä 200, todennus onnistui, ja vastauksen data sisältää luettelon malleista, joita voidaan kutsua tällä avaimella. Jos vastaus on 401, tarkista syy seuraavan osion ohjeiden mukaisesti.

Todennus epäonnistui

Jos lähetät avaimen, jota ei ole olemassa tai joka on vanhentunut tai peruutettu, palautetaan 401. Jos OpenAI-yhteensopivassa polussa kutsutaan ilman avainta, palautetaan alla oleva runko, kun taas Anthropic-yhteensopivassa polussa error.type on authentication_error.

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

Jos saat vastauksen 401, tarkista seuraavat asiat tässä järjestyksessä.

1. Tarkista avaimen tila API-avainten sivulta. Jos avain on vanhentunut tai peruutettu, luo uusi.
2. Tarkista, että otsakkeen nimi on X-API-Key tai Authorization.
3. Jos käytät Authorization-otsaketta OpenAI-yhteensopivassa polussa, tarkista, että siinä on Bearer-etuliite.

Tee muutosten jälkeen Todennuksen varmistaminen -osion malliluettelon haku uudelleen ja varmista, että saat vastauksen 200.

Yhteisesti käytettävät otsakkeet

Kaikki seuraavat otsakkeet ovat valinnaisia. Suosittelemme määrittämään X-Request-Id:n, jotta ongelmia voidaan jäljittää.

Jos 5xx-virheet toistuvat, ilmoittakaa asiasta ohjeiden ja yhteydenottokanavan kautta sekä toimittakaa X-Request-Id. Jos arvo on määritetty suoraan, sen voi täsmäyttää välittömästi asiakkaan lokien kanssa.