NeboAI
NeboAI
Kòmanse

SDK aplikasyon

SDK aplikasyon an konekte paj yon aplikasyon ak Nebo. Se yon sèl script Nebo sèvi bay chak aplikasyon, epi li mete yon sèl global sou paj la, NeboAppSDK. Pa gen anyen pou enstale ni konstwi.

Chaje SDK a

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

Global la se NeboAppSDK; pa gen global nebo. NeboAppSDK.nebo se enstans SDK a, epi chak modil ekspòte tou nan nivo siperyè a, kidonk NeboAppSDK.storage ak NeboAppSDK.nebo.storage se menm objè a. Pou evite kache fonksyon navigatè a, nebo.fetch ekspòte kòm neboFetch epi nebo.WebSocket kòm NeboWebSocket.

identity

ApèlRetounen
identity.get(){id, name, displayName, description, persona, model, skills, inputValues} pou anplwaye aplikasyon an. Nan kach.
identity.invalidate()Efase kach la.

storage

Yon depo kle-valè pou aplikasyon an. Li bezwen storage:readwrite. Se menm depo anplwaye aplikasyon an li epi chanje: yon dosye pwopriyetè a ajoute lè l pale ak anplwaye a parèt sou paj la, epi yon dosye yo tape nan paj la se youn anplwaye a ka jwenn.

const deals = (await NeboAppSDK.storage.getItem('deals')) ?? [];
deals.push({ name: 'Example renewal', closes: '2026-10-31' });
await NeboAppSDK.storage.setItem('deals', deals);
ApèlKonpòtman
storage.getItem(key)Egzakteman sa setItem te sere (objè, lis, nimewo oswa chèn), oswa null.
storage.setItem(key, value)Sere nenpòt valè JSON.
storage.removeItem(key)Retire yon kle; li pa parèt ankò nan keys().
storage.keys()Tout kle yo.
storage.clear()Retire tout kle yo.
storage.onChange(handler)Rele handler({appId, keys, action, source}) apre chak ekriti, pa anplwaye a (source: "employee") oswa pa nenpòt fenèt aplikasyon an ki louvri, enkli sa a (source: "page"). Retounen yon fonksyon ki sispann koute.

Redesine lè done yo chanje, kèlkeswa kiyès ki chanje yo:

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();
});

Se sèlman pwòp anplwaye aplikasyon an ki rive nan depo sa a, epi sèlman pou pwòp aplikasyon pa l; yon lòt anplwaye mande anplwaye aplikasyon an. Chwazi kle toude bò yo ka jwenn (yon kle ki gen yon lis, oswa yon kle pou chak dosye anba yon prefiks tankou deal:42) epi dekri yo nan enstriksyon anplwaye a. Yon chèn ki li menm se JSON valab, tankou "42", tounen analize, kidonk vlope l nan yon objè si kalite a enpòtan. Kenbe chak valè byen anba 2 MB; setItem pa voye erè lè yon ekriti refize.

agents

Mande anplwaye aplikasyon an, oswa yon lòt anplwaye, epi jwenn repons li. Mande yon lòt anplwaye bezwen 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;
}
ApèlRetounen
agents.invoke(message, {agent, data}){text, tools} lè anplwaye a fini.
agents.stream(message, {agent, data})Yon iteratè asenkwòn {text, done}.

janus

Yon apèl dirèk bay modèl la san pèsonalite, memwa ni zouti.

ApèlRetounen
janus.complete({messages, model, temperature, max_tokens, system})Tèks repons lan kòm yon chèn.
janus.stream(same)Yon iteratè asenkwòn moso tèks.

decide

Desizyon tipe: poze kesyon ki gen non sou kèk done epi jwenn chak repons ak pwobabilite ak yon nivo konfyans, nan yon sèl apèl rapid. Anyen pa ekri kòm tèks, kidonk itilize l pou jijman (èske kliyan potansyèl sa a cho, nan ki kategori tikè sa a ye, ki nivo ijans li) epi kenbe kalkil, dat ak papòt nan pwòp kòd pa w. Anplwaye aplikasyon an ka poze menm kesyon yo ak zouti decide li, pa egzanp sou dosye aplikasyon an sere yo.

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.
Kalite kesyoncriteriaRepons
choiceYon objè ak 2 a 255 opsyon ki gen non, {option: description}. Ajoute yon opsyon sòti tankou other lè lis la pa konplè.choice (opsyon yo chwazi a), confidence (0 a 1) ak probabilities pou chak opsyon.
scoreYon lis 2 a 10 nivo nan lòd, pi ba a an premye.score (fraksyonè, 0 se premye nivo a), confidence ak probabilities pou chak nivo.
noulOkenn: kesyon an se yon sèl deklarasyon pou jije.noul, pwobabilite deklarasyon an vre. Pa gen nivo konfyans apa.
  • decide({state, questions}) bay {model, answers, usage}, ak chak repons anba non ou te bay kesyon li a.
  • state se tèks oswa nenpòt JSON. Limite l a chan kesyon yo bezwen epi nonmen chan sa yo ant backtick anndan instructions. Tout kesyon an rete nan instructions; non kesyon an sèlman etikete repons lan. Yon state ki long anpil koupe nan mitan anvan yo voye l.
  • Li voye yon erè ki gen rezon an kòm mesaj. Erè a pa gen kòd estati, kidonk konpare mesaj la si ou bezwen fè diferans ant ka yo:
    • Yon kesyon ki mal fòme, pa egzanp yon chwa ak yon sèl opsyon (bot la reponn 400, ak sa ki pa bon).
    • Pa gen travay ki rete sou kont pwopriyetè a: "Ou itilize tout travay ki enkli nan kont ou. Chwazi yon plan oswa ajoute kredi pou kontinye." (429). Reeseye pa ede jiskaske pwopriyetè a ajoute yon plan oswa kredi.
    • Twòp desizyon alafwa: "Twòp desizyon alafwa. Eseye ankò nan yon ti moman." (429).
    • Bot la pa konekte: "Desizyon yo bezwen NeboAI konekte. Konekte ak NeboAI epi eseye ankò." (503).
    • Sèvis desizyon an echwe (502).
  • Desizyon yo fakture sou kont NeboAI pwopriyetè bot la tankou nenpòt apèl modèl. Gade pri yo.

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');

Yon chemen relatif ale nan sidecar aplikasyon an nan /apps/<id>/api/<path>. Yon URL http oswa https absoli pase nan proxy Nebo a epi li bezwen network:<host> oswa network:*.

NeboWebSocket

new NeboAppSDK.NeboWebSocket() louvri yon sokèt an dirèk ak anplwaye aplikasyon an epi li rekonekte ak reta pwogresif. Li pa pran okenn agiman epi li gen send(data), close(), onopen, onmessage, onerror ak onclose.

surfaces ak a2ui

surfaces.connect() louvri kanal an dirèk aplikasyon an. Jodi a li pote kat entèaktif ki soti nan anplwaye aplikasyon an: rele a2ui.init(processor) ak yon MessageProcessor ki soti nan @a2ui/web_core, paj ou a mete nan pake li (SDK a pa gen pwòp motè afichaj pa l). Yon kat rive sèlman nan aplikasyon yo te fè l pou li a, yon klik sou li ale bay anplwaye aplikasyon sa a, epi yon paj ki louvri apre yo te voye yon kat pa resevwa l, kidonk kenbe sa paj la dwe toujou montre nan storage.

SDK a defini tou evènman tipe tankou text_content, state_delta ak surface_update, ak surfaces.on(type, handler), surfaces.send(name, payload) ak surfaces.state. Nebo poko voye evènman sa yo bay paj aplikasyon, epi anyen pa reponn send. Pou done an dirèk, itilize storage.onChange.

chat

Entegre chat Nebo a ak anplwaye aplikasyon an nan paj la.

NeboAppSDK.chat.mount(document.getElementById('chat'), {
  placeholder: 'Ask about a deal',
  contextId: 'deal-42'
});
NeboAppSDK.chat.setContext({ deal: 'Example renewal' });
ApèlKonpòtman
chat.mount(element, options)Opsyon: placeholder, theme, height, borderless, contextId, scope.
chat.send(text)Voye yon mesaj.
chat.setContext(context)Fikse kontèks anplwaye a wè; null efase l.
chat.onMessage(handler)Resevwa mesaj.
chat.newThread()Kòmanse yon nouvo fil.
chat.unmount()Retire chat la.

Konfigirasyon

Andedan Nebo, SDK a jwenn id aplikasyon an ak URL baz la poukont li. Pou yon paj ki sèvi yon lòt kote, rele nebo.configure({appId, baseUrl}), oswa NeboAppSDK.setAppId(id) ak NeboAppSDK.setBaseUrl(url). getAppId() ak getBaseUrl() li yo ankò.