Muat SDK
<script src="/sdk/nebo.global.js"></script>
<script>
const { nebo, identity, storage, agents, janus, decide, chat, surfaces } = NeboAppSDK;
</script> Global-nya adalah NeboAppSDK; tidak ada global nebo. NeboAppSDK.nebo adalah instance SDK, dan setiap modul juga diekspor di tingkat teratas, sehingga NeboAppSDK.storage dan NeboAppSDK.nebo.storage adalah objek yang sama. Agar tidak menutupi milik browser, nebo.fetch diekspor sebagai neboFetch dan nebo.WebSocket sebagai NeboWebSocket.
identity
| Panggilan | Mengembalikan |
|---|---|
identity.get() | {id, name, displayName, description, persona, model, skills, inputValues} untuk karyawan aplikasi. Di-cache. |
identity.invalidate() | Menghapus cache. |
storage
Penyimpanan key-value untuk aplikasi. Memerlukan storage:readwrite. Ini adalah penyimpanan yang sama yang dibaca dan diubah oleh karyawan aplikasi: catatan yang ditambahkan pemilik dengan berbicara kepada karyawan akan tampil di halaman, dan catatan yang diketik di halaman dapat ditemukan oleh karyawan.
const deals = (await NeboAppSDK.storage.getItem('deals')) ?? [];
deals.push({ name: 'Example renewal', closes: '2026-10-31' });
await NeboAppSDK.storage.setItem('deals', deals); | Panggilan | Perilaku |
|---|---|
storage.getItem(key) | Persis apa yang disimpan setItem (objek, daftar, angka, atau string), atau null. |
storage.setItem(key, value) | Menyimpan nilai JSON apa pun. |
storage.removeItem(key) | Menghapus satu key; key itu tidak lagi muncul di keys(). |
storage.keys() | Semua key. |
storage.clear() | Menghapus setiap key. |
storage.onChange(handler) | Memanggil handler({appId, keys, action, source}) setelah setiap penulisan, oleh karyawan (source: "employee") atau oleh jendela aplikasi mana pun yang terbuka, termasuk yang ini (source: "page"). Mengembalikan fungsi yang menghentikan pemantauan. |
Gambar ulang saat data berubah, siapa pun 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 karyawan aplikasi itu sendiri yang dapat menjangkau penyimpanan ini, dan hanya untuk aplikasinya sendiri; karyawan lain bertanya kepada karyawan aplikasi. Pilih key yang dapat ditemukan kedua pihak (satu key berisi daftar, atau satu key per catatan dengan prefiks seperti deal:42) dan jelaskan di instruksi karyawan. String yang dengan sendirinya adalah JSON valid, seperti "42", akan kembali dalam bentuk yang sudah di-parse, jadi bungkus dalam objek jika tipenya penting. Jaga setiap nilai jauh di bawah 2 MB; setItem tidak melempar error saat penulisan ditolak.
agents
Bertanya kepada karyawan aplikasi, atau karyawan lain, dan dapatkan jawabannya. Bertanya kepada karyawan 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} saat karyawan selesai. |
agents.stream(message, {agent, data}) | Async iterator berisi {text, done}. |
janus
Panggilan model langsung tanpa persona, memori, atau alat.
| Panggilan | Mengembalikan |
|---|---|
janus.complete({messages, model, temperature, max_tokens, system}) | Teks balasan sebagai string. |
janus.stream(same) | Async iterator berisi potongan teks. |
decide
Keputusan bertipe: ajukan pertanyaan bernama tentang suatu data dan dapatkan setiap jawaban beserta probabilitas dan tingkat keyakinan, dalam satu panggilan cepat. Tidak ada yang ditulis sebagai teks, jadi gunakan untuk penilaian (apakah prospek ini panas, tiket ini masuk kategori apa, seberapa mendesak) dan tetap lakukan penghitungan, tanggal, dan ambang batas di kode Anda sendiri. Karyawan aplikasi dapat mengajukan pertanyaan yang sama dengan alat decide miliknya, misalnya atas catatan yang disimpan 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. | Tipe pertanyaan | criteria | Jawaban |
|---|---|---|
choice | Objek berisi 2 hingga 255 opsi bernama, {option: description}. Tambahkan opsi cadangan seperti other jika daftarnya belum lengkap. | choice (opsi yang dipilih), confidence (0 hingga 1), dan probabilities per opsi. |
score | Daftar berisi 2 hingga 10 level berurutan, dimulai dari yang terendah. | score (pecahan, 0 adalah level pertama), confidence, dan probabilities per level. |
noul | Tidak ada: pertanyaannya adalah satu pernyataan untuk dinilai. | noul, probabilitas bahwa pernyataan itu benar. Tanpa tingkat keyakinan terpisah. |
decide({state, questions})menghasilkan{model, answers, usage}, dengan setiap jawaban berada di bawah nama yang Anda berikan untuk pertanyaannya.stateberupa teks atau JSON apa pun. Batasi pada field yang dibutuhkan pertanyaan dan sebutkan field tersebut dalam backtick di dalaminstructions. Seluruh pertanyaan berada diinstructions; nama pertanyaan hanya menjadi label jawaban. State yang sangat panjang dipersingkat di bagian tengahnya sebelum dikirim.- Fungsi ini melempar error yang pesannya berisi alasannya. Error tidak memiliki kode status, jadi bandingkan pesannya jika Anda perlu membedakan kasusnya:
- Pertanyaan yang salah bentuk, misalnya pilihan dengan satu opsi (bot menjawab 400, beserta apa yang salah).
- Tidak ada pekerjaan tersisa di akun pemilik: "Anda telah menggunakan semua pekerjaan yang termasuk dalam akun Anda. Pilih paket atau tambahkan kredit untuk melanjutkan." (429). Mencoba ulang tidak membantu sampai pemilik menambahkan paket atau kredit.
- Terlalu banyak keputusan sekaligus: "Terlalu banyak keputusan sekaligus. Coba lagi sebentar lagi." (429).
- Bot belum masuk: "Keputusan memerlukan NeboAI yang terhubung. Masuk ke NeboAI dan coba lagi." (503).
- Layanan keputusan gagal (502).
- Keputusan ditagihkan ke akun NeboAI pemilik bot seperti panggilan model lainnya. 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'); Path relatif diarahkan ke sidecar aplikasi di /apps/<id>/api/<path>. URL http atau https absolut melewati proxy Nebo dan memerlukan network:<host> atau network:*.
NeboWebSocket
new NeboAppSDK.NeboWebSocket() membuka socket langsung ke karyawan aplikasi dan menyambung ulang dengan backoff. Tidak menerima argumen dan memiliki send(data), close(), onopen, onmessage, onerror, dan onclose.
surfaces dan a2ui
surfaces.connect() membuka kanal langsung aplikasi. Saat ini kanal itu membawa kartu interaktif dari karyawan aplikasi: panggil a2ui.init(processor) dengan MessageProcessor dari @a2ui/web_core, yang dibundel oleh halaman Anda (SDK tidak memiliki renderer sendiri). Kartu hanya sampai ke aplikasi yang menjadi tujuannya, klik pada kartu diteruskan ke karyawan aplikasi itu, dan halaman yang dibuka setelah kartu dikirim tidak menerimanya, jadi simpan apa yang harus selalu ditampilkan halaman di storage.
SDK juga mendefinisikan event bertipe seperti text_content, state_delta, dan surface_update, dengan surfaces.on(type, handler), surfaces.send(name, payload), dan surfaces.state. Nebo belum mengirim event tersebut ke halaman aplikasi, dan belum ada yang menjawab send. Untuk data langsung, gunakan storage.onChange.
chat
Sematkan obrolan Nebo dengan karyawan aplikasi di halaman.
NeboAppSDK.chat.mount(document.getElementById('chat'), {
placeholder: 'Ask about a deal',
contextId: 'deal-42'
});
NeboAppSDK.chat.setContext({ deal: 'Example renewal' }); | Panggilan | Perilaku |
|---|---|
chat.mount(element, options) | Opsi: placeholder, theme, height, borderless, contextId, scope. |
chat.send(text) | Mengirim pesan. |
chat.setContext(context) | Mengatur konteks yang dilihat karyawan; null menghapusnya. |
chat.onMessage(handler) | Menerima pesan. |
chat.newThread() | Memulai utas baru. |
chat.unmount() | Menghapus obrolan. |
Konfigurasi
Di dalam Nebo, SDK menemukan id aplikasi dan URL dasar 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 kembali.