Načítanie SDK
<script src="/sdk/nebo.global.js"></script>
<script>
const { nebo, identity, storage, agents, janus, decide, chat, surfaces } = NeboAppSDK;
</script> Globálny objekt je NeboAppSDK; globálny objekt nebo neexistuje. NeboAppSDK.nebo je inštancia SDK a každý modul sa exportuje aj na najvyššej úrovni, takže NeboAppSDK.storage a NeboAppSDK.nebo.storage sú ten istý objekt. Aby sa nezatienili objekty prehliadača, nebo.fetch sa exportuje ako neboFetch a nebo.WebSocket ako NeboWebSocket.
identity
| Volanie | Vracia |
|---|---|
identity.get() | {id, name, displayName, description, persona, model, skills, inputValues} pre zamestnanca aplikácie. Uložené vo vyrovnávacej pamäti. |
identity.invalidate() | Vymaže vyrovnávaciu pamäť. |
storage
Úložisko kľúč-hodnota pre aplikáciu. Vyžaduje storage:readwrite. Je to to isté úložisko, ktoré číta a mení zamestnanec aplikácie: záznam, ktorý vlastník pridá rozhovorom so zamestnancom, sa zobrazí na stránke, a ten, ktorý sa zadá na stránke, zamestnanec nájde.
const deals = (await NeboAppSDK.storage.getItem('deals')) ?? [];
deals.push({ name: 'Example renewal', closes: '2026-10-31' });
await NeboAppSDK.storage.setItem('deals', deals); | Volanie | Správanie |
|---|---|
storage.getItem(key) | Presne to, čo uložil setItem (objekt, zoznam, číslo alebo reťazec), alebo null. |
storage.setItem(key, value) | Uloží ľubovoľnú hodnotu JSON. |
storage.removeItem(key) | Odstráni jeden kľúč; už sa nezobrazuje v keys(). |
storage.keys() | Všetky kľúče. |
storage.clear() | Odstráni všetky kľúče. |
storage.onChange(handler) | Zavolá handler({appId, keys, action, source}) po každom zápise, či už ho urobil zamestnanec (source: "employee"), alebo akékoľvek otvorené okno aplikácie vrátane tohto (source: "page"). Vracia funkciu, ktorá počúvanie ukončí. |
Prekreslite, keď sa dáta zmenia, nech ich zmenil ktokoľvek:
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();
}); K tomuto úložisku sa dostane len vlastný zamestnanec aplikácie, a to len pre svoju aplikáciu; iný zamestnanec sa pýta zamestnanca aplikácie. Vyberte kľúče, ktoré nájdu obe strany (jeden kľúč so zoznamom alebo jeden kľúč na záznam pod predponou, napríklad deal:42), a opíšte ich v pokynoch zamestnanca. Reťazec, ktorý je sám platným JSON, napríklad "42", sa vráti už spracovaný, takže ak záleží na type, zabaľte ho do objektu. Každú hodnotu udržte výrazne pod 2 MB; setItem nevyhodí chybu, keď je zápis odmietnutý.
agents
Opýtajte sa zamestnanca aplikácie alebo iného zamestnanca a dostanete jeho odpoveď. Pýtanie sa iného zamestnanca vyžaduje 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;
} | Volanie | Vracia |
|---|---|
agents.invoke(message, {agent, data}) | {text, tools}, keď zamestnanec skončí. |
agents.stream(message, {agent, data}) | Asynchrónny iterátor {text, done}. |
janus
Priame volanie modelu bez persony, pamäte a nástrojov.
| Volanie | Vracia |
|---|---|
janus.complete({messages, model, temperature, max_tokens, system}) | Text odpovede ako reťazec. |
janus.stream(same) | Asynchrónny iterátor častí textu. |
decide
Typové rozhodnutia: položte pomenované otázky o nejakých dátach a každú odpoveď dostanete späť s pravdepodobnosťami a istotou, v jednom rýchlom volaní. Nič sa nepíše ako text, takže to používajte na úsudky (je tento potenciálny zákazník horúci, do ktorej kategórie patrí tento tiket, aké je to urgentné) a počítanie, dátumy a prahové hodnoty nechajte vo vlastnom kóde. Zamestnanec aplikácie môže tie isté otázky položiť svojím nástrojom decide, napríklad nad uloženými záznamami aplikácie.
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. | Typ otázky | criteria | Odpoveď |
|---|---|---|
choice | Objekt s 2 až 255 pomenovanými možnosťami, {option: description}. Ak zoznam nie je úplný, pridajte únikovú možnosť, napríklad other. | choice (vybraná možnosť), confidence (0 až 1) a probabilities pre každú možnosť. |
score | Zoznam 2 až 10 zoradených úrovní, od najnižšej. | score (desatinné, 0 je prvá úroveň), confidence a probabilities pre každú úroveň. |
noul | Žiadne: otázka je jedno tvrdenie na posúdenie. | noul, pravdepodobnosť, že tvrdenie platí. Bez samostatnej istoty. |
decide({state, questions})vráti{model, answers, usage}, pričom každá odpoveď je pod názvom, ktorý ste dali jej otázke.stateje text alebo ľubovoľný JSON. Obmedzte ho na polia, ktoré otázky potrebujú, a tieto polia pomenujte v spätných apostrofoch vnútriinstructions. Celá otázka je vinstructions; názov otázky len označuje odpoveď. Veľmi dlhý stav sa pred odoslaním skráti v strede.- Vyhodí chybu, ktorej správa je dôvodom. Chyba nemá stavový kód, takže ak potrebujete prípady rozlíšiť, porovnajte správu:
- Chybne zostavená otázka, napríklad výber s jedinou možnosťou (bot odpovie 400 aj s tým, čo je zle).
- Na účte vlastníka nezostala žiadna práca: „Minuli ste všetku prácu zahrnutú vo vašom účte. Ak chcete pokračovať, vyberte si plán alebo pridajte kredit.“ (429). Opakovanie nepomôže, kým vlastník nepridá plán alebo kredit.
- Príliš veľa rozhodnutí naraz: „Príliš veľa rozhodnutí naraz. Skúste to o chvíľu znova.“ (429).
- Bot nie je prihlásený: „Rozhodnutia vyžadujú pripojenie k NeboAI. Prihláste sa do NeboAI a skúste to znova.“ (503).
- Služba rozhodnutí zlyhala (502).
- Rozhodnutia sa účtujú na účet NeboAI vlastníka bota ako každé volanie modelu. Pozri ceny.
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'); Relatívna cesta smeruje do sidecaru aplikácie na /apps/<id>/api/<path>. Absolútna URL http alebo https ide cez proxy Nebo a vyžaduje network:<host> alebo network:*.
NeboWebSocket
new NeboAppSDK.NeboWebSocket() otvorí živý soket k zamestnancovi aplikácie a znova sa pripája s odďaľovaním. Neprijíma žiadne argumenty a má send(data), close(), onopen, onmessage, onerror a onclose.
surfaces a a2ui
surfaces.connect() otvorí živý kanál aplikácie. Dnes prenáša interaktívne karty od zamestnanca aplikácie: zavolajte a2ui.init(processor) s MessageProcessor z @a2ui/web_core, ktorý si vaša stránka pribalí (SDK nemá vlastný renderer). Karta sa dostane len do aplikácie, pre ktorú bola vytvorená, kliknutie na ňu ide zamestnancovi tejto aplikácie a stránka otvorená po odoslaní karty ju nedostane, takže to, čo musí stránka vždy zobrazovať, uchovávajte v úložisku.
SDK definuje aj typové udalosti, napríklad text_content, state_delta a surface_update, s surfaces.on(type, handler), surfaces.send(name, payload) a surfaces.state. Nebo tieto udalosti zatiaľ stránkam aplikácií neposiela a na send nič neodpovedá. Na živé dáta použite storage.onChange.
chat
Vložte na stránku chat Nebo so zamestnancom aplikácie.
NeboAppSDK.chat.mount(document.getElementById('chat'), {
placeholder: 'Ask about a deal',
contextId: 'deal-42'
});
NeboAppSDK.chat.setContext({ deal: 'Example renewal' }); | Volanie | Správanie |
|---|---|
chat.mount(element, options) | Možnosti: placeholder, theme, height, borderless, contextId, scope. |
chat.send(text) | Pošle správu. |
chat.setContext(context) | Nastaví kontext, ktorý zamestnanec vidí; null ho vymaže. |
chat.onMessage(handler) | Prijíma správy. |
chat.newThread() | Začne nové vlákno. |
chat.unmount() | Odstráni chat. |
Konfigurácia
V rámci Nebo SDK nájde ID aplikácie a základnú URL samo. Pre stránku poskytovanú inde zavolajte nebo.configure({appId, baseUrl}) alebo NeboAppSDK.setAppId(id) a NeboAppSDK.setBaseUrl(url). getAppId() a getBaseUrl() ich načítajú späť.