JSON Schema for tools

JSON Schema और Tool Function के लिए अध्ययन नोट्स

• JSON Schema का उद्देश्य:
• यह एक टूल फंक्शन (Tool Function) को परिभाषित करने और यह बताने के लिए उपयोग किया जाता है कि फंक्शन को कौन से तर्क (arguments) प्राप्त होने चाहिए।
• यह LLM (जैसे Claude) को यह समझने में मदद करता है कि उसे लिखे गए फंक्शन का उपयोग कैसे करना है।
• यह केवल LLMs के लिए नहीं है; यह डेटा वैलिडेशन (Data Validation) के लिए एक सामान्य तकनीक है।

• JSON Schema बनाने की प्रक्रिया (4 चरण):
• डिक्शनरी बनाना: फंक्शन के सभी कीवर्ड आर्गुमेंट्स (keyword arguments) और उनके लिए नमूना डेटा (sample data) के साथ एक डिक्शनरी तैयार करें।
• JSON में रूपांतरण: इस डिक्शनरी को JSON फॉर्मेट में बदलें। (ध्यान दें: Python में True को JSON में छोटे अक्षरों में true लिखा जाता है)।
• Schema जनरेट करना: "JSON to JSON Schema converter" जैसे ऑनलाइन टूल का उपयोग करें। यह टूल आपके JSON डेटा से स्वचालित रूप से JSON Schema बना देगा।
• विवरण (Description) जोड़ना:
• प्रत्येक प्रॉपर्टी (property) या आर्गुमेंट के लिए विस्तृत विवरण जोड़ें।
• टूल के समग्र विवरण (overall description) में बताएं कि टूल क्या करता है, इसे कब उपयोग करना चाहिए, और यह किस प्रकार का डेटा लौटाता है (3 से 4 वाक्यों में)।

• सर्वोत्तम अभ्यास (Best Practices):
• विवरण की गुणवत्ता: आर्गुमेंट और टूल दोनों के विवरण बहुत विस्तृत और स्पष्ट होने चाहिए।
• सहायता: यदि आप स्वयं विवरण नहीं लिख पा रहे हैं, तो आप अपने फंक्शन कोड को सीधे Claude को देकर उससे विवरण लिखने के लिए कह सकते हैं।

• अगला कदम:
• JSON Schema तैयार होने के बाद, इसे Claude को कॉल करते समय शामिल करें ताकि Claude को पता चले कि यह टूल उपलब्ध है।

Takeaways

• JSON Schema का मुख्य उद्देश्य LLM को टूल फंक्शन के तर्क (arguments) परिभाषित करना और डेटा वैलिडेशन सुनिश्चित करना है।
• JSON Schema बनाने के लिए, पहले कीवर्ड आर्गुमेंट्स के साथ डिक्शनरी तैयार करें, उसे JSON में बदलें, और फिर एक कन्वर्टर का उपयोग करके Schema जनरेट करें।
• टूल और उसके प्रत्येक आर्गुमेंट के लिए विस्तृत और स्पष्ट विवरण (descriptions) देना सर्वोत्तम अभ्यास है ताकि LLM सही ढंग से कार्य कर सके।
• JSON Schema तैयार होने के बाद, इसे LLM (जैसे Claude) को टूल कॉल करते समय प्रदान करना अनिवार्य है।