Developer guide
Autentifikavimas naudojant API raktą
Antraštė, į kurią įtraukiamas API raktas, ir SDK nustatomas base URL
Šiame puslapyje aprašoma, kaip autentifikuotis CLEVI šliuze naudojant API raktą.
Tiek su OpenAI suderinamas kelias, tiek su Anthropic suderinamas kelias autentifikuojamas vienu raktu,
tačiau leistinos antraštės, į kurią įtraukiamas raktas, ir SDK nustatomas base URL skiriasi pagal specifikaciją.
Autentifikavimo antraštė
Pagal abi suderinamas specifikacijas autentifikuojama vienu API raktu. Raktas išduodamas konsolės API raktų puslapyje; tame pačiame puslapyje galite valdyti jo atšaukimą ir naudojimo sritį.
| Antraštė | Suderinama su OpenAI | Suderinama su Anthropic |
|---|---|---|
| X-API-Key: <키> | Leidžiama | Leidžiama |
| Authorization: Bearer <키> | Leidžiama | Leidžiama |
| Authorization: <키> (be Bearer) | Atmetama | Leidžiama |
Antraštės pavadinime skiriamosios didžiosios ir mažosios raidės neturi reikšmės. Anthropic SDK siunčiama x-api-key antraštė taip pat veikia be pakeitimų.
base URL
Naudojamą SDK galite toliau naudoti nepakeistą, pakeitę tik base URL į vieną iš toliau pateiktų adresų. Šie du adresai skiriasi tuo, ar juose yra /v1.
| Specifikacija | base URL | Kelio taisyklė |
|---|---|---|
| Suderinama su OpenAI | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Į base URL įtraukite iki /v1 imtinai. |
| Suderinama su Anthropic | https://platform.clevi.net/api/v2/aiservice/anthropic | Anthropic SDK pats prideda /v1 prie kelio, todėl URL baigiasi prieš /v1. |
Autentifikavimo patikra
Įrašę raktą ir base URL bei užklausę modelių sąrašą iš karto sužinosite, ar autentifikavimas sėkmingas. Toliau pateikti trys pavyzdžiai atlieka tą pačią užklausą naudodami curl, OpenAI SDK ir Anthropic SDK.
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)Vietoje sk-... įrašykite API raktų puslapyje išduotą raktą.
- Jei atsakymas yra 200, autentifikavimas sėkmingas. Lauke data pateikiamas modelių, kuriuos galima iškviesti naudojant šį raktą, sąrašas.
- Jei atsakymas yra 401, patikrinkite pagal toliau pateiktame autentifikavimo nesėkmės skyriuje nurodytą tvarką.
Kartu naudojamos antraštės
Visa tai neprivaloma. Problemoms sekti rekomenduojama įtraukti X-Request-Id.
| Antraštė | Paskirtis | Jei praleidžiama |
|---|---|---|
| X-Request-Id | Užklausos sekimo identifikatorius. Anthropic suderinamame atsakyme grąžinamas kaip request-id antraštė. | Išduoda serveris. |
| X-Region-Code | Iškvietimo regionas | global. |
| X-Product-Sku (taip pat galima naudoti užklausos parametrą product_sku) | Tiesiogiai nurodo Product SKU, kuris bus naudojamas atsiskaitymui. Antraštė turi pirmenybę prieš užklausos parametrą ir daugiausia naudojama balso bei voice maršrutuose. | Voice maršrutuose būtina. audio/speech ir audio/transcriptions Product parenka pagal model pagrindinėje dalyje. |
| anthropic-version / anthropic-beta | Anthropic suderinamuose maršrutuose perduodama nepakeista. | Versija yra 2023-06-01. |
Autentifikavimo klaida
Jei siunčiamas neegzistuojantis, pasibaigusio galiojimo arba atšauktas raktas, grąžinama 401 klaida. OpenAI suderinamame maršrute iškvietus be rakto pateikiamas toliau nurodytas atsakymo turinys, o Anthropic suderinamame maršrute error.type reikšmė yra authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Patikrinkite rakto būseną API raktų puslapyje. Jei raktas pasibaigusio galiojimo arba atšauktas, išduokite naują.
- Patikrinkite, ar antraštės pavadinimas yra X-API-Key arba Authorization.
- Jei OpenAI suderinamame maršrute naudojate Authorization, patikrinkite Bearer priešdėlį.