Az SDK betöltése
<script src="/sdk/nebo.global.js"></script>
<script>
const { nebo, identity, storage, agents, janus, decide, chat, surfaces } = NeboAppSDK;
</script> A globális objektum a NeboAppSDK; nincs nebo globális. A NeboAppSDK.nebo az SDK-példány, és minden modul a legfelső szinten is exportálva van, így a NeboAppSDK.storage és a NeboAppSDK.nebo.storage ugyanaz az objektum. A böngésző elfedésének elkerülése érdekében a nebo.fetch neboFetch néven, a nebo.WebSocket pedig NeboWebSocket néven van exportálva.
identity
| Hívás | Visszatérési érték |
|---|---|
identity.get() | {id, name, displayName, description, persona, model, skills, inputValues} az alkalmazás munkatársára. Gyorsítótárazva. |
identity.invalidate() | Törli a gyorsítótárat. |
storage
Kulcs-érték tároló az alkalmazás számára. A storage:readwrite engedély kell hozzá. Ugyanaz a tároló, amelyet az alkalmazás munkatársa olvas és módosít: egy bejegyzés, amelyet a tulajdonos a munkatárssal beszélgetve ad hozzá, megjelenik az oldalon, az oldalon beírtat pedig a munkatárs is megtalálja.
const deals = (await NeboAppSDK.storage.getItem('deals')) ?? [];
deals.push({ name: 'Example renewal', closes: '2026-10-31' });
await NeboAppSDK.storage.setItem('deals', deals); | Hívás | Viselkedés |
|---|---|
storage.getItem(key) | Pontosan azt, amit a setItem tárolt (objektum, lista, szám vagy karakterlánc), vagy null. |
storage.setItem(key, value) | Bármilyen JSON-értéket tárol. |
storage.removeItem(key) | Eltávolít egy kulcsot; az többé nem jelenik meg a keys() eredményében. |
storage.keys() | Az összes kulcs. |
storage.clear() | Eltávolítja az összes kulcsot. |
storage.onChange(handler) | Minden írás után meghívja a handler({appId, keys, action, source}) függvényt, akár a munkatárs (source: "employee"), akár az alkalmazás bármely nyitott ablaka írt, ezt is beleértve (source: "page"). Egy függvényt ad vissza, amely leállítja a figyelést. |
Rajzolja újra az oldalt, ha az adatok megváltoznak, bárki is változtatta meg őket:
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();
}); Ezt a tárolót csak az alkalmazás saját munkatársa éri el, és csak a saját alkalmazásához; egy másik munkatárs az alkalmazás munkatársát kérdezi meg. Válasszon olyan kulcsokat, amelyeket mindkét fél megtalál (egy listát tartalmazó kulcs, vagy rekordonként egy kulcs egy előtag alatt, például deal:42), és írja le őket a munkatárs utasításaiban. Az a karakterlánc, amely maga is érvényes JSON, például a "42", értelmezve érkezik vissza, ezért csomagolja objektumba, ha a típus számít. Tartson minden értéket jóval 2 MB alatt; a setItem nem dob hibát, ha egy írást elutasítanak.
agents
Kérdezze meg az alkalmazás munkatársát vagy egy másik munkatársat, és kapja meg a válaszát. Egy másik munkatárs megkérdezéséhez a subagent:<employee-id> engedély kell.
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;
} | Hívás | Visszatérési érték |
|---|---|
agents.invoke(message, {agent, data}) | {text, tools}, amikor a munkatárs végzett. |
agents.stream(message, {agent, data}) | {text, done} elemek aszinkron iterátora. |
janus
Közvetlen modellhívás személyiség, memória és eszközök nélkül.
| Hívás | Visszatérési érték |
|---|---|
janus.complete({messages, model, temperature, max_tokens, system}) | A válasz szövege karakterláncként. |
janus.stream(same) | Szövegrészletek aszinkron iterátora. |
decide
Típusos döntések: tegyen fel elnevezett kérdéseket bizonyos adatokról, és kapjon vissza minden választ valószínűségekkel és megbízhatósággal, egyetlen gyors hívásban. Semmi sem íródik ki szövegként, ezért ítéletekhez használja (forró-e ez az érdeklődő, melyik kategóriába tartozik ez a jegy, mennyire sürgős), a számolást, a dátumokat és a küszöbértékeket pedig tartsa a saját kódjában. Az alkalmazás munkatársa ugyanezeket a kérdéseket felteheti a decide eszközével, például az alkalmazás tárolt rekordjain.
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. | Kérdéstípus | criteria | Válasz |
|---|---|---|
choice | 2–255 elnevezett lehetőséget tartalmazó objektum, {option: description}. Adjon hozzá kilépési lehetőséget, például other, ha a lista nem teljes. | choice (a kiválasztott lehetőség), confidence (0 és 1 között) és lehetőségenkénti probabilities. |
score | 2–10 rendezett szint listája, a legalacsonyabbal kezdve. | score (törtszám, 0 az első szint), confidence és szintenkénti probabilities. |
noul | Nincs: a kérdés egyetlen megítélendő állítás. | noul, annak valószínűsége, hogy az állítás igaz. Nincs külön megbízhatóság. |
- A
decide({state, questions})eredménye{model, answers, usage}, ahol minden válasz azon a néven szerepel, amelyet a kérdésének adott. - A
stateszöveg vagy bármilyen JSON. Csak azokat a mezőket tartalmazza, amelyekre a kérdéseknek szükségük van, és ezeket a mezőket backtickek között nevezze meg azinstructionsszövegében. A teljes kérdés azinstructionsmezőben van; a kérdés neve csak a választ címkézi. A nagyon hosszú state a közepén rövidül, mielőtt elküldenénk. - Hibát dob, amelynek üzenete maga az ok. A hibának nincs állapotkódja, ezért ha meg kell különböztetnie az eseteket, az üzenetet hasonlítsa össze:
- Hibás formátumú kérdés, például egy választás egyetlen lehetőséggel (a bot 400-zal válaszol, megnevezve a hibát).
- Nincs több munka a tulajdonos fiókjában: „Felhasználta a fiókjában foglalt összes munkát. A folytatáshoz válasszon csomagot, vagy vásároljon kreditet.” (429). Az újrapróbálás nem segít, amíg a tulajdonos nem ad hozzá csomagot vagy kreditet.
- Túl sok döntés egyszerre: „Túl sok döntés egyszerre. Próbálja újra egy pillanat múlva.” (429).
- A bot nincs bejelentkezve: „A döntésekhez csatlakoztatott NeboAI szükséges. Jelentkezzen be a NeboAI-ba, és próbálja újra.” (503).
- A döntési szolgáltatás hibát adott (502).
- A döntéseket a bot tulajdonosának NeboAI-fiókja fizeti, mint bármely modellhívást. Lásd: árak.
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'); A relatív elérési út az alkalmazás sidecarjához kerül, a /apps/<id>/api/<path> címre. Az abszolút http vagy https URL a Nebo proxyján megy át, és network:<host> vagy network:* engedélyt igényel.
NeboWebSocket
A new NeboAppSDK.NeboWebSocket() élő socketet nyit az alkalmazás munkatársához, és visszalépéssel újracsatlakozik. Nem fogad argumentumot, és a következőkkel rendelkezik: send(data), close(), onopen, onmessage, onerror és onclose.
surfaces és a2ui
A surfaces.connect() megnyitja az alkalmazás élő csatornáját. Jelenleg az alkalmazás munkatársától érkező interaktív kártyákat továbbítja: hívja meg az a2ui.init(processor) függvényt egy MessageProcessorral a @a2ui/web_core csomagból, amelyet az oldala csomagol be (az SDK-nak nincs saját megjelenítője). Egy kártya csak ahhoz az alkalmazáshoz jut el, amelyhez készült, a rá leadott kattintás az adott alkalmazás munkatársához kerül, és a kártya elküldése után megnyitott oldal már nem kapja meg, ezért amit az oldalnak mindig mutatnia kell, azt tartsa a tárhelyen.
Az SDK típusos eseményeket is definiál, például text_content, state_delta és surface_update, a surfaces.on(type, handler), a surfaces.send(name, payload) és a surfaces.state segítségével. A Nebo ezeket az eseményeket még nem küldi el az alkalmazásoldalaknak, és a send hívásra semmi sem válaszol. Élő adatokhoz használja a storage.onChange függvényt.
chat
Ágyazza be az oldalba a Nebo csevegését az alkalmazás munkatársával.
NeboAppSDK.chat.mount(document.getElementById('chat'), {
placeholder: 'Ask about a deal',
contextId: 'deal-42'
});
NeboAppSDK.chat.setContext({ deal: 'Example renewal' }); | Hívás | Viselkedés |
|---|---|
chat.mount(element, options) | Beállítások: placeholder, theme, height, borderless, contextId, scope. |
chat.send(text) | Üzenetet küld. |
chat.setContext(context) | Beállítja a munkatárs által látott kontextust; a null törli. |
chat.onMessage(handler) | Üzeneteket fogad. |
chat.newThread() | Új szálat indít. |
chat.unmount() | Eltávolítja a csevegést. |
Konfiguráció
A Nebón belül az SDK magától megtalálja az alkalmazásazonosítót és az alap-URL-t. Máshol kiszolgált oldal esetén hívja meg a nebo.configure({appId, baseUrl}) függvényt, vagy a NeboAppSDK.setAppId(id) és a NeboAppSDK.setBaseUrl(url) függvényt. A getAppId() és a getBaseUrl() visszaolvassa őket.