Developer guide
Staðfesting við API-lykli
Headerurin, sum API-lykilin skal setast í, og base URL, sum skal setast í SDK
Henda síðan lýsir, hvussu tú staðfestir teg við einum API-lykli í CLEVI-gáttini.
Bæði OpenAI-samhæfti leiðin og Anthropic-samhæfti leiðin brúka ein lykil til staðfestingar,
men loyvda økið fyri headerin, sum lykilin skal setast í, og base URL, sum skal setast í SDK, eru ymisk fyri hvønn standard.
Staðfestingarheader
Báðir samhæfti standardar brúka ein API-lykil til staðfestingar. Lykilin verður útgivin á API-lykla-síðuni í konsollinum, har tú eisini kanst ógilda hann og stýra nýtsluøkinum.
| Header | OpenAI-samhæfti | Anthropic-samhæfti |
|---|---|---|
| X-API-Key: <lykil> | Kann brúkast | Kann brúkast |
| Authorization: Bearer <lykil> | Kann brúkast | Kann brúkast |
| Authorization: <lykil> (uttan Bearer) | Vrakað | Kann brúkast |
Header-nøvn eru ikki viðkvæm fyri stórum og smáum bókstavum. x-api-key, sum Anthropic SDK sendir, riggar eisini óbroytt.
base URL
SDK, sum tú longu brúkar, kann halda fram við at virka, um tú bert broytir base URL til eina av niðanfyri nevndu adressunum. Tær báðar adressurnar eru ymiskar viðvíkjandi, um /v1 er við ella ikki.
| Standardur | base URL | Reglur fyri leið |
|---|---|---|
| OpenAI-samhæfti | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Lat base URL enda við /v1. |
| Anthropic-samhæfti | https://platform.clevi.net/api/v2/aiservice/anthropic | Anthropic SDK leggur sjálvt /v1 afturat leiðini, so hon endar áðrenn /v1. |
Kanna staðfesting
Tú kanst beinanvegin vita, um staðfestingin eydnaðist, við at seta lykilin og base URL inn og heinta modellalistann. Niðanfyri verður sama fyrispurningur gjørdur við curl, OpenAI SDK og 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)Set lykilin, sum er útgivin á API-lykla-síðuni, í staðin fyri sk-....
- Um svarið er 200, er staðfestingin góðkend. data inniheldur listan yvir modell, sum kann kallast við hesum lyklinum.
- Um svarið er 401, skalt tú kanna eftir raðfylgjuni í kapitlinum um miseydnaða staðfesting niðanfyri.
Headerar, sum verða brúktir saman
Alt er valfrítt. Fyri at spora trupulleikar er tó best at hava X-Request-Id við.
| Hevur | Endamál | Um tað verður útelt |
|---|---|---|
| X-Request-Id | Eyðkenni til at spora umbønir. Í Anthropic-samhæftum svari verður tað sent aftur sum request-id-hevur. | Netþjónnurin útskrivar tað. |
| X-Region-Code | Kalløki | global. |
| X-Product-Sku (eisini møguligt við query product_sku) | Tilskila beinleiðis Product SKU, sum skal brúkast til gjalding. Hevur framíhjárætt fram um query og verður serliga brúkt í talu- og røddarleiðum. | Er neyðugt í røddarleiðum. audio/speech og audio/transcriptions velja Product við model í body. |
| anthropic-version / anthropic-beta | Verða send víðari óbroytt í Anthropic-samhæftum leiðum. | Útgávan er 2023-06-01. |
Váttan miseydnaðist
Um lykil vantar, ella um tú sendir ein útgingnan ella ógildaðan lykil, fært tú 401. Um tú kallar OpenAI-samhæftu leiðina uttan lykil, kemur niðanfyri nevnda body, og error.type í Anthropic-samhæftu leiðini er authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Kanna støðuna á lyklinum á API-lykilsíðuni. Um lykilin er útgingin ella ógildaður, fá tær ein nýggjan.
- Kanna, um heitið er X-API-Key ella Authorization.
- Um tú brúkar Authorization í OpenAI-samhæftu leiðini, kannaðu, at Bearer-forskeytið er við.