NeboAI
NeboAI
Bẹ̀rẹ̀

SDK áàpù

App SDK ń so ojú-ìwé áàpù kan pọ̀ mọ́ Nebo. Script kan ni tí Nebo ń pèsè fún gbogbo áàpù, ó sì ń fi ohun àgbáyé kan ṣoṣo sórí ojú-ìwé náà, NeboAppSDK. Kò sí ohun tí a ó fi sórí ẹ̀rọ tàbí kọ́.

Gbé SDK wọlé

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

Ohun àgbáyé náà ni NeboAppSDK; kò sí ohun àgbáyé nebo. NeboAppSDK.nebo ni ẹ̀dà SDK náà, a sì tún ń kó gbogbo módù jáde ní ìpele òkè, nítorí náà NeboAppSDK.storage àti NeboAppSDK.nebo.storage jẹ́ ohun kan náà. Láti yẹra fún bíbo ti aṣàwákiri mọ́lẹ̀, a kó nebo.fetch jáde gẹ́gẹ́ bí neboFetch àti nebo.WebSocket gẹ́gẹ́ bí NeboWebSocket.

identity

ÌpèOhun tí ó ń dá padà
identity.get(){id, name, displayName, description, persona, model, skills, inputValues} fún òṣìṣẹ́ áàpù náà. A fi pamọ́ sínú cache.
identity.invalidate()Ó ń pa cache rẹ́.

storage

Ibi ìpamọ́ kọ́kọ́rọ́-iye fún áàpù náà. Ó nílò storage:readwrite. Ibi ìpamọ́ kan náà ni tí òṣìṣẹ́ áàpù náà ń kà tí ó sì ń yí padà: àkọsílẹ̀ tí olùní fi kún un nípa bíbá òṣìṣẹ́ náà sọ̀rọ̀ ń hàn lórí ojú-ìwé, èyí tí a tẹ sínú ojú-ìwé sì jẹ́ èyí tí òṣìṣẹ́ náà lè rí.

const deals = (await NeboAppSDK.storage.getItem('deals')) ?? [];
deals.push({ name: 'Example renewal', closes: '2026-10-31' });
await NeboAppSDK.storage.setItem('deals', deals);
ÌpèÌwà
storage.getItem(key)Gan-an ohun tí setItem tọ́jú (object, list, number tàbí string), tàbí null.
storage.setItem(key, value)Ó ń tọ́jú iye JSON èyíkéyìí.
storage.removeItem(key)Ó ń yọ kọ́kọ́rọ́ kan kúrò; kò ní hàn nínú keys() mọ́.
storage.keys()Gbogbo kọ́kọ́rọ́.
storage.clear()Ó ń yọ gbogbo kọ́kọ́rọ́ kúrò.
storage.onChange(handler)Ó ń pe handler({appId, keys, action, source}) lẹ́yìn kíkọ kọ̀ọ̀kan, láti ọwọ́ òṣìṣẹ́ náà (source: "employee") tàbí láti ọwọ́ fèrèsé áàpù èyíkéyìí tí ó ṣí sílẹ̀, títí kan èyí (source: "page"). Ó ń dá iṣẹ́ kan padà tí ó ń dá gbígbọ́ dúró.

Tún un yà nígbà tí dátà bá yí padà, ẹnikẹ́ni tí ó bá yí i padà:

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

Òṣìṣẹ́ áàpù náà nìkan ló ń dé ibi ìpamọ́ yìí, fún áàpù tirẹ̀ nìkan; òṣìṣẹ́ míì ń béèrè lọ́wọ́ òṣìṣẹ́ áàpù náà. Yan àwọn kọ́kọ́rọ́ tí ẹ̀gbẹ́ méjèèjì lè rí (kọ́kọ́rọ́ kan tí ó ní àtòjọ kan, tàbí kọ́kọ́rọ́ kan fún àkọsílẹ̀ kọ̀ọ̀kan lábẹ́ ìbẹ̀rẹ̀ ọ̀rọ̀ bí deal:42), kí o sì ṣàpèjúwe wọn nínú àwọn ìtọ́ni òṣìṣẹ́ náà. String tí ó jẹ́ JSON tí ó tọ́ fúnra rẹ̀, bí "42", ń padà ní títúmọ̀, nítorí náà wé e sínú object bí irú rẹ̀ bá ṣe pàtàkì. Jẹ́ kí iye kọ̀ọ̀kan kéré gan-an sí 2 MB; setItem kì í ju àṣìṣe nígbà tí a bá kọ kíkọ kan.

agents

Béèrè lọ́wọ́ òṣìṣẹ́ áàpù náà, tàbí òṣìṣẹ́ míì, kí o sì gba ìdáhùn rẹ̀. Bíbéèrè lọ́wọ́ òṣìṣẹ́ míì nílò 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;
}
ÌpèOhun tí ó ń dá padà
agents.invoke(message, {agent, data}){text, tools} nígbà tí òṣìṣẹ́ náà bá parí.
agents.stream(message, {agent, data})Async iterator ti {text, done}.

janus

Ìpè àwòṣe tààrà láìsí ìwà, ìrántí tàbí irinṣẹ́.

ÌpèOhun tí ó ń dá padà
janus.complete({messages, model, temperature, max_tokens, system})Ọ̀rọ̀ èsì gẹ́gẹ́ bí string.
janus.stream(same)Async iterator ti àwọn apá ọ̀rọ̀.

decide

Àwọn ìpinnu oníru: béèrè àwọn ìbéèrè tí a dárúkọ nípa dátà kan kí o sì gba ìdáhùn kọ̀ọ̀kan padà pẹ̀lú àwọn ìṣeéṣe àti ìgbọ́kànlé, nínú ìpè kíákíá kan. A kò kọ nǹkan kan gẹ́gẹ́ bí ọ̀rọ̀, nítorí náà lò ó fún àwọn ìdájọ́ (ṣé oníbàárà-ìrètí yìí gbóná, ẹ̀ka wo ni tíkẹ́ẹ̀tì yìí wà, báwo ni ó ṣe kánjú tó), kí o sì pa kíkà, ọjọ́ àti ààlà mọ́ sínú kóòdù tìrẹ. Òṣìṣẹ́ áàpù náà lè béèrè àwọn ìbéèrè kan náà pẹ̀lú irinṣẹ́ decide rẹ̀, bí àpẹẹrẹ lórí àwọn àkọsílẹ̀ tí áàpù náà tọ́jú.

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.
Irú ìbéèrècriteriaÌdáhùn
choiceObject kan tí ó ní àṣàyàn 2 sí 255 tí a dárúkọ, {option: description}. Fi àṣàyàn àsálà bí other kún un nígbà tí àtòjọ náà kò bá pé.choice (àṣàyàn tí a mú), confidence (0 sí 1) àti probabilities fún àṣàyàn kọ̀ọ̀kan.
scoreÀtòjọ ìpele 2 sí 10 tí a tò, èyí tí ó kéré jù ló kọ́kọ́.score (ìdá, 0 ni ìpele àkọ́kọ́), confidence àti probabilities fún ìpele kọ̀ọ̀kan.
noulKò sí: ìbéèrè náà jẹ́ gbólóhùn kan láti dájọ́.noul, ìṣeéṣe pé gbólóhùn náà jẹ́ òótọ́. Kò sí ìgbọ́kànlé ọ̀tọ̀.
  • decide({state, questions}) máa ń yanjú sí {model, answers, usage}, pẹ̀lú ìdáhùn kọ̀ọ̀kan lábẹ́ orúkọ tí o fún ìbéèrè rẹ̀.
  • state jẹ́ ọ̀rọ̀ tàbí JSON èyíkéyìí. Jẹ́ kí ó ní àwọn pápá tí àwọn ìbéèrè nílò nìkan, kí o sì dárúkọ àwọn pápá wọ̀nyẹn láàárín backtick nínú instructions. Gbogbo ìbéèrè náà ń gbé inú instructions; orúkọ ìbéèrè náà kàn ń sàmì sí ìdáhùn ni. A ń gé state tí ó gùn gan-an kúrú ní àárín kí a tó fi ránṣẹ́.
  • Ó máa ń ju àṣìṣe kan tí ọ̀rọ̀ rẹ̀ jẹ́ ìdí náà. Àṣìṣe náà kò ní status code, nítorí náà fi ọ̀rọ̀ náà wéra bí o bá nílò láti mọ ìyàtọ̀ láàárín àwọn ọ̀ràn náà:
    • Ìbéèrè tí kò tọ́, bí àpẹẹrẹ choice pẹ̀lú àṣàyàn kan (bot náà ń dáhùn 400, pẹ̀lú ohun tí kò tọ́).
    • Kò sí iṣẹ́ tí ó kù lórí àkọọ́lẹ̀ olùní: "O ti lo gbogbo iṣẹ́ tí ó wà nínú àkọọ́lẹ̀ rẹ. Yan ètò ìsanwó kan tàbí fi kírẹ́dìtì kún un láti tẹ̀síwájú." (429). Àtúngbìyànjú kò ní ṣèrànwọ́ títí tí olùní yóò fi fi ètò ìsanwó tàbí kírẹ́dìtì kún un.
    • Ìpinnu púpọ̀ jù lẹ́ẹ̀kan náà: "Ìpinnu púpọ̀ jù lẹ́ẹ̀kan náà. Gbìyànjú lẹ́ẹ̀kan sí i láìpẹ́." (429).
    • Bot náà kò wọlé: "Àwọn ìpinnu nílò kí NeboAI wà ní ìsopọ̀. Wọlé sí NeboAI kí o sì gbìyànjú lẹ́ẹ̀kan sí i." (503).
    • Iṣẹ́ ìpinnu kùnà (502).
  • A ń gba owó àwọn ìpinnu láti àkọọ́lẹ̀ NeboAI olùní bot bí ìpè àwòṣe èyíkéyìí. Wo iye owó.

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

Ọ̀nà ìbátan kan ń lọ sí sidecar áàpù náà ní /apps/<id>/api/<path>. URL http tàbí https pípé ń gba inú proxy Nebo, ó sì nílò network:<host> tàbí network:*.

NeboWebSocket

new NeboAppSDK.NeboWebSocket() ń ṣí socket tààrà sí òṣìṣẹ́ áàpù náà, ó sì ń tún sopọ̀ pẹ̀lú backoff. Kò gba argument kankan, ó sì ní send(data), close(), onopen, onmessage, onerror àti onclose.

surfaces àti a2ui

surfaces.connect() ń ṣí ìkànnì tààrà áàpù náà. Lónìí ó ń gbé àwọn káàdì ìbáṣepọ̀ láti ọ̀dọ̀ òṣìṣẹ́ áàpù náà: pe a2ui.init(processor) pẹ̀lú MessageProcessor láti @a2ui/web_core, tí ojú-ìwé rẹ ń kó pọ̀ (SDK náà kò ní renderer tirẹ̀). Káàdì kan ń dé ọ̀dọ̀ áàpù tí a ṣe é fún nìkan, títẹ̀ lé e lórí ń lọ sí òṣìṣẹ́ áàpù yẹn, ojú-ìwé tí a ṣí lẹ́yìn tí a fi káàdì kan ránṣẹ́ kì í sì í gbà á, nítorí náà pa ohun tí ojú-ìwé náà gbọ́dọ̀ máa fi hàn nígbà gbogbo mọ́ sínú storage.

SDK náà tún ń ṣàlàyé àwọn ìṣẹ̀lẹ̀ oníru bí text_content, state_delta àti surface_update, pẹ̀lú surfaces.on(type, handler), surfaces.send(name, payload) àti surfaces.state. Nebo kò tíì máa fi àwọn ìṣẹ̀lẹ̀ wọ̀nyẹn ránṣẹ́ sí àwọn ojú-ìwé áàpù, kò sì sí ohun tí ó ń dáhùn send. Fún dátà tààrà, lo storage.onChange.

chat

Fi ìjíròrò Nebo pẹ̀lú òṣìṣẹ́ áàpù náà sínú ojú-ìwé.

NeboAppSDK.chat.mount(document.getElementById('chat'), {
  placeholder: 'Ask about a deal',
  contextId: 'deal-42'
});
NeboAppSDK.chat.setContext({ deal: 'Example renewal' });
ÌpèÌwà
chat.mount(element, options)Àwọn àṣàyàn: placeholder, theme, height, borderless, contextId, scope.
chat.send(text)Ó ń fi ìránṣẹ́ ránṣẹ́.
chat.setContext(context)Ó ń ṣètò àyíká tí òṣìṣẹ́ náà ń rí; null ń pa á rẹ́.
chat.onMessage(handler)Ó ń gba àwọn ìránṣẹ́.
chat.newThread()Ó ń bẹ̀rẹ̀ ìtẹ̀léra ìjíròrò tuntun.
chat.unmount()Ó ń yọ ìjíròrò náà kúrò.

Ìṣètò

Nínú Nebo, SDK máa ń rí app id àti base URL fúnra rẹ̀. Fún ojú-ìwé tí a ń pèsè láti ibòmíì, pe nebo.configure({appId, baseUrl}), tàbí NeboAppSDK.setAppId(id) àti NeboAppSDK.setBaseUrl(url). getAppId() àti getBaseUrl() máa ń kà wọ́n padà.