Auðkenning með API-lykli

CLEVI-gáttin auðkennir OpenAI-samhæfðar leiðir og Anthropic-samhæfðar leiðir með einum API-lykli.
Það eru tvö gildi sem þarf að stilla hjá biðlaranum: auðkenningarhausinn sem inniheldur lykilinn og base URL SDK-sins. Leyfilegt snið haussins og base URL er mismunandi eftir forskrift.
Eftir að uppsetningu er lokið er hægt að staðfesta auðkenninguna strax með því að sækja lista yfir líkön.
Ef auðkenning mistekst er 401 skilað. Ef auðkenning tekst en skilyrði um heimildir eða takmörk eru ekki uppfyllt er 403 skilað.

Gefðu út API-lykil á API-lykilsíðunni í stjórnborðinu. Á sömu síðu er hægt að afturkalla lykilinn og stjórna notkunarsviði hans.

Auðkenningarhaus

Báðar forskriftirnar setja API-lykilinn í einn beiðnihaus. Notaðu annaðhvort X-API-Key-hausinn eða Authorization-hausinn; leyfilegt snið fer eftir forskrift.

Þegar Authorization-hausinn er notaður í OpenAI-samhæfðri leið þarf Bearer-forskeytið. Ef aðeins lykillinn er sendur án forskeytis hafnar gáttin beiðninni.

Heiti hausa eru ekki háð há- og lágstöfum, þannig að x-api-key-hausinn sem Anthropic SDK sendir virkar einnig óbreyttur. Ef báðir hausarnir eru tilgreindir hefur X-API-Key-gildið forgang.

base URL

SDK sem þú hefur notað hingað til má áfram nota óbreytt með því einu að breyta base URL í eitt af eftirfarandi vistföngum. Vistföngin tvö eru ólík að því leyti hvort þau innihalda /v1, svo tilgreindu viðeigandi vistfang óbreytt samkvæmt forskriftinni.

Staðfesta auðkenningu

Eftir að þú hefur stillt lykilinn og base URL geturðu staðfest auðkenningu með því að sækja lista yfir líkön. Dæmin hér að neðan framkvæma sömu fyrirspurn með curl, OpenAI SDK og Anthropic SDK. Settu lykilinn sem gefinn var út á API-lykilssíðunni í stað sk-....

Þegar listinn er sóttur með curl skaltu tilgreina alla slóðina að /v1/models fyrir báðar forskriftirnar. Fyrsta skipunin notar X-API-Key-hausinn fyrir OpenAI-samhæfðu slóðina og seinni skipunin notar Authorization-hausinn fyrir Anthropic-samhæfðu slóð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 tilgreinir heimilisfang sem inniheldur /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 tilgreinir heimilisfang í base_url sem endar rétt fyrir /v1.
Við auðkenningu er x-api-key-hausinn sem SDK sendir notaður óbreyttur.

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)

Ef svarið er 200 í einhverju dæmanna hefur auðkenning tekist og data í svarinu inniheldur lista yfir líkönin sem hægt er að kalla á með þessum lykli. Ef svarið er 401 skaltu athuga orsökina í þeirri röð sem lýst er í næsta kafla.

Auðkenning mistókst

Ef þú sendir engan lykil eða sendir lykil sem er útrunninn eða afturkallaður skilar þjónustan 401. Ef kallað er án lykils í OpenAI-samhæfðu slóðinni skilar þjónustan eftirfarandi meginmáli, en í Anthropic-samhæfðu slóðinni er error.type authentication_error.

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

Ef þú færð 401 skaltu athuga eftirfarandi í þessari röð.

1. Athugaðu stöðu lykilsins á API-lykilssíðunni. Ef lykillinn er útrunninn eða afturkallaður skaltu gefa út nýjan.
2. Athugaðu hvort hausinn heiti X-API-Key eða Authorization.
3. Ef þú notar Authorization-hausinn í OpenAI-samhæfðu slóðinni skaltu athuga hvort hann innihaldi Bearer-forskeytið.

Eftir að þú hefur lagfært þetta skaltu keyra aftur fyrirspurnina um lista yfir líkön í kaflanum um staðfestingu auðkenningar og athuga hvort svarið sé 200.

Hausar sem notaðir eru saman

Allir eftirfarandi hausar eru valfrjálsir. Við mælum með að þú tilgreinir X-Request-Id svo hægt sé að rekja vandamál.

Ef 5xx-villur koma endurtekið upp skaltu láta okkur vita í hjálparmiðstöðinni og með fyrirspurn, ásamt X-Request-Id. Ef þú tilgreindir gildið sjálf(ur) er hægt að bera það strax saman við skráningu biðlarans.