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 үчүн base_url дарегине /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 үчүн 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 менен бирге кабарлаңыз. Эгер маанини түз көрсөткөн болсоңуз, аны кардардын журналдары менен дароо салыштырып текшерүүгө болот.