Developer guide
API gakoarekin autentifikatzea
Gakoa sartzeko goiburua eta SDK-an ezarri beharreko base URL-a
Orrialde honetan CLEVI atebidean API gakoarekin autentifikatzeko modua azaltzen da.
OpenAI-rekin bateragarria den bidean eta Anthropic-rekin bateragarria den bidean, gako bakarrarekin autentifikatzen da,
eta gakoa sartzeko goiburuaren baimendutako esparrua eta SDK-an ezarri beharreko base URL-a desberdinak dira zehaztapen bakoitzean.
Autentifikazio-goiburua
Bateragarritasun-zehaztapen bietan API gako bakarrarekin autentifikatzen da. Gakoa kontsolako API gakoen pantailan ematen da, eta pantaila berean kudeatzen dira baliogabetzea eta erabilera-esparrua.
| Goiburua | OpenAI-rekin bateragarria | Anthropic-rekin bateragarria |
|---|---|---|
| X-API-Key: <키> | Erabilgarri | Erabilgarri |
| Authorization: Bearer <키> | Erabilgarri | Erabilgarri |
| Authorization: <키> (Bearer gabe) | Baztertua | Erabilgarri |
Goiburu-izenek ez dituzte maiuskulak eta minuskulak bereizten. Anthropic SDK-k bidaltzen duen x-api-key-ak ere bere horretan funtzionatzen du.
base URL-a
Erabiltzen zenuen SDK-ak bere horretan funtzionatuko du base URL-a beheko helbidera aldatuz gero. Bi helbideek /v1 sartuta duten ala ez da desberdina.
| Zehaztapena | base URL-a | Bide-araua |
|---|---|---|
| OpenAI-rekin bateragarria | https://platform.clevi.net/api/v2/aiservice/openai/v1 | /v1 base URL-an sartzen da. |
| Anthropic-rekin bateragarria | https://platform.clevi.net/api/v2/aiservice/anthropic | Anthropic SDK-k /v1 gehitzen dio bideari automatikoki; beraz, /v1 baino lehen amaitzen da. |
Autentifikazioa egiaztatzea
Gakoa eta base URL-a sartuta modeloen zerrenda kontsultatzen baduzu, autentifikatu zaren berehala jakin dezakezu. Beheko hiru adibideek kontsulta bera egiten dute curl, OpenAI SDK eta Anthropic SDK erabiliz.
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)sk-... lekuan, sartu API gakoen pantailan emandako gakoa.
- Erantzuna 200 bada, autentifikazioa eginda dago. data atalean gako honekin deitu daitezkeen modeloen zerrenda jasotzen da.
- Erantzuna 401 bada, egiaztatu autentifikazioak huts egin duen ataleko urratsen hurrenkerari jarraituz.
Batera erabiltzen diren goiburuak
Aukera guztiak dira. Arazoen jarraipena egiteko, hobe da X-Request-Id sartzea.
| Goiburua | Erabilera | Baztertuz gero |
|---|---|---|
| X-Request-Id | Eskaeren jarraipenerako identifikatzailea. Anthropic bateragarri den erantzunetan, request-id goiburu gisa itzultzen da. | Zerbitzariak ematen du. |
| X-Region-Code | Deiaren eskualdea | global da. |
| X-Product-Sku (product_sku kontsultarekin ere erabil daiteke) | Fakturaziorako erabiliko den Product SKU zuzenean zehazten du. Goiburuak kontsultaren lehentasuna du, eta batez ere ahots- eta voice-bideetan erabiltzen da. | Beharrezkoa da voice-bideetan. audio/speech eta audio/transcriptions bideek gorputzeko model erabiliz hautatzen dute Product. |
| anthropic-version / anthropic-beta | Anthropic bateragarri diren bideetara bere horretan helarazten dira. | Bertsioa 2023-06-01 da. |
Autentifikazioak huts egin du
Gakorik ez badago edo iraungitako edo baliogabetutako gako bat bidaltzen bada, 401 errorea gertatzen da. OpenAI bateragarri den bidean gakorik gabe deitzen baduzu, beheko gorputza jasoko duzu; Anthropic bateragarri den bideko error.type authentication_error da.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Egiaztatu gakoaren egoera API gakoen pantailan. Iraungita edo baliogabetuta badago, eskatu berri bat.
- Egiaztatu goiburuaren izena X-API-Key edo Authorization den.
- OpenAI bateragarri den bidean Authorization erabiltzen baduzu, egiaztatu Bearer aurrizkia.