EKB SDK क्या है?
EKB SDK एक TypeScript लाइब्रेरी है जो EKB की मूल सुविधाओं तक प्रोग्रामेटिक पहुँच प्रदान करती है:- ChatSDK: चैट प्रबंधन, संदेश हैंडलिंग और स्ट्रीमिंग प्रतिक्रियाओं के साथ संवादी AI इंटरफ़ेस बनाएँ।
- SmartTablesSDK: उन्नत क्वेरी, फ़िल्टरिंग और AI-संचालित डेटा प्रसंस्करण के साथ संरचित डेटा तालिकाएँ प्रबंधित करें।
- VoiceSDK: स्वचालित चैट एकीकरण और React hooks के साथ वॉयस वार्तालाप सक्षम करें।
इंस्टॉलेशन
त्वरित आरंभ
बुनियादी सेटअप
प्रमाणीकरण
SDK दो प्रमाणीकरण विधियों का समर्थन करता है:1. API Key प्रमाणीकरण (सर्वर-साइड के लिए अनुशंसित)
सर्वर-टू-सर्वर संचार और बाहरी एकीकरण के लिए API Keys का उपयोग करें:- अपने EKB डैशबोर्ड में My Account > API Keys पर जाएँ
- एक नई API Key pair बनाएँ
- API Key और API Secret कॉपी करें
- इन्हें सुरक्षित रूप से सहेजें (एनवायरनमेंट वेरिएबल्स का उपयोग करें, कभी भी version control में कमिट न करें)
2. Access Token प्रमाणीकरण (वेब ऐप्स के लिए)
मौजूदा उपयोगकर्ता सत्रों वाले क्लाइंट-साइड अनुप्रयोगों के लिए access tokens का उपयोग करें:SDK घटक
Chat SDK
व्यापक चैट प्रबंधन के साथ संवादी AI इंटरफ़ेस बनाएँ। प्रमुख विशेषताएँ:- चैट बनाएँ, सूचीबद्ध करें और प्रबंधित करें
- स्ट्रीमिंग समर्थन के साथ संदेश भेजें
- ज्ञान आधार एकीकरण
- फ़ाइल अपलोड (चित्र, दस्तावेज़)
- उपयोगकर्ता प्रतिक्रिया (पसंद/नापसंद)
- कस्टम एजेंट्स और मॉडल्स
Smart Tables SDK
उन्नत क्वेरी और AI-संचालित प्रसंस्करण के साथ संरचित डेटा प्रबंधित करें। प्रमुख विशेषताएँ:- डेटा तालिकाएँ बनाएँ और प्रबंधित करें
- उन्नत फ़िल्टरिंग और सॉर्टिंग
- डेटा आयात/निर्यात (CSV, Excel)
- AI-संचालित कॉलम गणना
- कस्टम दृश्य और कॉलम प्रबंधन
- पेजिनेशन और खोज
Voice SDK
स्वचालित चैट एकीकरण के साथ वॉयस वार्तालाप सक्षम करें। प्रमुख विशेषताएँ:- वास्तविक समय वॉयस वार्तालाप
- स्वचालित ट्रांसक्रिप्शन
- आसान एकीकरण के लिए React hooks
- ऑडियो विज़ुअलाइज़ेशन
- सत्र प्रबंधन
- चैट एकीकरण
सामान्य उपयोग मामले
1. ग्राहक सहायता चैटबॉट
2. डेटा प्रबंधन अनुप्रयोग
3. वॉयस-सक्षम अनुप्रयोग
एनवायरनमेंट वेरिएबल्स
प्रोडक्शन अनुप्रयोगों के लिए, हमेशा एनवायरनमेंट वेरिएबल्स का उपयोग करें:त्रुटि हैंडलिंग
सभी SDK विधियाँ त्रुटियाँ फेंकती हैं जिन्हें पकड़ा और हैंडल किया जाना चाहिए:TypeScript समर्थन
SDK TypeScript में लिखा गया है और पूर्ण प्रकार परिभाषाएँ प्रदान करता है:React एकीकरण
SDK में आसान एकीकरण के लिए React hooks शामिल हैं:सर्वोत्तम प्रथाएँ
1. एनवायरनमेंट वेरिएबल्स का उपयोग करें
अपने कोड में कभी भी API keys या secrets को हार्डकोड न करें। हमेशा एनवायरनमेंट वेरिएबल्स का उपयोग करें।2. त्रुटियों को विनम्रतापूर्वक हैंडल करें
हमेशा SDK कॉल्स को try-catch ब्लॉक्स में रैप करें और उपयोगकर्ताओं को सार्थक त्रुटि संदेश प्रदान करें।3. SDK इंस्टेंसेस का पुन: उपयोग करें
SDK इंस्टेंसेस को एक बार बनाएँ और प्रत्येक ऑपरेशन के लिए नए इंस्टेंस बनाने के बजाय उनका पुन: उपयोग करें।4. बेहतर UX के लिए स्ट्रीमिंग का उपयोग करें
चैट अनुप्रयोगों के लिए, वास्तविक समय प्रतिक्रिया के लिए स्ट्रीमिंग प्रतिक्रियाओं का उपयोग करें:5. पेजिनेशन लागू करें
चैट्स की सूची बनाते समय या तालिकाओं को क्वेरी करते समय, हमेशा पेजिनेशन लागू करें:सहायता प्राप्त करें
- दस्तावेज़: प्रत्येक SDK घटक के लिए विस्तृत दस्तावेज़ ब्राउज़ करें।
- सहायता: तकनीकी सहायता के लिए सहायता को ईमेल करें।
- उदाहरण: पूर्ण कार्यशील उदाहरणों के लिए SDK रिपॉज़िटरी देखें।