Developer guide
Autentifikācija ar API atslēgu
Galvene, kurā jāievieto API atslēga, un base URL, kas jāiestata SDK
Šajā lapā ir aprakstīts, kā CLEVI vārtejā autentificēties ar API atslēgu.
Gan ar OpenAI saderīgajā, gan ar Anthropic saderīgajā ceļā autentifikācijai tiek izmantota viena atslēga,
taču galvenes, kurā jāievieto atslēga, pieļaujamais lietojums un SDK iestatāmais base URL atšķiras atkarībā no specifikācijas.
Autentifikācijas galvenes
Abās saderīgajās specifikācijās autentifikācijai tiek izmantota viena API atslēga. Atslēgu var izveidot konsoles API atslēgu lapā, un tajā pašā lapā pārvaldīt tās atsaukšanu un lietojuma tvērumu.
| Galvene | OpenAI saderīga | Anthropic saderīga |
|---|---|---|
| X-API-Key: <키> | Atļauts | Atļauts |
| Authorization: Bearer <키> | Atļauts | Atļauts |
| Authorization: <키> (Bearer 없이) | Noraidīts | Atļauts |
Galvenes nosaukumā reģistrs nav nozīmīgs. Arī Anthropic SDK nosūtītā x-api-key galvene darbojas bez izmaiņām.
base URL
Izmantoto SDK var turpināt lietot, vienkārši nomainot base URL uz kādu no tālāk norādītajām adresēm. Abas adreses atšķiras ar to, vai tajās ir iekļauts /v1.
| Specifikācija | base URL | Ceļa noteikumi |
|---|---|---|
| OpenAI saderīga | https://platform.clevi.net/api/v2/aiservice/openai/v1 | base URL jāietver līdz /v1. |
| Anthropic saderīga | https://platform.clevi.net/api/v2/aiservice/anthropic | Anthropic SDK pats pievieno /v1 ceļam, tāpēc URL beidzas pirms /v1. |
Autentifikācijas pārbaude
Ievietojot API atslēgu un base URL un izgūstot modeļu sarakstu, varat uzreiz pārbaudīt, vai autentifikācija ir veiksmīga. Tālāk minētie trīs piemēri veic vienu un to pašu izgūšanu, izmantojot curl, OpenAI SDK un 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)Pozīcijā sk-... ievietojiet API atslēgu, kas izveidota API atslēgu lapā.
- Ja atbilde ir 200, autentifikācija ir veiksmīga. Laukā data ir ietverts to modeļu saraksts, kurus var izsaukt ar šo atslēgu.
- Ja atbilde ir 401, pārbaudiet to, kā aprakstīts tālāk sadaļā par autentifikācijas kļūmēm.
Kopīgi izmantojamā galvene
Visi ir neobligāti. Lai izsekotu problēmai, ieteicams iekļaut X-Request-Id.
| Galvene | Izmantojums | Ja nav norādīta |
|---|---|---|
| X-Request-Id | Identifikators pieprasījumu izsekošanai. Anthropic saderīgā atbildē tas tiek atgriezts kā request-id galvene. | To piešķir serveris. |
| X-Region-Code | Izsaukuma reģions | global. |
| X-Product-Sku (iespējams arī ar vaicājuma parametru product_sku) | Tieši norāda Product SKU, kas jāizmanto norēķiniem. Galvenei ir prioritāte pār vaicājuma parametru, un to galvenokārt izmanto balss maršrutos. | Balss maršrutos tas ir nepieciešams. audio/speech un audio/transcriptions izmanto model vērtību pamattekstā, lai izvēlētos Product. |
| anthropic-version / anthropic-beta | Anthropic saderīgajā maršrutā tiek pārsūtīts nemainīts. | Versija ir 2023-06-01. |
Autentifikācijas kļūme
Ja nosūtāt neesošu, beigušos vai atsauktu atslēgu, tiek atgriezts 401. Ja OpenAI saderīgajā maršrutā tiek veikts izsaukums bez atslēgas, tiek atgriezts tālāk norādītais pamatteksts, bet Anthropic saderīgā maršruta error.type vērtība ir authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- API atslēgu ekrānā pārbaudiet atslēgas statusu. Ja atslēgai ir beidzies derīguma termiņš vai tā ir atsaukta, izveidojiet jaunu.
- Pārbaudiet, vai galvenes nosaukums ir X-API-Key vai Authorization.
- Ja OpenAI saderīgajā maršrutā izmantojat Authorization, pārbaudiet Bearer prefiksu.