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 सहित सहायता आ सम्पर्कक माध्यमसँ हमरा सभकेँ जनाउ। जँ मान सीधे निर्दिष्ट कएल गेल हो तँ ओकर तुलना क्लाइंट रिकॉर्डसँ तुरन्त कएल जा सकैत अछि।