SDK लोड करें
<script src="/sdk/nebo.global.js"></script>
<script>
const { nebo, identity, storage, agents, janus, decide, chat, surfaces } = NeboAppSDK;
</script> ग्लोबल NeboAppSDK है; कोई nebo ग्लोबल नहीं है। NeboAppSDK.nebo SDK इंस्टेंस है, और हर मॉड्यूल टॉप लेवल पर भी एक्सपोर्ट होता है, इसलिए NeboAppSDK.storage और NeboAppSDK.nebo.storage एक ही ऑब्जेक्ट हैं। ब्राउज़र के नामों से टकराव से बचने के लिए, nebo.fetch को neboFetch के रूप में और nebo.WebSocket को NeboWebSocket के रूप में एक्सपोर्ट किया जाता है।
identity
| कॉल | लौटाता है |
|---|---|
identity.get() | ऐप के कर्मचारी के लिए {id, name, displayName, description, persona, model, skills, inputValues}। कैश किया जाता है। |
identity.invalidate() | कैश साफ़ करता है। |
storage
ऐप के लिए एक की-वैल्यू स्टोर। इसके लिए storage:readwrite ज़रूरी है। यह वही स्टोर है जिसे ऐप का कर्मचारी पढ़ता और बदलता है: मालिक कर्मचारी से बात करके जो रिकॉर्ड जोड़ता है वह पेज पर दिखता है, और पेज में टाइप किया गया रिकॉर्ड कर्मचारी को मिल जाता है।
const deals = (await NeboAppSDK.storage.getItem('deals')) ?? [];
deals.push({ name: 'Example renewal', closes: '2026-10-31' });
await NeboAppSDK.storage.setItem('deals', deals); | कॉल | व्यवहार |
|---|---|
storage.getItem(key) | ठीक वही जो setItem ने सहेजा था (ऑब्जेक्ट, सूची, संख्या या स्ट्रिंग), या null। |
storage.setItem(key, value) | कोई भी JSON मान सहेजता है। |
storage.removeItem(key) | एक कुंजी हटाता है; वह फिर keys() में नहीं दिखती। |
storage.keys() | सभी कुंजियाँ। |
storage.clear() | हर कुंजी हटाता है। |
storage.onChange(handler) | हर राइट के बाद handler({appId, keys, action, source}) कॉल करता है, चाहे राइट कर्मचारी ने किया हो (source: "employee") या ऐप की किसी खुली विंडो ने, इसी विंडो समेत (source: "page")। एक फ़ंक्शन लौटाता है जो सुनना बंद कर देता है। |
डेटा बदलने पर फिर से ड्रॉ करें, चाहे उसे किसी ने भी बदला हो:
async function load() {
render((await NeboAppSDK.storage.getItem('deals')) ?? []);
}
load();
const stop = NeboAppSDK.storage.onChange((change) => {
// { appId, keys: ['deals'], action: 'set' | 'delete', source: 'employee' | 'page' }
if (change.keys.includes('deals')) load();
}); इस स्टोर तक सिर्फ़ ऐप का अपना कर्मचारी पहुँचता है, और वह भी सिर्फ़ अपने ऐप के लिए; दूसरा कर्मचारी ऐप के कर्मचारी से पूछता है। ऐसी कुंजियाँ चुनें जिन्हें दोनों तरफ़ ढूँढा जा सके (एक कुंजी जिसमें सूची हो, या deal:42 जैसे प्रीफ़िक्स के तहत हर रिकॉर्ड के लिए एक कुंजी) और कर्मचारी के निर्देशों में उनका वर्णन करें। जो स्ट्रिंग खुद में मान्य JSON हो, जैसे "42", वह पार्स होकर लौटती है, इसलिए अगर टाइप मायने रखता है तो उसे किसी ऑब्जेक्ट में लपेटें। हर मान को 2 MB से काफ़ी कम रखें; राइट अस्वीकार होने पर setItem कोई त्रुटि नहीं फेंकता।
agents
ऐप के कर्मचारी से, या किसी दूसरे कर्मचारी से पूछें और उसका जवाब पाएँ। किसी दूसरे कर्मचारी से पूछने के लिए subagent:<employee-id> ज़रूरी है।
const { text } = await NeboAppSDK.agents.invoke('Which open deals close this month?');
for await (const part of NeboAppSDK.agents.stream('Summarize the pipeline.')) {
output.textContent += part.text;
} | कॉल | लौटाता है |
|---|---|
agents.invoke(message, {agent, data}) | कर्मचारी के काम पूरा करने पर {text, tools}। |
agents.stream(message, {agent, data}) | {text, done} का एक async iterator। |
janus
बिना व्यक्तित्व, मेमोरी या टूल के सीधा मॉडल कॉल।
| कॉल | लौटाता है |
|---|---|
janus.complete({messages, model, temperature, max_tokens, system}) | स्ट्रिंग के रूप में जवाब का टेक्स्ट। |
janus.stream(same) | टेक्स्ट के हिस्सों का एक async iterator। |
decide
टाइप वाले फ़ैसले: किसी डेटा के बारे में नामित सवाल पूछें और हर जवाब संभावनाओं और भरोसे के स्तर के साथ, एक ही तेज़ कॉल में पाएँ। कुछ भी टेक्स्ट के रूप में नहीं लिखा जाता, इसलिए इसे आकलन के लिए इस्तेमाल करें (क्या यह लीड गर्म है, यह टिकट किस श्रेणी का है, यह कितना ज़रूरी है) और गिनती, तारीखें और सीमाएँ अपने कोड में रखें। ऐप का कर्मचारी अपने decide टूल से यही सवाल पूछ सकता है, जैसे ऐप के सहेजे गए रिकॉर्ड पर।
const { answers } = await NeboAppSDK.decide({
state: { company: 'Example Co', status: 'asked for a quote today' },
questions: {
tier: {
type: 'choice',
instructions: 'How warm is this lead, judging by `status`?',
criteria: { hot: 'ready to buy', warm: 'interested', cold: 'not now', other: "can't tell" }
},
fit: {
type: 'score',
instructions: 'How well does `company` fit our customers?',
criteria: ['poor', 'fair', 'good', 'great']
},
reply: { type: 'noul', instructions: '`status` asks us for a reply.' }
}
});
if (answers.tier.choice === 'hot' && answers.tier.confidence > 0.8) flag(lead);
// answers.fit.score is fractional: 0 is "poor", 1.5 is between "fair" and "good".
// answers.reply.noul is the probability the statement holds, from 0 to 1. | सवाल का टाइप | criteria | जवाब |
|---|---|---|
choice | 2 से 255 नामित विकल्पों का एक ऑब्जेक्ट, {option: description}। जब सूची पूरी न हो, तो other जैसा एक बचाव विकल्प जोड़ें। | choice (चुना गया विकल्प), confidence (0 से 1) और हर विकल्प के लिए probabilities। |
score | 2 से 10 क्रमबद्ध स्तरों की सूची, सबसे निचला पहले। | score (भिन्नात्मक, 0 पहला स्तर है), confidence और हर स्तर के लिए probabilities। |
noul | कोई नहीं: सवाल एक ही कथन है जिसे आँकना है। | noul, यानी कथन के सही होने की संभावना। अलग से कोई भरोसे का स्तर नहीं। |
decide({state, questions})का नतीजा{model, answers, usage}होता है, जिसमें हर जवाब उसी नाम के तहत होता है जो आपने उसके सवाल को दिया था।stateटेक्स्ट या कोई भी JSON है। इसमें सिर्फ़ वे फ़ील्ड रखें जिनकी सवालों को ज़रूरत है औरinstructionsके अंदर उन फ़ील्ड के नाम बैकटिक में लिखें। पूरा सवालinstructionsमें रहता है; सवाल का नाम बस जवाब का लेबल होता है। बहुत लंबी state भेजे जाने से पहले बीच से छोटी कर दी जाती है।- यह एक एरर देता है जिसका संदेश ही कारण होता है। एरर में कोई स्टेटस कोड नहीं होता, इसलिए अगर आपको मामलों में फ़र्क करना है तो संदेश की तुलना करें:
- गलत बना हुआ सवाल, जैसे सिर्फ़ एक विकल्प वाला choice (बॉट 400 से जवाब देता है, साथ में बताता है कि क्या गलत है)।
- मालिक के अकाउंट में कोई काम बाकी नहीं: "आपने अपने अकाउंट में शामिल सारा काम इस्तेमाल कर लिया है। जारी रखने के लिए कोई प्लान चुनें या क्रेडिट जोड़ें।" (429)। जब तक मालिक प्लान या क्रेडिट नहीं जोड़ता, दोबारा कोशिश करने से फ़ायदा नहीं होता।
- एक साथ बहुत ज़्यादा फ़ैसले: "एक साथ बहुत ज़्यादा फ़ैसले। थोड़ी देर में फिर कोशिश करें।" (429)।
- बॉट साइन इन नहीं है: "फ़ैसलों के लिए NeboAI कनेक्ट होना ज़रूरी है। NeboAI में साइन इन करें और फिर कोशिश करें।" (503)।
- फ़ैसला सेवा विफल हो गई (502)।
- फ़ैसलों का बिल किसी भी मॉडल कॉल की तरह बॉट के मालिक के NeboAI अकाउंट पर आता है। कीमतें देखें।
neboFetch
// Relative path: the app's own sidecar.
const res = await NeboAppSDK.neboFetch('/deals?stage=open');
// Absolute URL: through Nebo's proxy. Needs network:api.example.com.
const rates = await NeboAppSDK.neboFetch('https://api.example.com/rates'); एक रिलेटिव पाथ ऐप के sidecar पर /apps/<id>/api/<path> पर जाता है। एक एब्सोल्यूट http या https URL Nebo के प्रॉक्सी से होकर जाता है और उसके लिए network:<host> या network:* ज़रूरी है।
NeboWebSocket
new NeboAppSDK.NeboWebSocket() ऐप के कर्मचारी के लिए एक लाइव सॉकेट खोलता है और बैकऑफ़ के साथ दोबारा जुड़ता है। यह कोई आर्ग्युमेंट नहीं लेता और इसमें send(data), close(), onopen, onmessage, onerror और onclose हैं।
surfaces और a2ui
surfaces.connect() ऐप का लाइव चैनल खोलता है। अभी यह ऐप के कर्मचारी से इंटरैक्टिव कार्ड लाता है: @a2ui/web_core के एक MessageProcessor के साथ a2ui.init(processor) कॉल करें, जिसे आपका पेज बंडल करता है (SDK का अपना कोई रेंडरर नहीं है)। कार्ड सिर्फ़ उसी ऐप तक पहुँचता है जिसके लिए वह बना था, उस पर क्लिक उस ऐप के कर्मचारी तक जाता है, और कार्ड भेजे जाने के बाद खुला पेज उसे नहीं पाता, इसलिए जो पेज को हमेशा दिखाना है उसे storage में रखें।
SDK text_content, state_delta और surface_update जैसे टाइप वाले इवेंट भी परिभाषित करता है, साथ में surfaces.on(type, handler), surfaces.send(name, payload) और surfaces.state। Nebo अभी ये इवेंट ऐप पेज को नहीं भेजता, और send का कोई जवाब नहीं देता। लाइव डेटा के लिए storage.onChange इस्तेमाल करें।
chat
पेज में ऐप के कर्मचारी के साथ Nebo की चैट एम्बेड करें।
NeboAppSDK.chat.mount(document.getElementById('chat'), {
placeholder: 'Ask about a deal',
contextId: 'deal-42'
});
NeboAppSDK.chat.setContext({ deal: 'Example renewal' }); | कॉल | व्यवहार |
|---|---|
chat.mount(element, options) | विकल्प: placeholder, theme, height, borderless, contextId, scope। |
chat.send(text) | संदेश भेजता है। |
chat.setContext(context) | वह संदर्भ सेट करता है जो कर्मचारी देखता है; null उसे साफ़ कर देता है। |
chat.onMessage(handler) | संदेश प्राप्त करता है। |
chat.newThread() | नया थ्रेड शुरू करता है। |
chat.unmount() | चैट हटाता है। |
कॉन्फ़िगरेशन
Nebo के अंदर SDK ऐप id और बेस URL खुद ढूँढ लेता है। कहीं और से सर्व किए जाने वाले पेज के लिए, nebo.configure({appId, baseUrl}) कॉल करें, या NeboAppSDK.setAppId(id) और NeboAppSDK.setBaseUrl(url)। getAppId() और getBaseUrl() इन्हें वापस पढ़ते हैं।