API કી વડે પ્રમાણિત કરવું

આ પેજ CLEVI ગેટવે પર API કી વડે પ્રમાણિત કરવાની રીત સમજાવે છે.
OpenAI-સુસંગત પાથ અને Anthropic-સુસંગત પાથ બંનેમાં એક જ કી વડે પ્રમાણિત કરવામાં આવે છે,
પરંતુ કી મૂકવાના હેડરની માન્ય શ્રેણી અને SDK માં સેટ કરવાનું base URL દરેક સ્પષ્ટીકરણ મુજબ અલગ છે.

પ્રમાણીકરણ હેડર

બંને સુસંગત સ્પષ્ટીકરણોમાં એક જ API કી વડે પ્રમાણિત કરવામાં આવે છે. કી કન્સોલની API કી સ્ક્રીન પરથી જારી કરવામાં આવે છે અને તે જ સ્ક્રીન પરથી રદ કરવી તથા ઉપયોગની શ્રેણીનું સંચાલન કરી શકાય છે.

હેડરના નામમાં મોટા-નાના અક્ષરોનો ભેદ રાખવામાં આવતો નથી. Anthropic SDK દ્વારા મોકલાતું x-api-key પણ એ જ રીતે કાર્ય કરે છે.

base URL

તમે ઉપયોગ કરતા SDK માં માત્ર base URL ને નીચેના સરનામા પર બદલો, તો તે એ જ રીતે કાર્ય કરશે. બંને સરનામાંમાં /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 ઉમેરેલું રાખવું વધુ સારું છે.

પ્રમાણીકરણ નિષ્ફળ

જો કી ન હોય અથવા સમાપ્ત થયેલી·રદ કરાયેલી કી મોકલવામાં આવે, તો 401 મળે છે. OpenAI-સુસંગત માર્ગમાં કી વિના કૉલ કરવામાં આવે તો નીચેનું બૉડી મળે છે, અને Anthropic-સુસંગત માર્ગના error.type તરીકે authentication_error હોય છે.

{
  "error": {
    "message": "API key is required.",
    "type": "invalid_request_error"
  }
}

1. API કી સ્ક્રીન પર કીની સ્થિતિ તપાસો. જો કી સમાપ્ત થયેલી·રદ કરાયેલી હોય, તો નવી કી જારી કરો.
2. હેડરનું નામ X-API-Key અથવા Authorization છે કે નહીં તે તપાસો.
3. OpenAI-સુસંગત માર્ગમાં Authorization નો ઉપયોગ કરતા હો, તો Bearer ઉપસર્ગ તપાસો.