De SDK laden
<script src="/sdk/nebo.global.js"></script>
<script>
const { nebo, identity, storage, agents, janus, decide, chat, surfaces } = NeboAppSDK;
</script> De globale variabele is NeboAppSDK; er is geen globale nebo. NeboAppSDK.nebo is de SDK-instantie, en elke module wordt ook op het hoogste niveau geëxporteerd, dus NeboAppSDK.storage en NeboAppSDK.nebo.storage zijn hetzelfde object. Om te voorkomen dat de browser wordt overschaduwd, wordt nebo.fetch geëxporteerd als neboFetch en nebo.WebSocket als NeboWebSocket.
identity
| Aanroep | Geeft terug |
|---|---|
identity.get() | {id, name, displayName, description, persona, model, skills, inputValues} voor de medewerker van de app. Gecachet. |
identity.invalidate() | Wist de cache. |
storage
Een key-value-opslag voor de app. Hij vereist storage:readwrite. Het is dezelfde opslag die de medewerker van de app leest en wijzigt: een record dat de eigenaar toevoegt door met de medewerker te praten, verschijnt op de pagina, en een record dat op de pagina wordt ingevoerd, kan de medewerker vinden.
const deals = (await NeboAppSDK.storage.getItem('deals')) ?? [];
deals.push({ name: 'Example renewal', closes: '2026-10-31' });
await NeboAppSDK.storage.setItem('deals', deals); | Aanroep | Gedrag |
|---|---|
storage.getItem(key) | Precies wat setItem heeft opgeslagen (object, lijst, getal of string), of null. |
storage.setItem(key, value) | Slaat elke JSON-waarde op. |
storage.removeItem(key) | Verwijdert één sleutel; die verschijnt niet meer in keys(). |
storage.keys() | Alle sleutels. |
storage.clear() | Verwijdert alle sleutels. |
storage.onChange(handler) | Roept handler({appId, keys, action, source}) aan na elke schrijfactie, door de medewerker (source: "employee") of door elk geopend venster van de app, dit venster inbegrepen (source: "page"). Geeft een functie terug die stopt met luisteren. |
Opnieuw tekenen wanneer de data verandert, wie die ook heeft gewijzigd:
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();
}); Alleen de eigen medewerker van de app kan bij deze opslag, en alleen voor zijn eigen app; een andere medewerker vraagt het aan de medewerker van de app. Kies sleutels die beide kanten kunnen vinden (één sleutel met een lijst, of één sleutel per record onder een voorvoegsel zoals deal:42) en beschrijf ze in de instructies van de medewerker. Een string die zelf geldige JSON is, zoals "42", komt geparsed terug, dus verpak hem in een object als het type ertoe doet. Houd elke waarde ruim onder de 2 MB; setItem geeft geen foutmelding als een schrijfactie wordt geweigerd.
agents
Vraag iets aan de medewerker van de app, of aan een andere medewerker, en krijg zijn antwoord. Een andere medewerker iets vragen vereist 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;
} | Aanroep | Geeft terug |
|---|---|
agents.invoke(message, {agent, data}) | {text, tools} wanneer de medewerker klaar is. |
agents.stream(message, {agent, data}) | Een async iterator van {text, done}. |
janus
Een directe modelaanroep zonder persona, geheugen of tools.
| Aanroep | Geeft terug |
|---|---|
janus.complete({messages, model, temperature, max_tokens, system}) | De antwoordtekst als string. |
janus.stream(same) | Een async iterator van tekstfragmenten. |
decide
Getypeerde beslissingen: stel benoemde vragen over bepaalde data en krijg elk antwoord terug met waarschijnlijkheden en een betrouwbaarheid, in één snelle aanroep. Er wordt niets als tekst geschreven, dus gebruik het voor oordelen (is deze lead warm, in welke categorie hoort dit ticket, hoe urgent is het) en houd tellen, datums en drempelwaarden in je eigen code. De medewerker van de app kan dezelfde vragen stellen met zijn tool decide, bijvoorbeeld over de opgeslagen records van de app.
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. | Vraagtype | criteria | Antwoord |
|---|---|---|
choice | Een object met 2 tot 255 benoemde opties, {option: description}. Voeg een uitwijkoptie toe, zoals other, als de lijst niet compleet is. | choice (de gekozen optie), confidence (0 tot 1) en probabilities per optie. |
score | Een lijst van 2 tot 10 geordende niveaus, laagste eerst. | score (fractioneel, 0 is het eerste niveau), confidence en probabilities per niveau. |
noul | Geen: de vraag is één bewering om te beoordelen. | noul, de waarschijnlijkheid dat de bewering klopt. Geen aparte betrouwbaarheid. |
decide({state, questions})levert{model, answers, usage}op, met elk antwoord onder de naam die je de bijbehorende vraag hebt gegeven.stateis tekst of willekeurige JSON. Beperk het tot de velden die de vragen nodig hebben en noem die velden tussen backticks ininstructions. De hele vraag staat ininstructions; de naam van de vraag is alleen het label van het antwoord. Een erg lange state wordt in het midden ingekort voordat hij wordt verstuurd.- Er wordt een fout gegooid waarvan de melding de reden is. De fout heeft geen statuscode, dus vergelijk de melding als je de gevallen wilt onderscheiden:
- Een onjuist opgebouwde vraag, bijvoorbeeld een keuze met maar één optie (de bot antwoordt met 400 en wat er mis is).
- Geen werk meer over op het account van de eigenaar: "Je hebt al het werk gebruikt dat bij je account hoort. Kies een abonnement of voeg tegoed toe om door te gaan." (429). Opnieuw proberen helpt niet totdat de eigenaar een abonnement of tegoed toevoegt.
- Te veel beslissingen tegelijk: "Te veel beslissingen tegelijk. Probeer het zo opnieuw." (429).
- De bot is niet ingelogd: "Voor beslissingen moet NeboAI verbonden zijn. Log in bij NeboAI en probeer het opnieuw." (503).
- De beslissingsservice is mislukt (502).
- Beslissingen worden, net als elke modelaanroep, gefactureerd aan het NeboAI-account van de eigenaar van de bot. Zie prijzen.
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'); Een relatief pad gaat naar de sidecar van de app op /apps/<id>/api/<path>. Een absolute http- of https-URL gaat via de proxy van Nebo en vereist network:<host> of network:*.
NeboWebSocket
new NeboAppSDK.NeboWebSocket() opent een live socket naar de medewerker van de app en maakt met backoff opnieuw verbinding. Hij neemt geen argumenten en heeft send(data), close(), onopen, onmessage, onerror en onclose.
surfaces en a2ui
surfaces.connect() opent het live kanaal van de app. Op dit moment draagt het interactieve kaarten van de medewerker van de app: roep a2ui.init(processor) aan met een MessageProcessor uit @a2ui/web_core, die je pagina zelf meebundelt (de SDK heeft geen eigen renderer). Een kaart bereikt alleen de app waarvoor hij is gemaakt, een klik erop gaat naar de medewerker van die app, en een pagina die wordt geopend nadat een kaart is verstuurd, ontvangt hem niet, dus bewaar wat de pagina altijd moet tonen in storage.
De SDK definieert ook getypeerde gebeurtenissen zoals text_content, state_delta en surface_update, met surfaces.on(type, handler), surfaces.send(name, payload) en surfaces.state. Nebo stuurt die gebeurtenissen nog niet naar app-pagina's, en niets beantwoordt send. Gebruik voor live data storage.onChange.
chat
Sluit de chat van Nebo met de medewerker van de app in op de pagina in.
NeboAppSDK.chat.mount(document.getElementById('chat'), {
placeholder: 'Ask about a deal',
contextId: 'deal-42'
});
NeboAppSDK.chat.setContext({ deal: 'Example renewal' }); | Aanroep | Gedrag |
|---|---|
chat.mount(element, options) | Opties: placeholder, theme, height, borderless, contextId, scope. |
chat.send(text) | Verstuurt een bericht. |
chat.setContext(context) | Stelt de context in die de medewerker ziet; null wist die. |
chat.onMessage(handler) | Ontvangt berichten. |
chat.newThread() | Start een nieuwe thread. |
chat.unmount() | Verwijdert de chat. |
Configuratie
Binnen Nebo vindt de SDK de app-id en de basis-URL zelf. Voor een pagina die ergens anders wordt geserveerd, roep je nebo.configure({appId, baseUrl}) aan, of NeboAppSDK.setAppId(id) en NeboAppSDK.setBaseUrl(url). Met getAppId() en getBaseUrl() lees je ze weer uit.