Developer guide
Auðkenning með API-lykli
Hausinn sem inniheldur API-lykilinn og base URL sem á að stilla í SDK
Þessi síða fjallar um hvernig á að auðkenna sig með API-lykli í CLEVI-gáttinni.
Báðar leiðirnar, OpenAI-samhæfða leiðin og Anthropic-samhæfða leiðin, nota einn lykil til auðkenningar,
en leyfilegt svið haussins sem inniheldur lykilinn og base URL sem á að stilla í SDK eru mismunandi eftir forskrift.
Auðkenningarhaus
Báðar samhæfðu forskriftirnar nota einn API-lykil til auðkenningar. Lykillinn er gefinn út á API-lykilsíðunni í stjórnborðinu og þar er einnig hægt að afturkalla hann og stjórna notkunarsviði hans.
| Haus | OpenAI-samhæft | Anthropic-samhæft |
|---|---|---|
| X-API-Key: <lykill> | Leyft | Leyft |
| Authorization: Bearer <lykill> | Leyft | Leyft |
| Authorization: <lykill> (án Bearer) | Hafnað | Leyft |
Nöfn hausa eru ekki háð há- og lágstöfum. x-api-key sem Anthropic SDK sendir virkar einnig óbreytt.
base URL
SDK sem þú hefur notað áfram virkar ef þú skiptir aðeins út base URL fyrir eftirfarandi vistfang. Vistföngin tvö eru ólík hvað varðar hvort þau innihalda /v1.
| Forskrift | base URL | Regla fyrir slóð |
|---|---|---|
| OpenAI-samhæft | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Láttu /v1 fylgja með í base URL. |
| Anthropic-samhæft | https://platform.clevi.net/api/v2/aiservice/anthropic | Anthropic SDK bætir /v1 sjálft við slóðina, þannig að slóðin endar á undan /v1. |
Staðfesta auðkenningu
Þú getur strax komist að því hvort auðkenning hafi tekist með því að setja inn lykilinn og base URL og sækja lista yfir líkön. Eftirfarandi þrjár aðferðir framkvæma sömu fyrirspurn með 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)Í stað sk-... seturðu lykilinn sem var gefinn út á API-lykilsíðunni.
- Ef svarið er 200 hefur auðkenning tekist. Í data er listi yfir líkön sem hægt er að kalla á með þessum lykli.
- Ef svarið er 401 skaltu fara yfir atriðin í röðinni í hlutanum „Auðkenning mistókst“ hér að neðan.
Hausar sem notaðir eru saman
Allt er valkvætt. Til að rekja vandamál er þó ráðlagt að hafa X-Request-Id með.
| Haus | Tilgangur | Ef sleppt |
|---|---|---|
| X-Request-Id | Auðkenni til að rekja beiðnir. Í Anthropic-samhæfum svörum kemur það til baka sem request-id-haus. | Útgefið af þjóninum. |
| X-Region-Code | Svæði fyrir beiðnina | global. |
| X-Product-Sku (einnig hægt með product_sku í fyrirspurn) | Tilgreinir Product SKU sem á að nota fyrir gjaldtöku. Hausinn hefur forgang fram yfir fyrirspurnina og er aðallega notaður fyrir tal- og raddslóðir. | Nauðsynlegt fyrir raddslóðir. audio/speech og audio/transcriptions velja Product með model í meginmálinu. |
| anthropic-version / anthropic-beta | Framsent óbreytt í Anthropic-samhæfum slóðum. | Útgáfan er 2023-06-01. |
Auðkenning mistókst
Ef þú sendir ekki lykil eða sendir útrunninn eða afturkallaðan lykil fæst 401. Ef hringt er í OpenAI-samhæfa slóð án lykils kemur meginmálið hér að neðan og error.type í Anthropic-samhæfum slóðum er authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Athugaðu stöðu lykilsins á API-lykilsíðunni. Ef lykillinn er útrunninn eða afturkallaður skaltu gefa út nýjan.
- Athugaðu hvort heiti haussins sé X-API-Key eða Authorization.
- Ef Authorization er notað í OpenAI-samhæfri slóð skaltu athuga Bearer-forskeytið.