Muatkan SDK
<script src="/sdk/nebo.global.js"></script>
<script>
const { nebo, identity, storage, agents, janus, decide, chat, surfaces } = NeboAppSDK;
</script> Globalnya ialah NeboAppSDK; tiada global nebo. NeboAppSDK.nebo ialah instans SDK, dan setiap modul juga dieksport pada peringkat atas, jadi NeboAppSDK.storage dan NeboAppSDK.nebo.storage ialah objek yang sama. Untuk mengelakkan membayangi pelayar, nebo.fetch dieksport sebagai neboFetch dan nebo.WebSocket sebagai NeboWebSocket.
identity
| Panggilan | Mengembalikan |
|---|---|
identity.get() | {id, name, displayName, description, persona, model, skills, inputValues} untuk pekerja aplikasi. Dicache. |
identity.invalidate() | Mengosongkan cache. |
storage
Stor kunci-nilai untuk aplikasi. Ia memerlukan storage:readwrite. Ia ialah stor yang sama yang dibaca dan diubah oleh pekerja aplikasi: rekod yang ditambah oleh pemilik dengan bercakap kepada pekerja dipaparkan pada halaman, dan rekod yang ditaip ke dalam halaman boleh ditemui oleh pekerja.
const deals = (await NeboAppSDK.storage.getItem('deals')) ?? [];
deals.push({ name: 'Example renewal', closes: '2026-10-31' });
await NeboAppSDK.storage.setItem('deals', deals); | Panggilan | Tingkah laku |
|---|---|
storage.getItem(key) | Tepat seperti yang disimpan oleh setItem (objek, senarai, nombor atau rentetan), atau null. |
storage.setItem(key, value) | Menyimpan sebarang nilai JSON. |
storage.removeItem(key) | Membuang satu kunci; ia tidak lagi muncul dalam keys(). |
storage.keys() | Semua kunci. |
storage.clear() | Membuang setiap kunci. |
storage.onChange(handler) | Memanggil handler({appId, keys, action, source}) selepas setiap penulisan, oleh pekerja (source: "employee") atau oleh mana-mana tetingkap aplikasi yang terbuka, termasuk tetingkap ini (source: "page"). Mengembalikan fungsi yang menghentikan pendengaran. |
Lukis semula apabila data berubah, tidak kira siapa yang mengubahnya:
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();
}); Hanya pekerja aplikasi itu sendiri yang mencapai stor ini, dan hanya untuk aplikasinya sendiri; pekerja lain bertanya kepada pekerja aplikasi. Pilih kunci yang boleh ditemui oleh kedua-dua pihak (satu kunci yang memegang senarai, atau satu kunci bagi setiap rekod di bawah awalan seperti deal:42) dan terangkannya dalam arahan pekerja. Rentetan yang dengan sendirinya JSON sah, seperti "42", dikembalikan dalam bentuk yang telah dihurai, jadi balutnya dalam objek jika jenis itu penting. Pastikan setiap nilai jauh di bawah 2 MB; setItem tidak melontar ralat apabila penulisan ditolak.
agents
Tanya pekerja aplikasi, atau pekerja lain, dan dapatkan jawapannya. Bertanya kepada pekerja lain memerlukan 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;
} | Panggilan | Mengembalikan |
|---|---|
agents.invoke(message, {agent, data}) | {text, tools} apabila pekerja selesai. |
agents.stream(message, {agent, data}) | Iterator tak segerak bagi {text, done}. |
janus
Panggilan model terus tanpa persona, memori atau alat.
| Panggilan | Mengembalikan |
|---|---|
janus.complete({messages, model, temperature, max_tokens, system}) | Teks balasan sebagai rentetan. |
janus.stream(same) | Iterator tak segerak bagi cebisan teks. |
decide
Keputusan berjenis: tanya soalan bernama tentang sesuatu data dan dapatkan setiap jawapan kembali bersama kebarangkalian dan keyakinan, dalam satu panggilan pantas. Tiada apa yang ditulis sebagai teks, jadi gunakannya untuk pertimbangan (adakah prospek ini panas, kategori mana tiket ini tergolong, betapa mendesaknya ia) dan kekalkan pengiraan, tarikh dan ambang dalam kod anda sendiri. Pekerja aplikasi boleh bertanya soalan yang sama dengan alat decidenya, contohnya ke atas rekod yang disimpan oleh aplikasi.
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. | Jenis soalan | criteria | Jawapan |
|---|---|---|
choice | Objek 2 hingga 255 pilihan bernama, {option: description}. Tambah pilihan keluar seperti other apabila senarai tidak lengkap. | choice (pilihan yang dipilih), confidence (0 hingga 1) dan probabilities bagi setiap pilihan. |
score | Senarai 2 hingga 10 tahap tersusun, yang terendah dahulu. | score (pecahan, 0 ialah tahap pertama), confidence dan probabilities bagi setiap tahap. |
noul | Tiada: soalan itu ialah satu kenyataan untuk dinilai. | noul, kebarangkalian kenyataan itu benar. Tiada keyakinan berasingan. |
decide({state, questions})menghasilkan{model, answers, usage}, dengan setiap jawapan di bawah nama yang anda berikan kepada soalannya.stateialah teks atau sebarang JSON. Hadkannya kepada medan yang diperlukan oleh soalan dan namakan medan tersebut dalam tanda backtick di dalaminstructions. Keseluruhan soalan berada dalaminstructions; nama soalan hanya melabelkan jawapan. State yang sangat panjang dipendekkan di bahagian tengah sebelum dihantar.- Ia melontarkan ralat yang mesejnya ialah sebabnya. Ralat itu tiada kod status, jadi bandingkan mesejnya jika anda perlu membezakan kes-kesnya:
- Soalan yang cacat, contohnya pilihan dengan satu opsyen sahaja (bot menjawab 400, bersama apa yang salah).
- Tiada kerja berbaki dalam akaun pemilik: "You've used all the work included in your account. Choose a plan or add credits to continue." (429). Mencuba semula tidak membantu sehingga pemilik menambah pelan atau kredit.
- Terlalu banyak keputusan serentak: "Too many decisions at once. Try again in a moment." (429).
- Bot tidak log masuk: "Decisions need NeboAI connected. Sign in to NeboAI and try again." (503).
- Perkhidmatan keputusan gagal (502).
- Keputusan dibilkan kepada akaun NeboAI pemilik bot seperti mana-mana panggilan model. Lihat harga.
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'); Laluan relatif pergi ke sidecar aplikasi di /apps/<id>/api/<path>. URL http atau https mutlak melalui proksi Nebo dan memerlukan network:<host> atau network:*.
NeboWebSocket
new NeboAppSDK.NeboWebSocket() membuka soket langsung kepada pekerja aplikasi dan menyambung semula dengan pengunduran. Ia tidak menerima argumen dan mempunyai send(data), close(), onopen, onmessage, onerror dan onclose.
surfaces dan a2ui
surfaces.connect() membuka saluran langsung aplikasi. Hari ini ia membawa kad interaktif daripada pekerja aplikasi: panggil a2ui.init(processor) dengan MessageProcessor daripada @a2ui/web_core, yang dibundel oleh halaman anda (SDK tidak mempunyai pemapar sendiri). Kad hanya sampai ke aplikasi yang ia dibuat untuknya, klik padanya pergi kepada pekerja aplikasi itu, dan halaman yang dibuka selepas kad dihantar tidak menerimanya, jadi simpan apa yang mesti sentiasa dipaparkan oleh halaman dalam storan.
SDK juga mentakrifkan peristiwa berjenis seperti text_content, state_delta dan surface_update, dengan surfaces.on(type, handler), surfaces.send(name, payload) dan surfaces.state. Nebo belum menghantar peristiwa tersebut ke halaman aplikasi, dan tiada apa yang menjawab send. Untuk data langsung, gunakan storage.onChange.
chat
Benamkan sembang Nebo dengan pekerja aplikasi dalam halaman.
NeboAppSDK.chat.mount(document.getElementById('chat'), {
placeholder: 'Ask about a deal',
contextId: 'deal-42'
});
NeboAppSDK.chat.setContext({ deal: 'Example renewal' }); | Panggilan | Tingkah laku |
|---|---|
chat.mount(element, options) | Pilihan: placeholder, theme, height, borderless, contextId, scope. |
chat.send(text) | Menghantar mesej. |
chat.setContext(context) | Menetapkan konteks yang dilihat oleh pekerja; null mengosongkannya. |
chat.onMessage(handler) | Menerima mesej. |
chat.newThread() | Memulakan bebenang baharu. |
chat.unmount() | Membuang sembang. |
Konfigurasi
Di dalam Nebo, SDK mencari id aplikasi dan URL asas dengan sendirinya. Untuk halaman yang disajikan di tempat lain, panggil nebo.configure({appId, baseUrl}), atau NeboAppSDK.setAppId(id) dan NeboAppSDK.setBaseUrl(url). getAppId() dan getBaseUrl() membacanya semula.