منصوبے کے بارے میں

یہ ریپوزٹری Octavus AI ایجنٹس کے ساتھ ایپلیکیشنز بنانے کے لیے سرکاری JavaScript/TypeScript SDKs فراہم کرتی ہے۔ یہ ایک monorepo کے طور پر منظم ہے جس میں کئی npm پیکجز شامل ہیں، جن میں سے ہر ایک انٹیگریشن سطح کے مختلف حصے کو نشانہ بناتا ہے۔ پیکجز میں @octavus/core شامل ہے جو کلائنٹ/سرور مواصلات میں استعمال ہونے والی مشترکہ اقسام اور یوٹیلیٹیز کے لیے ہے، @octavus/server-sdk بیک اینڈ انٹیگریشن کے لیے، @octavus/client-sdk فریم ورک سے آزاد کلائنٹ کے طور پر، @octavus/react React hooks اور بائنڈنگز کے لیے، @octavus/cli ایجنٹ مینجمنٹ کے لیے، اور @octavus/docs دستاویزات کے مواد کے لیے۔ سرور SDK میں API key کے ساتھ OctavusClient بنانا، ابتدائی متغیرات کے ساتھ ایجنٹ سیشن بنانا، حسب ضرورت tool handlers کے ساتھ اس سیشن سے منسلک ہونا، اور text deltas جیسے رسپانس ایونٹس کو اسٹریم کرتے ہوئے ایک نامزد trigger کو متحرک کرنا دکھایا گیا ہے۔ React پیکج ایک useOctavusChat hook کو HTTP transport کے ساتھ ملا کر دکھاتا ہے، جہاں ایک trigger درخواست بیک اینڈ endpoint کو بھیجی جاتی ہے اور messages، status اور ایک 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 کے ذریعے تعاون قبول کرتا ہے۔