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 (क्वेरीमधील product_sku द्वारेही शक्य) | बिलिंगसाठी वापरला जाणारा Product SKU थेट निर्दिष्ट करतो. हेडरला क्वेरीपेक्षा प्राधान्य असते आणि तो प्रामुख्याने आवाज·voice मार्गांमध्ये वापरला जातो. | voice मार्गांमध्ये आवश्यक आहे. audio/speech आणि audio/transcriptions साठी मुख्य भागातील model द्वारे Product निवडले जाते. |
| 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 उपसर्ग तपासा.