Pakia SDK
<script src="/sdk/nebo.global.js"></script>
<script>
const { nebo, identity, storage, agents, janus, decide, chat, surfaces } = NeboAppSDK;
</script> Global ni NeboAppSDK; hakuna global ya nebo. NeboAppSDK.nebo ni instance ya SDK, na kila moduli pia hutolewa katika ngazi ya juu, kwa hiyo NeboAppSDK.storage na NeboAppSDK.nebo.storage ni kitu kimoja. Ili kuepuka kufunika vya kivinjari, nebo.fetch hutolewa kama neboFetch na nebo.WebSocket kama NeboWebSocket.
identity
| Wito | Hurudisha |
|---|---|
identity.get() | {id, name, displayName, description, persona, model, skills, inputValues} kwa mfanyakazi wa programu. Huwekwa kwenye cache. |
identity.invalidate() | Husafisha cache. |
storage
Hifadhi ya key-value kwa programu. Inahitaji storage:readwrite. Ni hifadhi ile ile ambayo mfanyakazi wa programu husoma na kubadilisha: rekodi ambayo mmiliki anaongeza kwa kuzungumza na mfanyakazi huonekana kwenye ukurasa, na iliyoandikwa kwenye ukurasa ni ile ambayo mfanyakazi anaweza kuipata.
const deals = (await NeboAppSDK.storage.getItem('deals')) ?? [];
deals.push({ name: 'Example renewal', closes: '2026-10-31' });
await NeboAppSDK.storage.setItem('deals', deals); | Wito | Tabia |
|---|---|
storage.getItem(key) | Hasa kile setItem ilichohifadhi (object, orodha, namba au string), au null. |
storage.setItem(key, value) | Huhifadhi thamani yoyote ya JSON. |
storage.removeItem(key) | Huondoa ufunguo mmoja; hauonekani tena katika keys(). |
storage.keys() | Funguo zote. |
storage.clear() | Huondoa kila ufunguo. |
storage.onChange(handler) | Huita handler({appId, keys, action, source}) baada ya kila uandishi, na mfanyakazi (source: "employee") au na dirisha lolote lililofunguliwa la programu, ikiwa ni pamoja na hili (source: "page"). Hurudisha function inayositisha usikilizaji. |
Chora upya data inapobadilika, yeyote aliyeibadilisha:
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();
}); Mfanyakazi wa programu mwenyewe pekee ndiye anayefikia hifadhi hii, na kwa programu yake tu; mfanyakazi mwingine humuuliza mfanyakazi wa programu. Chagua funguo ambazo pande zote mbili zinaweza kupata (ufunguo mmoja unaoshikilia orodha, au ufunguo mmoja kwa kila rekodi chini ya kiambishi kama deal:42) na uzieleze katika maelekezo ya mfanyakazi. String ambayo yenyewe ni JSON halali, kama "42", hurudi ikiwa imechanganuliwa, kwa hiyo ifunike ndani ya object ikiwa aina ni muhimu. Weka kila thamani chini sana ya 2 MB; setItem haitupi hitilafu uandishi unapokataliwa.
agents
Muulize mfanyakazi wa programu, au mfanyakazi mwingine, na upate jibu lake. Kumuuliza mfanyakazi mwingine kunahitaji 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;
} | Wito | Hurudisha |
|---|---|
agents.invoke(message, {agent, data}) | {text, tools} mfanyakazi anapomaliza. |
agents.stream(message, {agent, data}) | Async iterator ya {text, done}. |
janus
Wito wa moja kwa moja kwa muundo bila haiba, kumbukumbu wala zana.
| Wito | Hurudisha |
|---|---|
janus.complete({messages, model, temperature, max_tokens, system}) | Maandishi ya jibu kama string. |
janus.stream(same) | Async iterator ya vipande vya maandishi. |
decide
Maamuzi yenye aina: uliza maswali yenye majina kuhusu data fulani na upate kila jibu pamoja na uwezekano na kiwango cha uhakika, kwa wito mmoja wa haraka. Hakuna kinachoandikwa kama maandishi, kwa hiyo itumie kwa tathmini (je, mteja huyu mtarajiwa yuko tayari, tiketi hii ni ya kategoria ipi, ni ya dharura kiasi gani) na uweke kuhesabu, tarehe na viwango vya mipaka katika msimbo wako mwenyewe. Mfanyakazi wa programu anaweza kuuliza maswali yale yale kwa zana yake ya decide, kwa mfano juu ya rekodi zilizohifadhiwa za programu.
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. | Aina ya swali | criteria | Jibu |
|---|---|---|
choice | Object ya chaguo 2 hadi 255 zenye majina, {option: description}. Ongeza chaguo la kutoroka kama other wakati orodha haijakamilika. | choice (chaguo lililochaguliwa), confidence (0 hadi 1) na probabilities kwa kila chaguo. |
score | Orodha ya viwango 2 hadi 10 vilivyopangwa, cha chini kwanza. | score (ya sehemu, 0 ni kiwango cha kwanza), confidence na probabilities kwa kila kiwango. |
noul | Hakuna: swali ni kauli moja ya kutathmini. | noul, uwezekano kwamba kauli ni kweli. Hakuna kiwango tofauti cha uhakika. |
decide({state, questions})inarudisha{model, answers, usage}, kila jibu likiwa chini ya jina ulilolipa swali lake.stateni maandishi au JSON yoyote. Iweke kwa sehemu ambazo maswali yanahitaji pekee na uzitaje sehemu hizo ndani ya backticks katikainstructions. Swali zima linaishi katikainstructions; jina la swali huweka lebo kwenye jibu tu. State ndefu sana hufupishwa katikati kabla ya kutumwa.- Inatupa hitilafu ambayo ujumbe wake ndio sababu. Hitilafu haina msimbo wa hali, kwa hiyo linganisha ujumbe ikiwa unahitaji kutofautisha hali hizo:
- Swali lisilo na muundo sahihi, kwa mfano chaguo lenye chaguo moja tu (boti hujibu 400, pamoja na kilichokosewa).
- Hakuna kazi iliyobaki kwenye akaunti ya mmiliki: "You've used all the work included in your account. Choose a plan or add credits to continue." (429). Kujaribu tena hakusaidii hadi mmiliki aongeze mpango au salio.
- Maamuzi mengi mno kwa wakati mmoja: "Too many decisions at once. Try again in a moment." (429).
- Boti haijaingia: "Decisions need NeboAI connected. Sign in to NeboAI and try again." (503).
- Huduma ya maamuzi imeshindwa (502).
- Maamuzi hutozwa kwenye akaunti ya NeboAI ya mmiliki wa boti kama wito wowote wa muundo. Tazama bei.
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'); Njia ya jamaa huenda kwa sidecar ya programu kwenye /apps/<id>/api/<path>. URL kamili ya http au https hupitia proxy ya Nebo na inahitaji network:<host> au network:*.
NeboWebSocket
new NeboAppSDK.NeboWebSocket() hufungua socket hai kwa mfanyakazi wa programu na huunganisha upya kwa backoff. Haipokei hoja na ina send(data), close(), onopen, onmessage, onerror na onclose.
surfaces na a2ui
surfaces.connect() hufungua chaneli hai ya programu. Leo hubeba kadi shirikishi kutoka kwa mfanyakazi wa programu: ita a2ui.init(processor) pamoja na MessageProcessor kutoka @a2ui/web_core, ambayo ukurasa wako huifunga (SDK haina kichoraji chake). Kadi hufikia programu iliyotengenezewa pekee, kubofya juu yake huenda kwa mfanyakazi wa programu hiyo, na ukurasa uliofunguliwa baada ya kadi kutumwa hauipokei, kwa hiyo weka kile ambacho ukurasa lazima uonyeshe daima kwenye storage.
SDK pia hubainisha matukio yenye aina kama text_content, state_delta na surface_update, pamoja na surfaces.on(type, handler), surfaces.send(name, payload) na surfaces.state. Nebo bado haitumi matukio hayo kwa kurasa za programu, na hakuna kinachojibu send. Kwa data hai, tumia storage.onChange.
chat
Pachika gumzo la Nebo na mfanyakazi wa programu kwenye ukurasa.
NeboAppSDK.chat.mount(document.getElementById('chat'), {
placeholder: 'Ask about a deal',
contextId: 'deal-42'
});
NeboAppSDK.chat.setContext({ deal: 'Example renewal' }); | Wito | Tabia |
|---|---|
chat.mount(element, options) | Chaguzi: placeholder, theme, height, borderless, contextId, scope. |
chat.send(text) | Hutuma ujumbe. |
chat.setContext(context) | Huweka muktadha ambao mfanyakazi huona; null huufuta. |
chat.onMessage(handler) | Hupokea jumbe. |
chat.newThread() | Huanzisha mfululizo mpya. |
chat.unmount() | Huondoa gumzo. |
Usanidi
Ndani ya Nebo, SDK hupata kitambulisho cha programu na URL ya msingi yenyewe. Kwa ukurasa unaotolewa mahali pengine, ita nebo.configure({appId, baseUrl}), au NeboAppSDK.setAppId(id) na NeboAppSDK.setBaseUrl(url). getAppId() na getBaseUrl() huvisoma tena.