API gakoarekin autentifikatzea

CLEVI atebideak OpenAI-rekin bateragarria den bidea eta Anthropic-rekin bateragarria den bidea API gako bakarrarekin autentifikatzen ditu.
Bezeroan konfiguratu beharreko bi balioak hauek dira: gakoa duen autentifikazio-goiburua eta SDK-ren base URL; baimendutako goiburu-formatua eta base URL-a desberdinak dira zehaztapen bakoitzean.
Konfigurazioa amaitu ondoren, egiaztatu autentifikazioa zuzenean modeloen zerrenda kontsultatuz.
Autentifikazioak huts egiten badu, 401 itzuliko du; autentifikazioa gainditu ondoren baimen- edo muga-baldintzak betetzen ez badira, 403 itzuliko du.

Eskatu API gakoa kontsolako API gakoen pantailan. Pantaila berean kudea ditzakezu gakoa baliogabetzea eta erabilera-esparrua.

Autentifikazio-goiburua

Bi zehaztapenek API gakoa eskaeraren goiburu bakar batean sartzen dute. X-API-Key goiburua edo Authorization goiburua erabiltzen da, eta baimendutako formatua zehaztapenaren arabera aldatzen da.

OpenAI-rekin bateragarria den bidean Authorization goiburua erabiltzean, Bearer aurrizkia beharrezkoa da. Gakoa bakarrik bidaltzen baduzu, aurrizkirik gabe, atebideak eskaera baztertuko du.

Goiburuen izenek ez dituzte maiuskulak eta minuskulak bereizten; beraz, Anthropic SDK-k bidaltzen duen x-api-key goiburuak ere zuzenean funtzionatzen du. Bi goiburuak zehazten badira, X-API-Key balioa aplikatuko da lehentasunez.

base URL

Lehendik erabiltzen zenuen SDK-a bere horretan erabil dezakezu, base URL-a beheko helbidera aldatuta soilik. Bi helbideak desberdinak dira /v1 barne hartzen duten ala ez; beraz, zehaztapenari dagokion helbidea zehaztu behar duzu, aldaketarik gabe.

Autentifikazioa egiaztatzea

Gakoa eta base URLa konfiguratu ondoren, ereduen zerrenda kontsultatuta autentifikazioa egiaztatu dezakezu. Beheko adibideek kontsulta bera curl, OpenAI SDK eta Anthropic SDK erabiliz exekutatzen dute. Erabili API-gakoen pantailan igorritako gakoa sk-... lekuan.

curl erabiliz kontsultatzean, bi zehaztapenetan /v1/models-erako bide osoa zehaztu behar da. Lehen komandoak X-API-Key goiburua erabiltzen du OpenAI-rekin bateragarria den bidean, eta bigarrenak Authorization goiburua Anthropic-rekin bateragarria den bidean.

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-n, zehaztu /v1 barne hartzen duen helbidea base_url-en.

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-n, zehaztu /v1 baino lehen amaitzen den helbidea base_url-en.
Autentifikaziorako, erabili SDK-k bidaltzen duen x-api-key goiburua bere horretan.

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)

Edozein adibidetan erantzuna 200 bada, autentifikazioa arrakastatsua izan da, eta erantzunaren data eremuak gako honekin dei daitezkeen ereduen zerrenda jasotzen du. 401 jasotzen baduzu, egiaztatu arrazoia hurrengo atalean adierazitako ordenan.

Autentifikazioak huts egin du

Gakorik ez badago edo iraungitako edo baliogabetutako gako bat bidaltzen bada, 401 itzultzen da. OpenAI-rekin bateragarria den bidean gakorik gabe deitzen baduzu, beheko gorputza itzultzen da; Anthropic-rekin bateragarria den bidean, berriz, error.type authentication_error da.

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

401 jasotzen baduzu, egiaztatu hurrengo ordenan.

1. Egiaztatu gakoaren egoera API-gakoen pantailan. Iraungita edo baliogabetuta badago, igorri berri bat.
2. Egiaztatu goiburuaren izena X-API-Key edo Authorization den.
3. OpenAI-rekin bateragarria den bidean Authorization goiburua erabiltzen baduzu, egiaztatu Bearer aurrizkia dagoela.

Aldaketak egin ondoren, exekutatu berriro autentifikazioa egiaztatzeko ataleko ereduen zerrendaren kontsulta, 200 jasotzen duzula egiaztatzeko.

Batera erabiltzen diren goiburuak

Ondorengo goiburu guztiak aukerakoak dira. Arazoen jarraipena egin ahal izateko, X-Request-Id zehaztea gomendatzen dugu.

5xx erroreak behin eta berriz gertatzen badira, jakinarazi laguntza eta kontsulta bidez, X-Request-Id erantsita. Balioa zuk zuzenean zehaztu baduzu, bezeroaren erregistroarekin berehala alderatu ahal izango da.