Developer guide
API కీతో ప్రామాణీకరించడం
API కీని చేర్చే హెడర్ మరియు SDKలో సెట్ చేయాల్సిన base URL
CLEVI గేట్‌వే OpenAI అనుకూల మార్గం మరియు Anthropic అనుకూల మార్గాన్ని ఒకే API కీతో ప్రామాణీకరిస్తుంది.
క్లయెంట్‌లో సెట్ చేయాల్సినవి కీని కలిగి ఉండే ప్రామాణీకరణ హెడర్ మరియు SDK యొక్క base URL అనే రెండు విలువలు. అనుమతించబడే హెడర్ ఫార్మాట్ మరియు base URL ప్రతి స్పెసిఫికేషన్‌కి భిన్నంగా ఉంటాయి.
సెటప్ పూర్తయిన తర్వాత మోడల్ జాబితాను పొందడం ద్వారా ప్రామాణీకరణను వెంటనే ధృవీకరించవచ్చు.
ప్రామాణీకరణ విఫలమైతే 401ను, ప్రామాణీకరణ విజయవంతమైన తర్వాత అనుమతి లేదా పరిమితి షరతులను నెరవేర్చకపోతే 403ను అందిస్తుంది.
కన్సోల్‌లోని API కీ స్క్రీన్‌ నుంచి API కీని జారీ చేయండి. అదే స్క్రీన్‌లో కీని రద్దు చేయడం మరియు దాని వినియోగ పరిధిని నిర్వహించవచ్చు.
ప్రామాణీకరణ హెడర్
రెండు స్పెసిఫికేషన్‌లలోనూ ఒక అభ్యర్థన హెడర్‌లో API కీని చేర్చాలి. X-API-Key హెడర్ లేదా Authorization హెడర్‌లో ఒకదాన్ని ఉపయోగించాలి. అనుమతించబడే ఫార్మాట్ స్పెసిఫికేషన్‌ను బట్టి మారుతుంది.
| హెడర్ | OpenAI అనుకూల | Anthropic అనుకూల |
|---|---|---|
| X-API-Key: <키> | అనుమతించబడుతుంది | అనుమతించబడుతుంది |
| Authorization: Bearer <키> | అనుమతించబడుతుంది | అనుమతించబడుతుంది |
| Authorization: <키> (Bearer లేకుండా) | తిరస్కరించబడుతుంది | అనుమతించబడుతుంది |
OpenAI అనుకూల మార్గంలో Authorization హెడర్‌ను ఉపయోగించినప్పుడు Bearer ప్రిఫిక్స్ అవసరం. ప్రిఫిక్స్ లేకుండా కీని మాత్రమే పంపితే గేట్‌వే అభ్యర్థనను తిరస్కరిస్తుంది.
హెడర్ పేర్లు పెద్దచిన్న అక్షరాలను వేరు చేయవు కాబట్టి Anthropic SDK పంపే x-api-key హెడర్ కూడా అలాగే పనిచేస్తుంది. రెండు హెడర్‌లను పేర్కొంటే 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తో అమలు చేస్తాయి. 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 వచ్చినప్పుడు, కింది క్రమంలో తనిఖీ చేయండి.
- API కీ స్క్రీన్‌లో కీ స్థితిని తనిఖీ చేయండి. అది గడువు ముగిసిన లేదా రద్దు చేయబడిన కీ అయితే, కొత్తదాన్ని జారీ చేయండి.
- హెడర్ పేరు X-API-Key లేదా Authorizationనా అని తనిఖీ చేయండి.
- OpenAI అనుకూల పాత్‌లో Authorization హెడర్‌ను ఉపయోగిస్తే, Bearer ప్రిఫిక్స్ ఉందో లేదో తనిఖీ చేయండి.
సవరించిన తర్వాత, ప్రమాణీకరణ నిర్ధారణ విభాగంలోని మోడల్‌ల జాబితా 조회ను మళ్లీ అమలు చేసి 200 వస్తుందో లేదో తనిఖీ చేయండి.
కలిపి ఉపయోగించే హెడర్‌లు
కింది హెడర్‌లన్నీ ఐచ్ఛికమైనవే. సమస్యలను ట్రాక్ చేయడానికి X-Request-Idను పేర్కొనాలని మేము సిఫార్సు చేస్తున్నాము.
| హెడర్ | వినియోగం | వదిలేస్తే |
|---|---|---|
| X-Request-Id | అభ్యర్థన ట్రాకింగ్ ఐడెంటిఫయర్. Anthropic అనుకూల మార్గం స్పందనలోని request-id హెడర్‌లో అదే విలువను తిరిగి అందిస్తుంది. | సర్వర్ జారీ చేస్తుంది. |
| X-Region-Code | కాల్ రీజియన్‌ను నిర్దేశిస్తుంది. | global. |
| X-Product-Sku (క్వెరీ product_sku ద్వారా కూడా నిర్దేశించవచ్చు) | బిల్లింగ్ కోసం ఉపయోగించే Product SKUని నేరుగా నిర్దేశిస్తుంది. హెడర్‌కు క్వెరీ కంటే ప్రాధాన్యత ఉంటుంది మరియు ఇది ప్రధానంగా వాయిస్·వాయిస్ మార్గాల్లో ఉపయోగించబడుతుంది. | వాయిస్ మార్గాల్లో దీనిని వదిలివేయలేరు. audio/speech మరియు audio/transcriptions అభ్యర్థన బాడీలోని model ద్వారా Productను ఎంచుకుంటాయి. |
| anthropic-version / anthropic-beta | Anthropic అనుకూల మార్గంలో యథాతథంగా పంపబడుతుంది. | వెర్షన్ 2023-06-01. |
5xx పదేపదే వస్తే, X-Request-Idతో పాటు సహాయ కేంద్రం మరియు సంప్రదింపు ద్వారా మాకు తెలియజేయండి. మీరు నేరుగా నిర్దేశించిన విలువ అయితే, దాన్ని క్లయింట్ రికార్డుతో వెంటనే సరిపోల్చవచ్చు.