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-യിൽ /v1-ന് മുമ്പ് അവസാനിക്കുന്ന വിലാസമായി base_url വ്യക്തമാക്കുക.
പ്രാമാണീകരണത്തിന് 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 സഹിതം സഹായകേന്ദ്രത്തിലൂടെയോ ബന്ധപ്പെടൽ മാർഗത്തിലൂടെയോ ഞങ്ങളെ അറിയിക്കുക. നിങ്ങൾ നേരിട്ട് നിർ指定 ചെയ്ത മൂല്യമാണെങ്കിൽ, ക്ലയന്റ് രേഖകളുമായി ഉടൻ പൊരുത്തപ്പെടുത്താം.