Developer guide

API କୀ ଦ୍ୱାରା ପ୍ରମାଣୀକରଣ କରିବା

API କୀ ରଖିବାକୁ ଥିବା ହେଡର ଏବଂ SDKରେ ସେଟ୍ କରିବାକୁ ଥିବା base URL

CLEVI ଗେଟୱେ ଗୋଟିଏ API କୀ ଦ୍ୱାରା OpenAI ସଙ୍ଗତ ପଥ ଏବଂ Anthropic ସଙ୍ଗତ ପଥରେ ପ୍ରମାଣୀକରଣ କରେ।
କ୍ଲାଏଣ୍ଟରେ ସେଟ୍ କରିବାକୁ ଥିବା ଦୁଇଟି ମୂଲ୍ୟ ହେଉଛି କୀ ଧାରଣ କରୁଥିବା ପ୍ରମାଣୀକରଣ ହେଡର ଏବଂ 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 ସୁସଙ୍ଗତ ପଥରେ ଏହି ସମାନ ମୂଲ୍ୟକୁ ପ୍ରତିକ୍ରିୟାର 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

ପ୍ରମାଣୀକରଣ ଯାଞ୍ଚ

ପ୍ରମାଣୀକରଣ ବିଫଳ

ସହିତ ବ୍ୟବହାର କରାଯାଉଥିବା ହେଡର୍

ଭାଷା ଏବଂ ଅଞ୍ଚଳ

ସୁପାରିଶ କରାଯାଇଛି

ପୂର୍ବ ଏସିଆ

ଦକ୍ଷିଣପୂର୍ବ ଏସିଆ

ଦକ୍ଷିଣ ଏସିଆ

ମଧ୍ୟ ଏସିଆ

ମଧ୍ୟ ପ୍ରାଚ୍ୟ ଏବଂ କାକେସସ

ପଶ୍ଚିମ ୟୁରୋପ୍ ଓ ଦକ୍ଷିଣ ୟୁରୋପ୍

ଯୁକ୍ତରାଜ୍ୟ ଓ ଆୟରଲ୍ୟାଣ୍ଡ

ଉତ୍ତର ୟୁରୋପ୍

ମଧ୍ୟ ୟୁରୋପ ଏବଂ ବାଲକାନ

ପୂର୍ବ ୟୁରୋପ୍

ପୂର୍ବ ଆଫ୍ରିକା

ପଶ୍ଚିମ ଆଫ୍ରିକା ଓ ମଧ୍ୟ ଆଫ୍ରିକା

ଦକ୍ଷିଣସ୍ଥ ଆଫ୍ରିକା

ଆମେରିକା

ଓସିନିଆ