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-ৰ বাবে base_urlক /v1ৰ আগত শেষ হোৱা ঠিকনা হিচাপে নিৰ্ধাৰণ কৰক।
প্ৰমাণীকৰণৰ বাবে 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-সামঞ্জস্যপূৰ্ণ পথত কি নোহোৱাকৈ কল কৰিলে তলৰ body ঘূৰাই দিয়ে, আৰু 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-ৰ সৈতে জনাওক। পোনপটীয়াকৈ নিৰ্ধাৰণ কৰা মান হ'লে ক্লায়েণ্টৰ ৰেকৰ্ডৰ সৈতে তৎক্ষণাত মিলাব পাৰি।