Váttan við API-lykli

CLEVI-gáttin váttar OpenAI-samhæfdu leiðina og Anthropic-samhæfdu leiðina við einum API-lykli.
Tað eru tvey virði, sum skulu setast á klientinum: váttanarheimið, sum inniheldur lykilin, og base URL hjá SDK. Loyvdu heimasniðini og base URL eru ymisk alt eftir standardinum.
Eftir at uppsetingin er liðug, kanst tú kanna váttanina beinanvegin við at heinta listan yvir modell.
Um váttanin miseydnast, verður 401 afturgivið. Um váttanin eydnast, men treytirnar fyri heimild ella mark verða ikki loknar, verður 403 afturgivið.

Útgev API-lykilin á API-lykla-síðuni í konsollinum. Á somu síðu kanst tú eisini umsita ógilding av lyklinum og nýtsluøkið.

Váttanarheimi

Báðir standardarnir goyma API-lykilin í einum request-heimi. Tú kanst brúka antin X-API-Key-heimið ella Authorization-heimið, og loyvda sniðið veldst um standardin.

Tá ið Authorization-heimið verður brúkt í OpenAI-samhæfdu leiðini, krevst Bearer-forskeytið. Um tú sendir bara lykilin uttan forskeytið, vísir gáttin requestinum aftur.

Heimanøvn eru ikki smá- og stórstavakend, so x-api-key-heimið, sum Anthropic SDK sendir, virkar eisini óbroytt. Um bæði heimi verða ásett, fær virðið í X-API-Key fremru raðfesting.

base URL

SDK, sum tú longu brúkar, kann framvegis brúkast við bara at broyta base URL til eina av niðanfyri nevndu adressunum. Munurin millum adressurnar er, um tær innihalda /v1, so áset ta adressuna, sum samsvarar við standardin, óbroytta.

Kanna váttan

Settu lykil og base URL, og leitaðu síðani eftir modelllistanum fyri at kanna, um tú ert innritað/ur. Dømini niðanfyri koyra somu leiting við curl, OpenAI SDK og Anthropic SDK. Set lykilin, sum tú hevur fingið á síðuni við API-lyklinum, í staðin fyri sk-....

Tá tú leitar við curl, skalt tú tilskila alla leiðina til /v1/models í báðum sniðum. Fyrsta boðið brúkar X-API-Key-headerin til OpenAI-samsvarandi leiðina, og annað boðið brúkar Authorization-headerin til Anthropic-samsvarandi leiðina.

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 skal brúka eina adressu, sum fevnir um /v1 í base_url.

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 skal brúka eina adressu í base_url, sum endar áðrenn /v1.
Til auðkenning verður x-api-key-headerin, sum SDK sendir, brúkt óbroytt.

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)

Um svarið í einum og hvørjum dømi er 200, eydnaðist auðkenningin, og data í svarinum inniheldur listan yvir modell, sum kunnu kallast við hesum lyklinum. Um svarið er 401, skalt tú kanna orsøkina í raðfylgjuni í næsta parti.

Miseydnað auðkenning

Um tú sendir ein lykil, sum ikki finst, er útrunnin ella er ógildaður, verður 401 latið aftur. Um tú kallar OpenAI-samsvarandi leiðina uttan lykil, verður kroppurin niðanfyri latin aftur, og í Anthropic-samsvarandi leiðini er error.type authentication_error.

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

Um tú fært 401, skalt tú kanna hetta í hesi raðfylgju.

1. Kanna støðuna á lyklinum á síðuni við API-lyklinum. Um lykilin er útrunnin ella ógildaður, skalt tú fáa ein nýggjan.
2. Kanna, um heitið á headerinum er X-API-Key ella Authorization.
3. Um tú brúkar Authorization-headerin í OpenAI-samsvarandi leiðini, skalt tú kanna, um Bearer-forskeytið er við.

Eftir broytingarnar skalt tú koyra modelllistaleitingina í partinum um at kanna auðkenning umaftur og kanna, um tú fært 200.

Headers, sum verða brúktir saman

Allir hesir headers eru valfríir. Vit mæla til at tilskila X-Request-Id, so trupulleikar kunnu sporast.

Um 5xx-feilir endurtaka seg, boða frá teimum í hjálpini og við fyrispurningi, saman við X-Request-Id. Um tú hevur tilskilað virðið sjálv/ur, kann tað beinleiðis samanberast við klientsskrásetingina.