“JSON میں جواب دو” کہنے والا پرامپٹ شکل کو قسمت پر چھوڑ دیتا ہے۔ JSON Schema وہ شکل لکھ کر رکھتا ہے تاکہ مشین اسے جانچ سکے۔
یہ کیسے کام کرتا ہے
اسپیسیفیکیشن کے دو بنیادی حصے ہیں: Core، جو “defines the basic foundation of JSON Schema” (ترجمہ: JSON Schema کی بنیاد طے کرتا ہے)، اور Validation، جو “defines the validation keywords” (ترجمہ: ویلیڈیشن keywords طے کرتا ہے)۔ موجودہ ورژن 2020-12 ہے؛ اس سے پہلے والا 2019-09 تھا۔
{
"type": "object",
"properties": {
"name": {"type": "string"},
"amount": {"type": "number", "minimum": 0},
"currency": {"type": "string", "enum": ["SAR", "AED", "USD"]},
"note": {"type": ["string", "null"]}
},
"required": ["name", "amount", "currency", "note"],
"additionalProperties": false
}
LLM APIs اسکیما کو دو جگہ استعمال کرتے ہیں۔ ٹول ڈیفینیشنز میں آرگیومنٹس بیان کرنے کے لیے ایک اسکیما parameters میں جاتا ہے۔ اسٹرکچرڈ آؤٹ پٹ ایک اسکیما response_format میں {"type": "json_schema", "json_schema": {...}} کی صورت میں بھیجتا ہے، جس کے بارے میں OpenAI کہتا ہے کہ یہ “ensures the model will match your supplied JSON schema” (ترجمہ: یقینی بناتا ہے کہ ماڈل آپ کے دیے گئے JSON اسکیما سے میل کھائے گا)۔
OpenAI کا strict موڈ صرف ایک حصہ قبول کرتا ہے۔ اس کے سپورٹ شدہ اسکیما والے حصے سے:
- ٹائپس: string، number، boolean، integer، object، array، enum اور anyOf۔
- روٹ ایک آبجیکٹ ہونا چاہیے اور اس میں
anyOfاستعمال نہیں ہو سکتا۔ additionalProperties: falseاور ہر فیلڈrequiredمیں درج؛ کسی فیلڈ کو اختیاری بنانا ہو توnullکی اجازت دیں، جیسے اوپرnoteمیں۔- زیادہ سے زیادہ 5000 آبجیکٹ پراپرٹیز اور نیسٹنگ کے 10 درجے، اور مجموعی طور پر 1000 تک enum قدریں۔
- سپورٹ نہیں:
allOf،not،dependentRequired،dependentSchemas،if،then،else۔
یہ کیوں اہم ہے
- ویلیڈیشن۔ جو اسکیما ماڈل کی رہنمائی کرتا ہے، وہی آپ کے کوڈ میں اس کے جواب کو جانچتا ہے۔ جانچ ناکام ہو تو آپ کے پاس واپس بھیجنے کے لیے عین ایرر ہوتا ہے۔
- پورٹیبلٹی۔ strict والے حصے میں لکھا اسکیما، ہر keyword استعمال کرنے والے اسکیما سے زیادہ فراہم کنندگان پر چلتا ہے۔
- ٹوکن۔ ٹول ڈیفینیشنز کے اسکیما ہر درخواست میں ان پٹ کے طور پر بھیجے جاتے ہیں۔ لمبی descriptions ہر ٹرن میں ٹوکن خرچ کرتی ہیں۔
BroadNet Inference پر
BroadNet کا API ریفرنس GLM 5.3 اور Qwen3.8 27B کے لیے ٹول کالنگ اور اسٹرکچرڈ آؤٹ پٹ دستاویز کرتا ہے، لیکن یہ نہیں کہ کون سے اسکیما keywords لاگو ہوتے ہیں۔ اسکیما کو اوپر بتائے گئے سادہ حصے تک رکھیں اور ہر جواب ویلیڈیٹ کریں۔ JSON Schema جنریٹر سے اسکیما بنائیں، LLM JSON آؤٹ پٹ ویلیڈیٹر سے جوابات جانچیں، اور مکمل مثال کے لیے اسٹرکچرڈ آؤٹ پٹ والی پوسٹ دیکھیں۔ دوسرے ماڈلز پر پرامپٹ میں JSON مانگیں اور جواب ویلیڈیٹ کریں؛ JSON موڈ BroadNet پر دستاویز شدہ نہیں، اس لیے بھروسا کرنے سے پہلے جانچ لیں۔
عام غلطیاں
allOfیا شرطیہ keywords استعمال کرنا اور فرض کر لینا کہ سرور انہیں لاگو کرتا ہے۔- strict موڈ میں فیلڈز کو
requiredسے نکال کر اختیاری بنانا،nullکی اجازت دینے کے بجائے۔