Lataa SDK
<script src="/sdk/nebo.global.js"></script>
<script>
const { nebo, identity, storage, agents, janus, decide, chat, surfaces } = NeboAppSDK;
</script> Globaali on NeboAppSDK; nebo-globaalia ei ole. NeboAppSDK.nebo on SDK-instanssi, ja jokainen moduuli viedään myös ylätasolla, joten NeboAppSDK.storage ja NeboAppSDK.nebo.storage ovat sama olio. Selaimen ominaisuuksien peittämisen välttämiseksi nebo.fetch viedään nimellä neboFetch ja nebo.WebSocket nimellä NeboWebSocket.
identity
| Kutsu | Palauttaa |
|---|---|
identity.get() | {id, name, displayName, description, persona, model, skills, inputValues} sovelluksen työntekijälle. Välimuistissa. |
identity.invalidate() | Tyhjentää välimuistin. |
storage
Sovelluksen avain-arvo-tallennus. Se vaatii luvan storage:readwrite. Se on sama tallennus, jota sovelluksen työntekijä lukee ja muuttaa: tietue, jonka omistaja lisää puhumalla työntekijälle, näkyy sivulla, ja sivulle kirjoitetun tietueen työntekijä voi löytää.
const deals = (await NeboAppSDK.storage.getItem('deals')) ?? [];
deals.push({ name: 'Example renewal', closes: '2026-10-31' });
await NeboAppSDK.storage.setItem('deals', deals); | Kutsu | Toiminta |
|---|---|
storage.getItem(key) | Täsmälleen sen, minkä setItem tallensi (olio, luettelo, luku tai merkkijono), tai null. |
storage.setItem(key, value) | Tallentaa minkä tahansa JSON-arvon. |
storage.removeItem(key) | Poistaa yhden avaimen; se ei enää näy kutsussa keys(). |
storage.keys() | Kaikki avaimet. |
storage.clear() | Poistaa kaikki avaimet. |
storage.onChange(handler) | Kutsuu handler({appId, keys, action, source}) jokaisen kirjoituksen jälkeen, oli kirjoittaja työntekijä (source: "employee") tai mikä tahansa sovelluksen avoin ikkuna, myös tämä (source: "page"). Palauttaa funktion, joka lopettaa kuuntelun. |
Piirrä uudelleen, kun data muuttuu, kuka tahansa sen muuttikin:
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();
}); Vain sovelluksen oma työntekijä pääsee tähän tallennukseen, ja vain oman sovelluksensa osalta; muu työntekijä kysyy sovelluksen työntekijältä. Valitse avaimet, jotka molemmat osapuolet löytävät (yksi avain, joka sisältää luettelon, tai yksi avain tietuetta kohden etuliitteen alla, kuten deal:42), ja kuvaa ne työntekijän ohjeissa. Merkkijono, joka on itsessään kelvollista JSONia, kuten "42", palautuu jäsennettynä, joten kääri se olioon, jos tyypillä on merkitystä. Pidä jokainen arvo selvästi alle 2 MB; setItem ei heitä virhettä, kun kirjoitus hylätään.
agents
Kysy sovelluksen työntekijältä tai toiselta työntekijältä ja saa sen vastaus. Toiselta työntekijältä kysyminen vaatii luvan 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;
} | Kutsu | Palauttaa |
|---|---|
agents.invoke(message, {agent, data}) | {text, tools}, kun työntekijä on valmis. |
agents.stream(message, {agent, data}) | Asynkroninen iteraattori, joka tuottaa {text, done}. |
janus
Suora mallikutsu ilman persoonaa, muistia tai työkaluja.
| Kutsu | Palauttaa |
|---|---|
janus.complete({messages, model, temperature, max_tokens, system}) | Vastausteksti merkkijonona. |
janus.stream(same) | Asynkroninen iteraattori, joka tuottaa tekstipaloja. |
decide
Tyypitetyt päätökset: esitä nimettyjä kysymyksiä jostakin datasta ja saa jokainen vastaus takaisin todennäköisyyksineen ja luottamustasoineen yhdellä nopealla kutsulla. Mitään ei kirjoiteta tekstinä, joten käytä sitä arviointeihin (onko tämä liidi kuuma, mihin luokkaan tämä tukipyyntö kuuluu, kuinka kiireellinen se on) ja pidä laskenta, päivämäärät ja kynnysarvot omassa koodissasi. Sovelluksen työntekijä voi esittää samat kysymykset decide-työkalullaan, esimerkiksi sovelluksen tallennetuista tietueista.
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. | Kysymystyyppi | criteria | Vastaus |
|---|---|---|
choice | Olio, jossa on 2–255 nimettyä vaihtoehtoa, {option: description}. Lisää poistumisvaihtoehto, kuten other, kun luettelo ei ole täydellinen. | choice (valittu vaihtoehto), confidence (0–1) ja probabilities vaihtoehdoittain. |
score | Luettelo 2–10 järjestetystä tasosta, alin ensin. | score (murtoluku, 0 on ensimmäinen taso), confidence ja probabilities tasoittain. |
noul | Ei mitään: kysymys on yksi arvioitava väite. | noul, todennäköisyys sille, että väite pitää paikkansa. Ei erillistä luottamustasoa. |
decide({state, questions})palauttaa arvon{model, answers, usage}, jossa jokainen vastaus on sen nimen alla, jonka annoit sen kysymykselle.stateon tekstiä tai mitä tahansa JSONia. Rajaa se kenttiin, joita kysymykset tarvitsevat, ja nimeä nämä kentät gravisaksenttien sisällä kohdassainstructions. Koko kysymys on kohdassainstructions; kysymyksen nimi vain nimeää vastauksen. Hyvin pitkää tilaa lyhennetään keskeltä ennen lähettämistä.- Se heittää virheen, jonka viesti kertoo syyn. Virheellä ei ole tilakoodia, joten vertaa viestiä, jos haluat erottaa tapaukset toisistaan:
- Virheellinen kysymys, esimerkiksi valinta, jossa on vain yksi vaihtoehto (botti vastaa 400 ja kertoo, mikä on vialla).
- Omistajan tilillä ei ole työtä jäljellä: ”You've used all the work included in your account. Choose a plan or add credits to continue.” (429). Uudelleenyrittäminen ei auta ennen kuin omistaja lisää paketin tai krediittejä.
- Liian monta päätöstä kerralla: ”Too many decisions at once. Try again in a moment.” (429).
- Botti ei ole kirjautunut sisään: ”Decisions need NeboAI connected. Sign in to NeboAI and try again.” (503).
- Päätöspalvelu epäonnistui (502).
- Päätökset laskutetaan botin omistajan NeboAI-tililtä kuten mikä tahansa mallikutsu. Katso hinnat.
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'); Suhteellinen polku menee sovelluksen sivuvaunuun osoitteeseen /apps/<id>/api/<path>. Absoluuttinen http- tai https-URL kulkee Nebon välityspalvelimen kautta ja vaatii luvan network:<host> tai network:*.
NeboWebSocket
new NeboAppSDK.NeboWebSocket() avaa reaaliaikaisen socketin sovelluksen työntekijään ja yhdistää uudelleen viiveellä. Se ei ota argumentteja, ja sillä on send(data), close(), onopen, onmessage, onerror ja onclose.
surfaces ja a2ui
surfaces.connect() avaa sovelluksen reaaliaikaisen kanavan. Tällä hetkellä se välittää interaktiivisia kortteja sovelluksen työntekijältä: kutsu a2ui.init(processor) MessageProcessorilla paketista @a2ui/web_core, jonka sivusi paketoi (SDK:lla ei ole omaa piirtäjää). Kortti tavoittaa vain sovelluksen, jota varten se tehtiin, napsautus siinä menee kyseisen sovelluksen työntekijälle, eikä kortin lähettämisen jälkeen avattu sivu saa sitä, joten pidä tallennuksessa se, mitä sivun on aina näytettävä.
SDK määrittää myös tyypitettyjä tapahtumia, kuten text_content, state_delta ja surface_update, sekä surfaces.on(type, handler), surfaces.send(name, payload) ja surfaces.state. Nebo ei vielä lähetä näitä tapahtumia sovellussivuille, eikä mikään vastaa kutsuun send. Käytä reaaliaikaiseen dataan storage.onChange-kutsua.
chat
Upota Nebon chat sovelluksen työntekijän kanssa sivulle.
NeboAppSDK.chat.mount(document.getElementById('chat'), {
placeholder: 'Ask about a deal',
contextId: 'deal-42'
});
NeboAppSDK.chat.setContext({ deal: 'Example renewal' }); | Kutsu | Toiminta |
|---|---|
chat.mount(element, options) | Valinnat: placeholder, theme, height, borderless, contextId, scope. |
chat.send(text) | Lähettää viestin. |
chat.setContext(context) | Asettaa kontekstin, jonka työntekijä näkee; null tyhjentää sen. |
chat.onMessage(handler) | Vastaanottaa viestejä. |
chat.newThread() | Aloittaa uuden ketjun. |
chat.unmount() | Poistaa chatin. |
Määritykset
Nebon sisällä SDK löytää sovelluksen tunnuksen ja perus-URL-osoitteen itse. Jos sivu tarjoillaan muualta, kutsu nebo.configure({appId, baseUrl}) tai NeboAppSDK.setAppId(id) ja NeboAppSDK.setBaseUrl(url). getAppId() ja getBaseUrl() lukevat ne takaisin.