Developer guide
Hitelesítés API-kulccsal
Az API-kulcsot tartalmazó fejléc és az SDK-ban beállítandó base URL
Ez az oldal azt mutatja be, hogyan lehet API-kulccsal hitelesíteni a CLEVI átjárón.
Mind az OpenAI-kompatibilis, mind az Anthropic-kompatibilis útvonal egyetlen kulccsal hitelesít, azonban a kulcsot tartalmazó fejléc engedélyezett formája és az SDK-ban beállítandó base URL specifikációnként eltér.
Hitelesítési fejléc
Mindkét kompatibilitási specifikáció egyetlen API-kulccsal hitelesít. A kulcs a konzol API-kulcsok oldalán igényelhető, és a visszavonása, valamint a használati hatóköre is ugyanazon az oldalon kezelhető.
| Fejléc | OpenAI-kompatibilis | Anthropic-kompatibilis |
|---|---|---|
| X-API-Key: <kulcs> | Használható | Használható |
| Authorization: Bearer <kulcs> | Használható | Használható |
| Authorization: <kulcs> (Bearer nélkül) | Elutasítva | Használható |
A fejléc neve nem érzékeny a kis- és nagybetűkre. Az Anthropic SDK által küldött x-api-key is változtatás nélkül működik.
base URL
A korábban használt SDK változtatás nélkül működik, ha csak a base URL-t módosítja az alábbi címre. A két cím abban különbözik, hogy tartalmazza-e a /v1 részt.
| Specifikáció | base URL | Útvonalszabály |
|---|---|---|
| OpenAI-kompatibilis | https://platform.clevi.net/api/v2/aiservice/openai/v1 | A /v1 részt is bele kell foglalni a base URL-be. |
| Anthropic-kompatibilis | https://platform.clevi.net/api/v2/aiservice/anthropic | Mivel az Anthropic SDK maga illeszti hozzá a /v1 részt az útvonalhoz, a cím a /v1 előtt végződik. |
Hitelesítés ellenőrzése
A hitelesítés állapota azonnal ellenőrizhető, ha megadja a kulcsot és a base URL-t, majd lekéri a modellek listáját. Az alábbi három példa ugyanazt a lekérdezést hajtja végre curl, az OpenAI SDK és az Anthropic SDK használatával.
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)Az sk-... helyére az API-kulcsok oldalán igényelt kulcsot írja.
- Ha a válasz 200, a hitelesítés sikeres. A data az ezzel a kulccsal meghívható modellek listáját tartalmazza.
- Ha a válasz 401, az alábbi, Hitelesítési hiba című szakasz sorrendjében ellenőrizze a beállításokat.
Együtt használt fejlécek
Mindegyik opcionális. A problémák nyomon követéséhez azonban érdemes megadni az X-Request-Id értéket.
| Fejléc | Cél | Ha elhagyja |
|---|---|---|
| X-Request-Id | A kérés nyomon követésére szolgáló azonosító. Anthropic-kompatibilis válasz esetén request-id fejlécként érkezik vissza. | A szerver adja ki. |
| X-Region-Code | A hívás régiója | global. |
| X-Product-Sku (product_sku lekérdezési paraméterként is megadható) | Közvetlenül megadja a számlázáshoz használandó Product SKU-t. A fejléc elsőbbséget élvez a lekérdezési paraméterrel szemben, és főként a hang- és voice-útvonalakon használatos. | A voice-útvonalakon szükséges. Az audio/speech és audio/transcriptions a törzs model értéke alapján választja ki a Productot. |
| anthropic-version / anthropic-beta | Változatlanul továbbítódik az Anthropic-kompatibilis útvonalon. | A verzió 2023-06-01. |
Sikertelen hitelesítés
Ha nincs kulcs, vagy lejárt vagy visszavont kulcsot küld, 401-es hiba érkezik. Ha az OpenAI-kompatibilis útvonalon kulcs nélkül hívja meg a szolgáltatást, az alábbi törzset kapja, az Anthropic-kompatibilis útvonalon pedig az error.type értéke authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Az API-kulcsok oldalán ellenőrizze a kulcs állapotát. Lejárt vagy visszavont kulcs esetén adjon ki újat.
- Ellenőrizze, hogy a fejléc neve X-API-Key vagy Authorization-e.
- Ha az OpenAI-kompatibilis útvonalon az Authorization fejlécet használja, ellenőrizze a Bearer előtagot.