Developer guide
خرابی کا کوڈ
اسٹیٹس کوڈ کے لحاظ سے کارروائی اور دوبارہ کوشش کے قواعد
اگر اپ اسٹریم 4xx·5xx واپس کرے تو گیٹ وے وہی کوڈ جوں کا توں آگے بھیجتا ہے، اور دیگر صورتوں میں ذیل کے جدول کے قواعد پر عمل کرتا ہے۔
400·401·403·404·413 ایسے کوڈ ہیں جن کے لیے درخواست یا ترتیبات درست کرنا ضروری ہے، جبکہ 409·429·5xx ایسے کوڈ ہیں جن میں کلائنٹ کے انتظار کے بعد وہی درخواست دوبارہ بھیجنی ہوتی ہے۔
خرابی کے متن کی شکل معیار کے لحاظ سے مختلف ہوتی ہے، اور Anthropic سے ہم آہنگ راستے میں error.type کا تعین اسٹیٹس کوڈ کے مطابق ہوتا ہے۔
403 کی وجہ error.message سے معلوم کی جاتی ہے، جبکہ حد اور استعمال کے اعداد کنسول اسکرین پر دیکھے جاتے ہیں۔
اسٹیٹس کوڈ
| کوڈ | مطلب | کارروائی |
|---|---|---|
| 400 | درخواست کی قدر غلط ہے۔ یہ اس وقت ہوتا ہے جب Anthropic مطابقت رکھنے والے ماڈلز کی فہرست میں limit، 1 سے 1000 کی حد سے باہر ہو، یا GET /responses/{responseId}?stream=true کے ذریعے محفوظ شدہ جواب کی اسٹریمنگ جاری رکھنے کی کوشش کی جائے۔ | قدر کو مقررہ حد کے اندر درست کریں۔ محفوظ شدہ جواب کو stream کے بغیر حاصل کریں۔ |
| 401 | کلید موجود نہیں، میعاد ختم ہو چکی ہے یا منسوخ شدہ ہے۔ | API کلید کے صفحے پر کلید کی حالت چیک کریں، اور ہیڈر کے نام اور Bearer سابقے کی جانچ کریں۔ |
| 403 | ماڈل تک رسائی کی اجازت نہیں ہے، استعمال کی حد سے تجاوز ہو گیا ہے، کریڈٹ ناکافی ہیں، یا آپ وائس کے مالک نہیں ہیں۔ | وجہ جاننے کے لیے error.message چیک کریں، اور اعداد و شمار نیچے دیے گئے حدود اور استعمال کی جانچ والے حصے کی اسکرین پر دیکھیں۔ |
| 404 | ماڈل موجود نہیں ہے یا اس کلید سے اس تک رسائی ممکن نہیں (ان ماڈلز سمیت جن کی سپورٹ ختم ہو چکی ہے)۔ یہ اس وقت بھی واپس کیا جاتا ہے جب کسی غیر موجود راستے کو کال کیا جائے یا 3 دن کی برقرار رکھنے کی مدت گزر جانے کے بعد CleviDrive کے آؤٹ پٹ کی درخواست کی جائے۔ | پہلے GET /models کے ذریعے کال کیے جا سکنے والے ماڈلز کی فہرست چیک کریں۔ راستے کا API کال کرنے کے صفحے کی جدول سے موازنہ کریں۔ |
| 408 · 409 · 413 | یہ اپ اسٹریم ٹائم آؤٹ، بھیڑ، یا درخواست کے حجم کی حد سے تجاوز ہے۔ صوتی اور وائس راستوں کے لیے وقت کی حد 5 منٹ اور درخواست کی زیادہ سے زیادہ حد 28 MiB ہے۔ | اگر 409 میں Retry-After موجود ہو تو اتنے وقت تک انتظار کرنے کے بعد وہی درخواست دوبارہ بھیجیں۔ 413 کی صورت میں درخواست کو تقسیم کر کے بھیجیں۔ |
| 429 | اپ اسٹریم فراہم کنندے نے رفتار کی حد لاگو کر دی ہے۔ | اگر Retry-After موجود ہو تو اتنے وقت تک انتظار کرنے کے بعد دوبارہ بھیجیں، اور اگر موجود نہ ہو تو ایکسپونینشل بیک آف کے ساتھ دوبارہ کوشش کریں۔ |
| 5xx | گیٹ وے یا اپ اسٹریم کی عارضی خرابی ہے (503 سمیت)۔ | ایکسپونینشل بیک آف کے ساتھ دوبارہ کوشش کریں۔ مسئلہ برقرار رہے تو ہم سے رابطہ کریں۔ |
402 واپس نہیں کیا جاتا۔ کریڈٹ کی کمی اور استعمال کی حد سے تجاوز، دونوں 403 کے طور پر واپس کیے جاتے ہیں۔
دوبارہ کوشش اور رابطہ
گیٹ وے اپنے طور پر 429 پیدا نہیں کرتا اور نہ ہی اپ اسٹریم کے جواب کو دوبارہ بھیجتا یا قطار میں رکھتا ہے۔ انتظار اور دوبارہ کوشش کلائنٹ انجام دیتا ہے۔
رابطہ کرتے وقت مدد اور رابطہ کے ذریعے X-Request-Id کے ساتھ اطلاع دیں۔ اگر X-Request-Id نہیں بھیجا گیا ہو تو سرور کی جانب سے جاری کردہ قدر Anthropic مطابقت رکھنے والے جواب کے request-id ہیڈر میں موجود ہے۔
خرابی کا متن
خرابی کے متن کی ساخت ہر معیار کے مطابق مختلف ہوتی ہے۔ اپ اسٹریم خرابیوں میں صرف پیغام رکھ کر انہیں مرتب کرکے منتقل کیا جاتا ہے، جبکہ اسٹیک یا اندرونی فیلڈز منتقل نہیں کیے جاتے۔
OpenAI سے مطابقت رکھنے والے راستے کے خرابی کے متن۔
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}Anthropic سے مطابقت رکھنے والے راستے کے خرابی کے متن۔ error.type کا تعین اسٹیٹس کوڈ کے مطابق درج ذیل جدول میں دکھائے گئے طریقے سے کیا جاتا ہے۔
{
"type": "error",
"error": {
"type": "authentication_error",
"message": "..."
},
"request_id": "rqid..."
}| اسٹیٹس کوڈ | error.type |
|---|---|
| 400 | invalid_request_error |
| 401 | authentication_error |
| 403 | permission_error |
| 404 | not_found_error |
| 413 | request_too_large |
| 429 | rate_limit_error |
| 529 | overloaded_error |
| دیگر کوڈز | api_error |
حدود اور استعمال کی جانچ
حد کی قدریں ہر ورک اسپیس کے لیے مختلف ہوتی ہیں۔ 403 کی وجہ error.message میں چیک کرنے کے بعد، درج ذیل اسکرین پر قدریں چیک کریں۔
| چیک کرنے کی چیز | کنسول اسکرین |
|---|---|
| ورک اسپیس پر لاگو حد | جائزہ میں مختص کردہ استعمال کی حد |
| پلان کی اجازت شدہ حد اور بیلنس | پلان اور کریڈٹس |
| اصل استعمال (ماڈل کے لحاظ سے اور کلید کے لحاظ سے کالز کی تعداد، متوقع طور پر منہا ہونے والے کریڈٹس) | استعمال |
| کلید کی حالت (آیا میعاد ختم ہو چکی ہے یا منسوخ کی گئی ہے) | API کلید |