NeboAI
NeboAI
Začít

App SDK

App SDK propojuje stránku aplikace s Nebo. Je to jeden skript, který Nebo poskytuje každé aplikaci, a na stránku přidává jediný globální objekt, NeboAppSDK. Nic se neinstaluje ani nesestavuje.

Načtení SDK

<script src="/sdk/nebo.global.js"></script>
<script>
  const { nebo, identity, storage, agents, janus, decide, chat, surfaces } = NeboAppSDK;
</script>

Globální objekt je NeboAppSDK; globální objekt nebo neexistuje. NeboAppSDK.nebo je instance SDK a každý modul se exportuje i na nejvyšší úrovni, takže NeboAppSDK.storage a NeboAppSDK.nebo.storage jsou stejný objekt. Aby nepřekrývaly objekty prohlížeče, exportuje se nebo.fetch jako neboFetch a nebo.WebSocket jako NeboWebSocket.

identity

VoláníVrací
identity.get(){id, name, displayName, description, persona, model, skills, inputValues} pro zaměstnance aplikace. Ukládá se do mezipaměti.
identity.invalidate()Vymaže mezipaměť.

storage

Úložiště klíč-hodnota pro aplikaci. Vyžaduje storage:readwrite. Je to stejné úložiště, které čte a mění zaměstnanec aplikace: záznam, který vlastník přidá v rozhovoru se zaměstnancem, se zobrazí na stránce, a záznam zadaný na stránce zaměstnanec najde.

const deals = (await NeboAppSDK.storage.getItem('deals')) ?? [];
deals.push({ name: 'Example renewal', closes: '2026-10-31' });
await NeboAppSDK.storage.setItem('deals', deals);
VoláníChování
storage.getItem(key)Přesně to, co uložil setItem (objekt, seznam, číslo nebo řetězec), nebo null.
storage.setItem(key, value)Uloží libovolnou hodnotu JSON.
storage.removeItem(key)Odstraní jeden klíč; už se neobjeví v keys().
storage.keys()Všechny klíče.
storage.clear()Odstraní všechny klíče.
storage.onChange(handler)Volá handler({appId, keys, action, source}) po každém zápisu, ať ho provede zaměstnanec (source: "employee"), nebo libovolné otevřené okno aplikace včetně tohoto (source: "page"). Vrací funkci, která naslouchání ukončí.

Překreslete, když se data změní, ať je změnil kdokoli:

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žišti se dostane jen vlastní zaměstnanec aplikace, a to jen pro svou aplikaci; jiný zaměstnanec se ptá zaměstnance aplikace. Zvolte klíče, které najdou obě strany (jeden klíč se seznamem, nebo jeden klíč na záznam s předponou, jako je deal:42), a popište je v pokynech zaměstnance. Řetězec, který je sám platným JSON, například "42", se vrátí rozparsovaný, takže pokud na typu záleží, zabalte ho do objektu. Každou hodnotu držte hluboko pod 2 MB; setItem při odmítnutém zápisu nevyhodí výjimku.

agents

Zeptejte se zaměstnance aplikace nebo jiného zaměstnance a získejte jeho odpověď. Dotaz na jiného zaměstnance 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;
}
VoláníVrací
agents.invoke(message, {agent, data}){text, tools}, když zaměstnanec skončí.
agents.stream(message, {agent, data})Asynchronní iterátor {text, done}.

janus

Přímé volání modelu bez persony, paměti a nástrojů.

VoláníVrací
janus.complete({messages, model, temperature, max_tokens, system})Text odpovědi jako řetězec.
janus.stream(same)Asynchronní iterátor částí textu.

decide

Typová rozhodnutí: položte pojmenované otázky k nějakým datům a dostaňte každou odpověď zpět s pravděpodobnostmi a mírou jistoty, v jednom rychlém volání. Nic se nepíše jako text, takže je používejte pro úsudky (je tento potenciální zákazník horký, do které kategorie patří tento tiket, jak je to naléhavé) a počítání, data a prahové hodnoty nechte ve vlastním kódu. Zaměstnanec aplikace může stejné otázky klást svým nástrojem decide, například nad uloženými záznamy aplikace.

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ázkycriteriaOdpověď
choiceObjekt s 2 až 255 pojmenovanými možnostmi, {option: description}. Když seznam není úplný, přidejte únikovou možnost, například other.choice (vybraná možnost), confidence (0 až 1) a probabilities pro každou možnost.
scoreSeznam 2 až 10 seřazených úrovní, od nejnižší.score (desetinné, 0 je první úroveň), confidence a probabilities pro každou úroveň.
noulŽádná: otázka je jedno tvrzení k posouzení.noul, pravděpodobnost, že tvrzení platí. Bez samostatné míry jistoty.
  • decide({state, questions}) vrací {model, answers, usage}, přičemž každá odpověď je pod názvem, který jste dali její otázce.
  • state je text nebo libovolný JSON. Omezte ho na pole, která otázky potřebují, a tato pole uveďte v obrácených apostrofech uvnitř instructions. Celá otázka je v instructions; název otázky jen označuje odpověď. Velmi dlouhý stav se před odesláním zkrátí uprostřed.
  • Vyhodí chybu, jejíž zpráva je důvodem. Chyba nemá stavový kód, takže pokud potřebujete případy rozlišit, porovnejte zprávu:
    • Chybně formulovaná otázka, například volba s jedinou možností (bot odpoví 400 a uvede, co je špatně).
    • Na účtu vlastníka nezbývá žádná práce: "You've used all the work included in your account. Choose a plan or add credits to continue." (429). Opakování nepomůže, dokud vlastník nepřidá tarif nebo kredit.
    • Příliš mnoho rozhodnutí najednou: "Too many decisions at once. Try again in a moment." (429).
    • Bot není přihlášený: "Decisions need NeboAI connected. Sign in to NeboAI and try again." (503).
    • Služba rozhodování selhala (502).
  • Rozhodnutí se účtují na účet NeboAI vlastníka bota jako jakékoli volání modelu. Viz 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');

Relativní cesta směřuje do sidecaru aplikace na /apps/<id>/api/<path>. Absolutní URL http nebo https prochází proxy Nebo a vyžaduje network:<host> nebo network:*.

NeboWebSocket

new NeboAppSDK.NeboWebSocket() otevře živý socket k zaměstnanci aplikace a při výpadku se znovu připojuje s prodlevou. Nepřijímá žádné argumenty a má send(data), close(), onopen, onmessage, onerror a onclose.

surfaces a a2ui

surfaces.connect() otevře živý kanál aplikace. Dnes přenáší interaktivní karty od zaměstnance aplikace: zavolejte a2ui.init(processor) s MessageProcessorem z @a2ui/web_core, který si vaše stránka přibalí (SDK nemá vlastní vykreslovač). Karta se dostane jen do aplikace, pro kterou byla vytvořena, kliknutí na ni jde zaměstnanci této aplikace a stránka otevřená až po odeslání karty ji nedostane, takže to, co stránka musí vždy zobrazovat, držte v úložišti.

SDK také definuje typové události, jako jsou text_content, state_delta a surface_update, spolu s surfaces.on(type, handler), surfaces.send(name, payload) a surfaces.state. Nebo tyto události stránkám aplikací zatím neposílá a na send nic neodpovídá. Pro živá data použijte storage.onChange.

chat

Vložte do stránky chat Nebo se zaměstnancem aplikace.

NeboAppSDK.chat.mount(document.getElementById('chat'), {
  placeholder: 'Ask about a deal',
  contextId: 'deal-42'
});
NeboAppSDK.chat.setContext({ deal: 'Example renewal' });
VoláníChování
chat.mount(element, options)Možnosti: placeholder, theme, height, borderless, contextId, scope.
chat.send(text)Odešle zprávu.
chat.setContext(context)Nastaví kontext, který zaměstnanec vidí; null ho vymaže.
chat.onMessage(handler)Přijímá zprávy.
chat.newThread()Zahájí nové vlákno.
chat.unmount()Odstraní chat.

Konfigurace

Uvnitř Nebo SDK najde ID aplikace a základní URL samo. U stránky obsluhované jinde zavolejte nebo.configure({appId, baseUrl}), nebo NeboAppSDK.setAppId(id) a NeboAppSDK.setBaseUrl(url). getAppId() a getBaseUrl() je přečtou zpět.