Autentifikācija, izmantojot API atslēgu

CLEVI vārteja autentificē gan ar OpenAI saderīgu ceļu, gan ar Anthropic saderīgu ceļu, izmantojot vienu API atslēgu.
Klienta pusē jāiestata divas vērtības: autentifikācijas galvene, kurā tiek ievietota atslēga, un SDK base URL. Atļautais galvenes formāts un base URL atšķiras atkarībā no specifikācijas.
Pēc iestatīšanas autentifikāciju varat nekavējoties pārbaudīt, izgūstot modeļu sarakstu.
Ja autentifikācija neizdodas, tiek atgriezts 401; ja pēc veiksmīgas autentifikācijas netiek izpildīti autorizācijas vai ierobežojumu nosacījumi, tiek atgriezts 403.

Izsniedziet API atslēgu konsoles API atslēgu ekrānā. Tajā pašā ekrānā varat pārvaldīt atslēgas atsaukšanu un izmantošanas tvērumu.

Autentifikācijas galvene

Abās specifikācijās API atslēga tiek ievietota vienā pieprasījuma galvenē. Tiek izmantota viena no galvenēm X-API-Key vai Authorization, un atļautais formāts atšķiras atkarībā no specifikācijas.

Izmantojot Authorization galveni ar OpenAI saderīgo ceļu, ir nepieciešams prefikss Bearer. Ja nosūtāt tikai atslēgu bez prefiksa, vārteja pieprasījumu noraida.

Galveņu nosaukumos reģistrs netiek ņemts vērā, tāpēc arī x-api-key galvene, ko nosūta Anthropic SDK, darbojas bez izmaiņām. Ja norādāt abas galvenes, priekšroka tiek dota X-API-Key vērtībai.

base URL

Esošo SDK varat turpināt izmantot, 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, tāpēc norādiet specifikācijai atbilstošo adresi tieši tādu, kāda tā ir.

Autentifikācijas pārbaude

Pēc atslēgas un base URL iestatīšanas izgūstiet modeļu sarakstu, lai pārbaudītu, vai autentifikācija ir veiksmīga. Tālāk redzamajos piemēros tas pats pieprasījums tiek izpildīts, izmantojot curl, OpenAI SDK un Anthropic SDK. Vietā sk-... ievietojiet atslēgu, kas izsniegta API atslēgas ekrānā.

Veicot pieprasījumu ar curl, abām specifikācijām norādiet pilnu ceļu līdz /v1/models. Pirmajā komandā OpenAI saderīgajam ceļam tiek izmantota X-API-Key galvene, bet otrajā komandā Anthropic saderīgajam ceļam tiek izmantota Authorization galvene.

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 laukā base_url norādiet adresi, kurā iekļauts /v1.

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 laukā base_url norādiet adresi, kas beidzas pirms /v1.
Autentifikācijai izmantojiet SDK nosūtīto x-api-key galveni bez izmaiņām.

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)

Ja jebkurā piemērā atbilde ir 200, autentifikācija ir veiksmīga, un atbildes data satur to modeļu sarakstu, kurus var izsaukt ar šo atslēgu. Ja saņemat 401, pārbaudiet iemeslu nākamajā sadaļā norādītajā secībā.

Autentifikācijas kļūme

Ja nosūtāt neesošu, beigušos vai atsauktu atslēgu, tiek atgriezts 401. Ja OpenAI saderīgajā ceļā veicat pieprasījumu bez atslēgas, tiek atgriezts tālāk redzamais pamatteksts, savukārt Anthropic saderīgajā ceļā error.type ir authentication_error.

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

Ja saņemat 401, pārbaudiet tālāk norādītajā secībā.

1. API atslēgas ekrānā pārbaudiet atslēgas statusu. Ja atslēgas derīguma termiņš ir beidzies vai tā ir atsaukta, izsniedziet jaunu.
2. Pārbaudiet, vai galvenes nosaukums ir X-API-Key vai Authorization.
3. Ja OpenAI saderīgajā ceļā izmantojat Authorization galveni, pārbaudiet, vai tai ir Bearer prefikss.

Pēc labojumu veikšanas vēlreiz izpildiet modeļu saraksta izgūšanu autentifikācijas pārbaudes sadaļā un pārbaudiet, vai tiek saņemta atbilde 200.

Kopīgi izmantojamās galvenes

Visas tālāk norādītās galvenes nav obligātas. Lai atvieglotu problēmu izsekošanu, ieteicams norādīt X-Request-Id.

Ja 5xx kļūdas atkārtojas, informējiet mūs, izmantojot palīdzības sadaļu un saziņas veidlapu, kopā ar X-Request-Id. Ja vērtība tika norādīta tieši, to var nekavējoties salīdzināt ar klienta žurnāliem.