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 നേരിട്ട് വ്യക്തമാക്കുന്നു. ഹെഡറിന് ക്വറിയേക്കാൾ മുൻഗണനയുണ്ട്; ഇത് പ്രധാനമായും വോയ്സ് റൂട്ടുകളിൽ ഉപയോഗിക്കുന്നു. | വോയ്സ് റൂട്ടുകളിൽ ആവശ്യമാണ്. 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 പ്രിഫിക്സ് പരിശോധിക്കുക.
