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) | ఉద్యోగి (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 వంటి ప్రిఫిక్స్ కింద ప్రతి రికార్డుకు ఒక కీ) మరియు వాటిని ఉద్యోగి సూచనలలో వివరించండి. "42" వంటి, తానే సరైన JSON అయిన స్ట్రింగ్ పార్స్ చేయబడి తిరిగి వస్తుంది, కాబట్టి రకం ముఖ్యమైతే దాన్ని ఒక ఆబ్జెక్ట్లో చుట్టండి. ప్రతి విలువను 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 ఇటరేటర్. |
janus
వ్యక్తిత్వం, జ్ఞాపకం, టూల్స్ లేని నేరుగా మోడల్ కాల్.
| కాల్ | తిరిగి ఇచ్చేది |
|---|---|
janus.complete({messages, model, temperature, max_tokens, system}) | జవాబు టెక్స్ట్ స్ట్రింగ్గా. |
janus.stream(same) | టెక్స్ట్ భాగాల async ఇటరేటర్. |
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() యాప్ ఉద్యోగికి లైవ్ సాకెట్ను తెరిచి, backoffతో మళ్ళీ కనెక్ట్ అవుతుంది. ఇది ఆర్గ్యుమెంట్లు తీసుకోదు, దీనికి 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() వాటిని తిరిగి చదువుతాయి.