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 सोबत मदत आणि चौकशीद्वारे आम्हाला कळवा. मूल्य थेट निर्दिष्ट केले असल्यास, क्लायंटच्या नोंदींशी त्वरित पडताळणी करता येते.