API кілтімен аутентификациядан өту

CLEVI шлюзі OpenAI үйлесімді жол мен Anthropic үйлесімді жолда бір API кілті арқылы аутентификациядан өтеді.
Клиентте орнатылатын екі мән бар: кілт орналасатын аутентификация тақырыбы және SDK-нің base URL мәні. Рұқсат етілетін тақырып пішімі мен base URL әр спецификацияда өзгеше.
Баптауды аяқтағаннан кейін модельдер тізімін сұрату арқылы аутентификацияның сәтті өткенін бірден тексеруге болады.
Аутентификация сәтсіз болса, 401 қайтарылады; аутентификациядан өткеннен кейін рұқсат немесе лимит шарттары орындалмаса, 403 қайтарылады.

API кілтін консольдегі API кілттері бетінде шығарыңыз. Сол бетте кілтті қайтарып алу мен оның қолданылу аясын басқаруға болады.

Аутентификация тақырыбы

Екі спецификацияда да API кілті бір сұрау тақырыбына енгізіледі. X-API-Key тақырыбы немесе Authorization тақырыбы қолданылады, ал рұқсат етілетін пішім спецификацияға байланысты.

OpenAI үйлесімді жолда Authorization тақырыбын пайдаланған кезде Bearer префиксі қажет. Кілтті префикссіз жіберсеңіз, шлюз сұрауды қабылдамайды.

Тақырып атаулары регистрді ажыратпайтындықтан, Anthropic SDK жіберетін x-api-key тақырыбы да өзгеріссіз жұмыс істейді. Екі тақырып та көрсетілсе, X-API-Key мәні басым қолданылады.

base URL

Бұрын пайдаланған SDK-ді base URL мәнін төмендегі мекенжайға ғана өзгерту арқылы сол күйінде пайдалана аласыз. Екі мекенжайдың айырмашылығы — /v1 бөлігі қамтылған-қамтылмағанында, сондықтан спецификацияға сәйкес мекенжайды өзгеріссіз көрсетіңіз.

Аутентификацияны тексеру

Кілт пен base URL орнатқаннан кейін модельдер тізімін сұрату арқылы аутентификация күйін тексеруге болады. Төмендегі мысал бірдей сұратуды curl, OpenAI SDK және Anthropic SDK арқылы орындайды. sk-... орнына API кілті экранында берілген кілтті енгізіңіз.

curl арқылы сұрату кезінде екі стандартта да /v1/models толық жолын көрсетіңіз. Бірінші пәрмен OpenAI үйлесімді жолда X-API-Key тақырыбын, ал екінші пәрмен Anthropic үйлесімді жолда Authorization тақырыбын пайдаланады.

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 ішінде /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 ішінде base_url мәнін /v1 алдындағы жерде аяқталатын мекенжайға орнатыңыз.
Аутентификация үшін SDK жіберетін x-api-key тақырыбын өзгеріссіз пайдаланыңыз.

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)

Кез келген мысалда жауап 200 болса, аутентификация сәтті орындалғанын білдіреді, ал жауаптың data өрісінде осы кілтпен шақыруға болатын модельдер тізімі қамтылады. 401 болса, себебін келесі бөлімде көрсетілген ретпен тексеріңіз.

Аутентификация сәтсіз аяқталды

Кілтсіз немесе мерзімі өткен не жойылған кілт жіберілсе, 401 қайтарылады. OpenAI үйлесімді жолда кілтсіз шақырған кезде төмендегі негізгі мәтін қайтарылады, ал Anthropic үйлесімді жолда error.type мәні authentication_error болады.

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

401 алсаңыз, келесі ретпен тексеріңіз.

1. API кілті экранынан кілт күйін тексеріңіз. Мерзімі өткен немесе жойылған кілт болса, жаңасын алыңыз.
2. Тақырып атауы X-API-Key немесе Authorization екенін тексеріңіз.
3. OpenAI үйлесімді жолда Authorization тақырыбын пайдалансаңыз, Bearer префиксі бар екенін тексеріңіз.

Өзгерістер енгізгеннен кейін аутентификацияны тексеру бөліміндегі модельдер тізімін сұратуды қайта орындап, 200 келетінін тексеріңіз.

Бірге пайдаланылатын тақырыптар

Келесі тақырыптардың барлығы міндетті емес. Мәселені бақылау үшін X-Request-Id көрсетуді ұсынамыз.

5xx қателері қайталанса, анықтама қызметі мен қолдау қызметіне X-Request-Id мәнін қоса хабарласыңыз. Мәнді өзіңіз көрсеткен болсаңыз, оны клиент журналдарымен бірден салыстыруға болады.