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 ਪ੍ਰੀਫਿਕਸ ਦੀ ਜਾਂਚ ਕਰੋ।