ai-plugin.json जेनरेटर

अपने API को AI एजेंटों के सामने उजागर करना

`ai-plugin.json` मैनिफेस्ट आपके API और AI सहायकों के बढ़ते पारिस्थितिकी तंत्र के बीच एक मूलभूत अनुबंध के रूप में कार्य करता है। अनुमानित `/.well-known/ai-plugin.json` पाथ पर होस्ट की गई यह JSON फ़ाइल केवल मेटाडेटा नहीं है; यह एक महत्वपूर्ण प्रवेश द्वार है। हमारा जेनरेटर सुनिश्चित करता है कि आपका मैनिफेस्ट OpenAPI Specification (OAS) संदर्भ का सख्ती से पालन करता है, जिससे GPT-4 और Google के Gemini जैसे मॉडल आपके फ़ंक्शन को सटीक रूप से समझ सकें और इनवोक कर सकें। सहज एकीकरण के लिए उचित जेनरेशन अत्यंत महत्वपूर्ण है, जो `invalid_manifest` त्रुटियों को रोकता है और विश्वसनीय टूल कॉल सुनिश्चित करता है।

महत्वपूर्ण `description_for_model` का निर्माण

`ai-plugin.json` के भीतर `description_for_model` फ़ील्ड AI-संचालित टूल के उपयोग के लिए सबसे प्रभावशाली है। यह संक्षिप्त स्ट्रिंग (आमतौर पर 200 वर्णों से कम) LLM को यह तय करने के लिए प्रॉम्प्ट-इंजीनियर्ड संदर्भ प्रदान करती है कि आपके API को कब और कैसे कॉल करना है। हमारा जेनरेटर आपको सटीक, कार्य-उन्मुख विवरण बनाने में मार्गदर्शन करता है, जैसे "किसी दिए गए टिकर सिंबल के लिए वास्तविक समय स्टॉक मूल्य प्राप्त करने के लिए इस प्लगइन का उपयोग करें" बजाय अस्पष्ट सामान्यताओं के। यह विशिष्टता LLM की आपके टूल को इनवोक करने की प्रवृत्ति को सीधे प्रभावित करती है।

प्रमाणीकरण और OpenAPI URL कॉन्फ़िगरेशन

आपके API को AI एजेंटों के सामने सुरक्षित रूप से उजागर करने के लिए सावधानीपूर्वक प्रमाणीकरण कॉन्फ़िगरेशन की आवश्यकता होती है। `ai-plugin.json` विभिन्न `auth` प्रकारों का समर्थन करता है, जिनमें `none`, `oauth` (OAuth 2.0 Client Credentials Grant), और `service_http` (बेयरर टोकन या बेसिक auth) शामिल हैं। हमारा जेनरेटर इन्हें चुनने और कॉन्फ़िगर करने में सुविधा प्रदान करता है, यह सुनिश्चित करता है कि आपके एंडपॉइंट्स सुरक्षित रहें और अधिकृत एजेंटों के लिए सुलभ हों। साथ ही, यह `api.url` एंट्री को मान्य करता है, यह पुष्टि करता है कि यह एक लाइव, खोजने योग्य OpenAPI/Swagger स्पेसिफिकेशन (जैसे, `https://api.example.com/openapi.yaml`) की ओर इशारा करता है, जो मॉडल की समझ के लिए आवश्यक है।

क्यों `/.well-known/` पाथ महत्वपूर्ण है

`ai-plugin.json` का `/.well-known/` पाथ पर स्थान मनमाना नहीं है; यह होस्ट-मेटा खोज के लिए RFC 8615 द्वारा परिभाषित एक मानक है। यह अनुमानित स्थान AI एजेंट क्रॉलर (जैसे `ChatGPT-User` या `Google-Extended`) को बिना स्पष्ट कॉन्फ़िगरेशन के आपके मैनिफेस्ट को कुशलतापूर्वक खोजने और पुनः प्राप्त करने की अनुमति देता है। यह मानकीकृत खोज तंत्र एजेंटों के लिए विलंबता और ओवरहेड को कम करता है, जिससे आपका API इस निर्दिष्ट और व्यापक रूप से अपनाए गए URI पर टूल खोजने के लिए डिज़ाइन किए गए किसी भी AI सिस्टम के लिए तुरंत उपलब्ध हो जाता है।

सामान्य ai-plugin.json जेनरेशन की कमियां

आपके ai-plugin.json के लिए मुख्य विचार

• सुनिश्चित करें कि `name_for_model` एक संक्षिप्त, अद्वितीय पहचानकर्ता है (जैसे, `stock_price_api`)।
• सत्यापित करें कि `description_for_model` LLM व्याख्या के लिए स्पष्ट, संक्षिप्त और कार्य-उन्मुख है।
• पुष्टि करें कि आपका `api.url` सार्वजनिक रूप से सुलभ, वैध OpenAPI 3.0 या 3.1 स्पेसिफिकेशन की ओर इंगित करता है।
• उपयुक्त `auth` कॉन्फ़िगरेशन लागू करें (उदाहरण के लिए, बेयरर टोकन के लिए `service_http`)।
• `ai-plugin.json` फ़ाइल को विशेष रूप से `/.well-known/ai-plugin.json` पाथ पर डिप्लॉय करें।
• अनुपालन और समर्थन के लिए `legal_info_url` और `contact_email` की समीक्षा करें।
• स्कीमा पालन के लिए टूल का उपयोग करके अपने जेनरेटेड मैनिफेस्ट को नियमित रूप से मान्य करें।
• पूर्ण डिप्लॉयमेंट से पहले एक वास्तविक AI एजेंट (जैसे, ChatGPT Plugins) के साथ API कॉल का परीक्षण करें।

अपने AI प्लगइन मैनिफेस्ट को डिप्लॉय करने के चरण

1. 1
   मुख्य API कार्यक्षमता को परिभाषित करें

   स्पष्ट रूप से उन विशिष्ट कार्यों को व्यक्त करें जिन्हें आपका API सक्षम करता है। प्रमुख एंडपॉइंट्स, पैरामीटर और अपेक्षित प्रतिक्रियाओं की पहचान करें। यह स्पष्टता सीधे `description_for_model` और OpenAPI स्पेसिफिकेशन को सूचित करेगी। इस पर ध्यान केंद्रित करें कि AI एजेंट आपके API के साथ क्या *कर सकते हैं*, न कि केवल यह क्या *है*।

2. 2
   OpenAPI स्पेसिफिकेशन जेनरेट करें

   अपने API के लिए एक व्यापक OpenAPI (OAS 3.0/3.1) परिभाषा बनाएं। यह स्पेसिफिकेशन सभी एंडपॉइंट्स, विधियों, पैरामीटर और डेटा मॉडल का विवरण देता है। सुनिश्चित करें कि यह सटीक और अद्यतित है, क्योंकि AI एजेंट आपके API की क्षमताओं और अनुरोधों को कैसे संरचित करें, यह समझने के लिए इस दस्तावेज़ को पार्स करेंगे।

3. 3
   मैनिफेस्ट विवरण कॉन्फ़िगर करें

   अपने `name_for_model`, `description_for_model`, `auth` प्रकार (उदाहरण के लिए, API कुंजियों के लिए `service_http`), `logo_url`, `legal_info_url`, और `contact_email` इनपुट करने के लिए जेनरेटर का उपयोग करें। प्लगइन की इष्टतम LLM समझ और इनवोकेशन के लिए `description_for_model` तैयार करने पर पूरा ध्यान दें।

4. 4
   जेनरेटेड JSON को मान्य करें

   डिप्लॉयमेंट से पहले, आउटपुट `ai-plugin.json` को आधिकारिक स्कीमा के विरुद्ध सावधानीपूर्वक मान्य करें। सिंटैक्स त्रुटियों, अनुपलब्ध फ़ील्ड्स और सही URL प्रारूपों की जांच करें। सुनिश्चित करें कि `api.url` आपके होस्टेड OpenAPI स्पेसिफिकेशन की ओर सटीक रूप से इंगित करता है ताकि `ChatGPT-User` जैसे AI एजेंटों द्वारा खोज संबंधी समस्याओं को रोका जा सके।

5. 5
   मैनिफेस्ट को `/.well-known/` पर डिप्लॉय करें

   जेनरेटेड `ai-plugin.json` फ़ाइल को `YOUR_DOMAIN/.well-known/ai-plugin.json` पर होस्ट करें। यह मानक पाथ AI एजेंट क्रॉलर्स के लिए आपके प्लगइन को पूर्व ज्ञान के बिना स्वचालित रूप से खोजने के लिए महत्वपूर्ण है। गलत स्थान आपके प्लगइन को अधिकांश AI सिस्टम द्वारा अज्ञात बना देगा।

6. 6
   मॉनिटर करें और पुनरावृत्ति करें

   डिप्लॉयमेंट के बाद, अपने API उपयोग और एजेंट इंटरेक्शन लॉग की निगरानी करें। इस बात पर ध्यान दें कि आपका प्लगइन कितनी बार इनवोक किया जाता है और क्या कोई पार्सिंग त्रुटियां हैं। इष्टतम प्रदर्शन और विश्वसनीय AI एजेंट एकीकरण सुनिश्चित करने के लिए अपने `description_for_model` और OpenAPI स्पेसिफिकेशन को परिष्कृत करने के लिए इस फीडबैक का उपयोग करें।