SDK लोड करा
<script src="/sdk/nebo.global.js"></script>
<script>
const { nebo, identity, storage, agents, janus, decide, chat, surfaces } = NeboAppSDK;
</script> global NeboAppSDK आहे; nebo global नाही. 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
ॲपसाठी key-value स्टोअर. याला 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) | कर्मचाऱ्याने (source: "employee") किंवा ॲपच्या कोणत्याही उघड्या विंडोने, यासह (source: "page"), केलेल्या प्रत्येक लेखनानंतर handler({appId, keys, action, source}) कॉल करते. ऐकणे थांबवणारे फंक्शन परत देते. |
डेटा बदलल्यावर पुन्हा रेखाटा, तो कोणीही बदलला तरी:
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'); सापेक्ष पाथ ॲपच्या साइडकारकडे /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 आणि base URL स्वतःच शोधतो. इतरत्र सर्व्ह होणाऱ्या पेजसाठी, nebo.configure({appId, baseUrl}) कॉल करा, किंवा NeboAppSDK.setAppId(id) आणि NeboAppSDK.setBaseUrl(url). getAppId() आणि getBaseUrl() त्या परत वाचतात.