Developer guide
Todentaminen API-avaimella
API-avaimen sisältävät otsakkeet ja SDK:ssa määritettävä base URL
Tällä sivulla käsitellään todentamista CLEVI-yhdyskäytävään API-avaimella.
Sekä OpenAI-yhteensopiva että Anthropic-yhteensopiva reitti todennetaan yhdellä avaimella,
mutta avaimen sisältävien otsakkeiden hyväksytty laajuus ja SDK:ssa määritettävä base URL vaihtelevat määrityksen mukaan.
Todennusotsake
Molemmissa yhteensopivissa määrityksissä käytetään todentamiseen yhtä API-avainta. Avain myönnetään konsolin API-avaimet-näkymässä, jossa hallitaan myös sen mitätöintiä ja käyttörajoja.
| Otsake | OpenAI-yhteensopiva | Anthropic-yhteensopiva |
|---|---|---|
| X-API-Key: <키> | Hyväksytty | Hyväksytty |
| Authorization: Bearer <키> | Hyväksytty | Hyväksytty |
| Authorization: <키> (ilman Bearer-etuliitettä) | Hylätty | Hyväksytty |
Otsakkeiden nimissä kirjainkoolla ei ole merkitystä. Myös Anthropic SDK:n lähettämä x-api-key toimii sellaisenaan.
base URL
Käyttämäsi SDK toimii sellaisenaan, kun vaihdat vain base URL:n alla olevaan osoitteeseen. Osoitteet eroavat siinä, sisältävätkö ne /v1-polun.
| Määritys | base URL | Polkusääntö |
|---|---|---|
| OpenAI-yhteensopiva | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Sisällytä /v1 base URL:ään asti. |
| Anthropic-yhteensopiva | https://platform.clevi.net/api/v2/aiservice/anthropic | Anthropic SDK lisää /v1:n itse polkuun, joten URL päättyy ennen /v1:tä. |
Todennuksen tarkistaminen
Kun lisäät avaimen ja base URL:n ja haet malliluettelon, voit tarkistaa heti, onnistuiko todentaminen. Alla sama haku tehdään curlilla, OpenAI SDK:lla ja Anthropic SDK:lla.
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"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)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)Korvaa sk-... API-avaimet-näkymässä myönnetyllä avaimella.
- Jos vastaus on 200, todentaminen onnistui. data sisältää luettelon malleista, joita tällä avaimella voi kutsua.
- Jos vastaus on 401, tarkista asiat alla olevan Todennus epäonnistui -osion järjestyksessä.
Yhdessä käytettävät otsakkeet
Kaikki ovat valinnaisia. X-Request-Id kannattaa lisätä, jotta ongelmia voidaan jäljittää.
| Otsikko | Käyttötarkoitus | Jos jätetään pois |
|---|---|---|
| X-Request-Id | Pyyntöjen jäljitykseen käytettävä tunniste. Anthropic-yhteensopivissa vastauksissa se palautetaan request-id-otsikkona. | Palvelin myöntää sen. |
| X-Region-Code | Kutsun alue | global. |
| X-Product-Sku (voidaan antaa myös kyselyparametrina product_sku) | Määrittää suoraan laskutuksessa käytettävän Product SKU:n. Otsikko ohittaa kyselyparametrin, ja sitä käytetään pääasiassa ääni- ja voice-reiteillä. | Tarvitaan voice-reiteillä. audio/speech- ja audio/transcriptions-reiteillä Product valitaan rungon model-kentällä. |
| anthropic-version / anthropic-beta | Välitetään sellaisenaan Anthropic-yhteensopivalla reitillä. | Versio on 2023-06-01. |
Todennus epäonnistui
Jos avainta ei ole tai lähetät vanhentuneen tai mitätöidyn avaimen, tuloksena on 401. Jos OpenAI-yhteensopivalla reitillä kutsu tehdään ilman avainta, palautetaan alla oleva runko, ja Anthropic-yhteensopivan reitin error.type on authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Tarkista avaimen tila API-avainten näkymässä. Jos avain on vanhentunut tai mitätöity, luo uusi.
- Tarkista, onko otsikon nimi X-API-Key vai Authorization.
- Jos käytät Authorization-otsikkoa OpenAI-yhteensopivalla reitillä, tarkista Bearer-etuliite.