Budata SDK
<script src="/sdk/nebo.global.js"></script>
<script>
const { nebo, identity, storage, agents, janus, decide, chat, surfaces } = NeboAppSDK;
</script> Global ahụ bụ NeboAppSDK; enweghị global nebo. NeboAppSDK.nebo bụ instance SDK, a na-ebupụkwa modul ọ bụla n'ọkwa kacha elu, ya mere NeboAppSDK.storage na NeboAppSDK.nebo.storage bụ otu ihe ahụ. Iji zere ikpuchi nchọgharị, a na-ebupụ nebo.fetch dị ka neboFetch, nebo.WebSocket dịkwa ka NeboWebSocket.
identity
| Oku | Na-eweghachi |
|---|---|
identity.get() | {id, name, displayName, description, persona, model, skills, inputValues} maka onye ọrụ ngwa ahụ. A na-echekwa ya na cache. |
identity.invalidate() | Na-ehichapụ cache. |
storage
Ebe nchekwa igodo na uru maka ngwa ahụ. Ọ chọrọ storage:readwrite. Ọ bụ otu ebe nchekwa ahụ onye ọrụ ngwa ahụ na-agụ ma na-agbanwe: ndekọ onye nwe ya gbakwunyere site n'ịgwa onye ọrụ ahụ okwu na-apụta n'ibe ahụ, nke e dere n'ibe ahụ bụkwa nke onye ọrụ ahụ nwere ike ịchọta.
const deals = (await NeboAppSDK.storage.getItem('deals')) ?? [];
deals.push({ name: 'Example renewal', closes: '2026-10-31' });
await NeboAppSDK.storage.setItem('deals', deals); | Oku | Omume |
|---|---|
storage.getItem(key) | Kpọmkwem ihe setItem chekwara (object, ndepụta, nọmba ma ọ bụ string), ma ọ bụ null. |
storage.setItem(key, value) | Na-echekwa uru JSON ọ bụla. |
storage.removeItem(key) | Na-ewepụ otu igodo; ọ naghị apụtakwa na keys(). |
storage.keys() | Igodo niile. |
storage.clear() | Na-ewepụ igodo niile. |
storage.onChange(handler) | Na-akpọ handler({appId, keys, action, source}) mgbe e dere ihe ọ bụla, site n'aka onye ọrụ ahụ (source: "employee") ma ọ bụ site na windo ọ bụla nke ngwa ahụ meghere emeghe, gụnyere nke a (source: "page"). Na-eweghachi ọrụ na-akwụsị ige ntị. |
Seghachi mgbe data gbanwere, onye ọ bụla gbanwere ya:
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();
}); Naanị onye ọrụ ngwa ahụ n'onwe ya na-eru ebe nchekwa a, naanị maka ngwa nke ya; onye ọrụ ọzọ na-ajụ onye ọrụ ngwa ahụ. Họrọ igodo akụkụ abụọ nwere ike ịchọta (otu igodo na-ejide ndepụta, ma ọ bụ otu igodo kwa ndekọ n'okpuru prefix dị ka deal:42) ma kọwaa ha na ntụziaka onye ọrụ ahụ. String bụ JSON ziri ezi n'onwe ya, dị ka "42", na-alọghachi e nyochachaala ya, ya mere kechie ya n'ime object ma ọ bụrụ na ụdị ya dị mkpa. Mee ka uru ọ bụla dị nnọọ obere karịa 2 MB; setItem anaghị atụpụ njehie mgbe a jụrụ ide ihe.
agents
Jụọ onye ọrụ ngwa ahụ, ma ọ bụ onye ọrụ ọzọ, ma nweta azịza ya. Ịjụ onye ọrụ ọzọ chọrọ 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;
} | Oku | Na-eweghachi |
|---|---|
agents.invoke(message, {agent, data}) | {text, tools} mgbe onye ọrụ ahụ mechara. |
agents.stream(message, {agent, data}) | Async iterator nke {text, done}. |
janus
Oku ụdị AI ozugbo na-enweghị àgwà, ncheta ma ọ bụ ngwaọrụ.
| Oku | Na-eweghachi |
|---|---|
janus.complete({messages, model, temperature, max_tokens, system}) | Ederede azịza dị ka string. |
janus.stream(same) | Async iterator nke iberibe ederede. |
decide
Mkpebi nwere ụdị: jụọ ajụjụ ndị nwere aha banyere data ụfọdụ ma nweta azịza ọ bụla ya na probability na ntụkwasị obi, n'otu oku ngwa ngwa. Ọ dịghị ihe e dere dị ka ederede, ya mere jiri ya maka ikpe (onye ahịa a ọ dị njikere, ụdị olee ka tiketi a dị na ya, olee ka o si dị ngwa) ma debe ịgụ ọnụ, ụbọchị na oke na koodu nke gị. Onye ọrụ ngwa ahụ nwere ike ịjụ otu ajụjụ ndị ahụ site na ngwaọrụ decide ya, dịka ọmụmaatụ n'elu ndekọ ngwa ahụ chekwara.
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. | Ụdị ajụjụ | criteria | Azịza |
|---|---|---|
choice | Object nke nhọrọ 2 ruo 255 nwere aha, {option: description}. Gbakwunye nhọrọ mgbapụ dị ka other mgbe ndepụta ahụ ezughị ezu. | choice (nhọrọ a họọrọ), confidence (0 ruo 1) na probabilities kwa nhọrọ. |
score | Ndepụta ọkwa 2 ruo 10 a haziri n'usoro, nke kacha ala buru ụzọ. | score (nkewa, 0 bụ ọkwa mbụ), confidence na probabilities kwa ọkwa. |
noul | Ọ dịghị: ajụjụ ahụ bụ otu nkwupụta a ga-ekpe ikpe. | noul, probability na nkwupụta ahụ bụ eziokwu. Enweghị ntụkwasị obi dị iche. |
decide({state, questions})na-enye{model, answers, usage}, ya na azịza ọ bụla n'okpuru aha i nyere ajụjụ ya.statebụ ederede ma ọ bụ JSON ọ bụla. Mee ka ọ bụrụ naanị mpaghara ajụjụ ndị ahụ chọrọ ma kpọọ mpaghara ndị ahụ aha n'ime backtick n'imeinstructions. Ajụjụ ahụ niile na-ebi nainstructions; aha ajụjụ ahụ na-akara naanị azịza ahụ. A na-ebelata state dị ogologo nke ukwuu n'etiti tupu e zipu ya.- Ọ na-atụpụ njehie nke ozi ya bụ ihe kpatara ya. Njehie ahụ enweghị koodu ọnọdụ, ya mere tụnyere ozi ahụ ma ọ bụrụ na ịchọrọ ịmata ọdịiche dị n'etiti ha:
- Ajụjụ e mebiri emebi, dịka ọmụmaatụ nhọrọ nwere otu nhọrọ (bot ahụ na-aza 400, ya na ihe dị njọ).
- Ọ fọdụghị ọrụ n'akaụntụ onye nwe ya: "You've used all the work included in your account. Choose a plan or add credits to continue." (429). Ịnwaghachi anaghị enyere aka ruo mgbe onye nwe ya gbakwunyere atụmatụ ma ọ bụ kredit.
- Ọtụtụ mkpebi n'otu oge: "Too many decisions at once. Try again in a moment." (429).
- Bot ahụ abanyeghị: "Decisions need NeboAI connected. Sign in to NeboAI and try again." (503).
- Ọrụ mkpebi ahụ dara (502).
- A na-ana akaụntụ NeboAI onye nwe bot ahụ ụgwọ mkpebi dị ka oku ụdị AI ọ bụla. Lee ọnụ ahịa.
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'); Ụzọ dabere na ya na-aga na sidecar ngwa ahụ na /apps/<id>/api/<path>. URL http ma ọ bụ https zuru oke na-agafe proxy Nebo ma chọọ network:<host> ma ọ bụ network:*.
NeboWebSocket
new NeboAppSDK.NeboWebSocket() na-emeghe socket dị ndụ gaa n'onye ọrụ ngwa ahụ ma na-ejikọghachi ya na nchere. Ọ naghị ewere arụmụka ọ bụla, o nwekwara send(data), close(), onopen, onmessage, onerror na onclose.
surfaces na a2ui
surfaces.connect() na-emeghe ọwa dị ndụ nke ngwa ahụ. Taa ọ na-ebu kaadị mmekọrịta sitere n'aka onye ọrụ ngwa ahụ: kpọọ a2ui.init(processor) na MessageProcessor sitere na @a2ui/web_core, nke ibe gị na-ejikọta (SDK enweghị renderer nke ya). Kaadị na-eru naanị ngwa e mere ya maka ya, ịpị ya na-aga n'aka onye ọrụ ngwa ahụ, ibe e meghere mgbe e zigachara kaadị anaghị anata ya, ya mere debe ihe ibe ahụ ga-egosi mgbe niile na storage.
SDK na-akọwakwa ihe omume nwere ụdị dị ka text_content, state_delta na surface_update, ya na surfaces.on(type, handler), surfaces.send(name, payload) na surfaces.state. Nebo ezigabeghị ibe ngwa ihe omume ndị ahụ, ọ dịghịkwa ihe na-aza send. Maka data dị ndụ, jiri storage.onChange.
chat
Tinye nkata Nebo ya na onye ọrụ ngwa ahụ n'ime ibe ahụ.
NeboAppSDK.chat.mount(document.getElementById('chat'), {
placeholder: 'Ask about a deal',
contextId: 'deal-42'
});
NeboAppSDK.chat.setContext({ deal: 'Example renewal' }); | Oku | Omume |
|---|---|
chat.mount(element, options) | Nhọrọ: placeholder, theme, height, borderless, contextId, scope. |
chat.send(text) | Na-eziga ozi. |
chat.setContext(context) | Na-esetịpụ ọnọdụ onye ọrụ ahụ na-ahụ; null na-ehichapụ ya. |
chat.onMessage(handler) | Na-anata ozi. |
chat.newThread() | Na-amalite thread ọhụrụ. |
chat.unmount() | Na-ewepụ nkata ahụ. |
Nhazi
N'ime Nebo, SDK na-achọta app id na base URL n'onwe ya. Maka ibe a na-enye n'ebe ọzọ, kpọọ nebo.configure({appId, baseUrl}), ma ọ bụ NeboAppSDK.setAppId(id) na NeboAppSDK.setBaseUrl(url). getAppId() na getBaseUrl() na-agụghachi ha.