Developer guide
API кілтімен аутентификациядан өту
API кілтін енгізетін тақырып және SDK ішінде орнатылатын base URL
Бұл бетте CLEVI шлюзінде API кілтімен аутентификациядан өту жолы түсіндіріледі.
OpenAI үйлесімді жолы мен Anthropic үйлесімді жолының екеуінде де бір кілтпен аутентификациядан өтесіз,
алайда кілт енгізілетін тақырыптың қолдау аясы және SDK ішінде орнатылатын base URL әр спецификацияда әртүрлі.
Аутентификация тақырыбы
Екі үйлесімді спецификацияның екеуінде де бір API кілтімен аутентификациядан өтесіз. Кілт консольдегі API кілттері бетінде жасалады, сол бетте оның күшін жоюды және пайдалану аясын басқара аласыз.
| Тақырып | OpenAI үйлесімді | Anthropic үйлесімді |
|---|---|---|
| X-API-Key: <кілт> | Қолданылады | Қолданылады |
| Authorization: Bearer <кілт> | Қолданылады | Қолданылады |
| Authorization: <кілт> (Bearer жоқ) | Қабылданбайды | Қолданылады |
Тақырып атауларында бас-кіші әріп айырылмайды. Anthropic SDK жіберетін x-api-key тақырыбы да өзгеріссіз жұмыс істейді.
base URL
Пайдаланып жүрген SDK-ны base URL мәнін төмендегі мекенжайға ауыстыру арқылы сол күйінде пайдалана аласыз. Екі мекенжайдың айырмашылығы — /v1 құрамына кіретін-кірмейтіні.
| Спецификация | base URL | Жол ережесі |
|---|---|---|
| OpenAI үйлесімді | https://platform.clevi.net/api/v2/aiservice/openai/v1 | /v1 мәнін base URL ішіне қосыңыз. |
| Anthropic үйлесімді | https://platform.clevi.net/api/v2/aiservice/anthropic | Anthropic SDK жолға /v1 мәнін өзі қосатындықтан, /v1 мәнінің алдынан аяқталады. |
Аутентификацияны тексеру
Кілт пен base URL мәндерін енгізіп, модельдер тізімін сұрату арқылы аутентификациядан өткеніңізді бірден тексере аласыз. Төмендегі үш мысал бір сұрауды curl, OpenAI SDK және 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)sk-... орнына API кілттері бетінде жасалған кілтті енгізіңіз.
- Жауап 200 болса, аутентификациядан өткенсіз. data ішінде осы кілтпен шақыруға болатын модельдер тізімі беріледі.
- Жауап 401 болса, төмендегі аутентификация сәтсіз аяқталды бөліміндегі ретпен тексеріңіз.
Бірге пайдаланылатын тақырып
Барлығы міндетті емес. Мәселені бақылау үшін X-Request-Id мәнін қосқан дұрыс.
| Тақырып | Мақсаты | Көрсетілмесе |
|---|---|---|
| X-Request-Id | Сұрауды бақылауға арналған идентификатор. Anthropic үйлесімді жауапта request-id тақырыбы ретінде қайтарылады. | Сервер береді. |
| X-Region-Code | Қоңырау шалынатын аймақ | global болады. |
| X-Product-Sku (query product_sku ретінде де беруге болады) | Төлемге қолданылатын Product SKU мәнін тікелей көрсетеді. Тақырып query параметрінен басым болады және негізінен дауыстық·voice бағыттарда қолданылады. | voice бағыттарында қажет. audio/speech және audio/transcriptions үшін Product мәні сұрау денесіндегі model арқылы таңдалады. |
| anthropic-version / anthropic-beta | Anthropic үйлесімді бағытта өзгеріссіз беріледі. | Нұсқасы — 2023-06-01. |
Аутентификация сәтсіз аяқталды
Кілт жоқ болса немесе мерзімі өткен не жойылған кілт жіберілсе, 401 қатесі қайтарылады. OpenAI үйлесімді бағытта кілтсіз қоңырау шалсаңыз, төмендегі жауап денесі қайтарылады, ал Anthropic үйлесімді бағыттағы error.type мәні authentication_error болады.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- API кілттері экранынан кілт күйін тексеріңіз. Мерзімі өткен немесе жойылған кілт болса, жаңасын шығарыңыз.
- Тақырып атауы X-API-Key немесе Authorization екенін тексеріңіз.
- OpenAI үйлесімді бағытта Authorization қолдансаңыз, Bearer префиксін тексеріңіз.