इस प्रोजेक्ट के बारे में

यह रिपॉज़िटरी Octavus AI एजेंट्स के साथ एप्लिकेशन बनाने के लिए आधिकारिक JavaScript/TypeScript SDKs प्रदान करती है। इसे एक मोनोरेपो के रूप में व्यवस्थित किया गया है जिसमें कई npm पैकेज हैं, जिनमें से प्रत्येक एकीकरण सतह के एक अलग हिस्से को लक्षित करता है। पैकेजों में @octavus/core शामिल है जो क्लाइंट/सर्वर संचार में उपयोग किए जाने वाले साझा प्रकारों और उपयोगिताओं के लिए है, @octavus/server-sdk बैकएंड एकीकरण के लिए, @octavus/client-sdk एक फ्रेमवर्क-अज्ञेय क्लाइंट के रूप में, @octavus/react React hooks और बाइंडिंग्स के लिए, @octavus/cli एजेंट प्रबंधन के लिए, और @octavus/docs दस्तावेज़ीकरण सामग्री के लिए। सर्वर SDK एक API key के साथ OctavusClient बनाने, प्रारंभिक वेरिएबल्स के साथ एक एजेंट सेशन बनाने, कस्टम टूल हैंडलर्स के साथ उस सेशन से जुड़ने, और टेक्स्ट डेल्टा जैसे रिस्पॉन्स इवेंट्स को स्ट्रीम करते हुए एक नामित ट्रिगर को ट्रिगर करने का प्रदर्शन करता है। React पैकेज एक useOctavusChat hook को HTTP ट्रांसपोर्ट के साथ संयुक्त दिखाता है, जहाँ एक ट्रिगर अनुरोध बैकएंड एंडपॉइंट पर अग्रेषित किया जाता है और संदेश, स्थिति और एक send फ़ंक्शन UI को उजागर किए जाते हैं। दस्तावेज़ीकरण लिंक में getting started, server SDK, client SDK, protocol reference और API reference शामिल हैं। विकास के लिए Node.js 20+ और pnpm 10+ की आवश्यकता होती है, साथ में install, build, lint, type-check और format के लिए स्क्रिप्ट्स हैं। यह प्रोजेक्ट MIT लाइसेंस के अंतर्गत है और एक contributing guide के माध्यम से योगदान स्वीकार करता है।