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 ਹੈਡਰ ਵਰਤਦੀ ਹੈ।

Bash

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 ਸਮੇਤ ਪਤਾ ਦਰਜ ਕਰੋ।

Python

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 ਹੈਡਰ ਨੂੰ ਜਿਵੇਂ ਦਾ ਤਿਵੇਂ ਵਰਤੋ।

Python

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 ਹੁੰਦਾ ਹੈ।

JSON

{
  "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 ਅਨੁਕੂਲ ਮਾਰਗ response ਦੇ 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 ਸਮੇਤ ਸੂਚਿਤ ਕਰੋ। ਜੇ ਮੁੱਲ ਸਿੱਧੇ ਤੌਰ 'ਤੇ ਨਿਰਧਾਰਤ ਕੀਤਾ ਗਿਆ ਹੋਵੇ, ਤਾਂ ਇਸਦੀ ਕਲਾਇੰਟ ਰਿਕਾਰਡ ਨਾਲ ਤੁਰੰਤ ਤੁਲਨਾ ਕੀਤੀ ਜਾ ਸਕਦੀ ਹੈ।

API ਕੁੰਜੀ ਨਾਲ ਪ੍ਰਮਾਣਿਤ ਕਰਨਾ

ਪ੍ਰਮਾਣਿਕਤਾ ਹੈਡਰ

base URL

ਪ੍ਰਮਾਣਿਕਤਾ ਦੀ ਜਾਂਚ

ਪ੍ਰਮਾਣੀਕਰਨ ਅਸਫਲ

ਸਾਂਝੇ ਤੌਰ 'ਤੇ ਵਰਤੇ ਜਾਣ ਵਾਲੇ ਹੈਡਰ

ਭਾਸ਼ਾ ਅਤੇ ਖੇਤਰ

ਸਿਫ਼ਾਰਸ਼ ਕੀਤਾ

ਪੂਰਬੀ ਏਸ਼ੀਆ

ਦੱਖਣ-ਪੂਰਬੀ ਏਸ਼ੀਆ

ਦੱਖਣੀ ਏਸ਼ੀਆ

ਕੇਂਦਰੀ ਏਸ਼ੀਆ

ਮੱਧ ਪੂਰਬ ਅਤੇ ਕਾਕੇਸ਼ਸ

ਪੱਛਮੀ ਯੂਰਪ ਅਤੇ ਦੱਖਣੀ ਯੂਰਪ

ਯੂਨਾਈਟਡ ਕਿੰਗਡਮ ਅਤੇ ਆਇਰਲੈਂਡ

ਉੱਤਰੀ ਯੂਰਪ

ਮੱਧ ਯੂਰਪ ਅਤੇ ਬਾਲਕਨ

ਪੂਰਬੀ ਯੂਰਪ

ਪੂਰਬੀ ਅਫ਼ਰੀਕਾ

ਪੱਛਮੀ ਅਫ਼ਰੀਕਾ ਅਤੇ ਮੱਧ ਅਫ਼ਰੀਕਾ

ਦੱਖਣੀ ਅਫ਼ਰੀਕਾ

ਅਮਰੀਕਾ

ਓਸ਼ੇਨੀਆ