โหลด SDK
<script src="/sdk/nebo.global.js"></script>
<script>
const { nebo, identity, storage, agents, janus, decide, chat, surfaces } = NeboAppSDK;
</script> ตัวแปรส่วนกลางคือ NeboAppSDK ไม่มีตัวแปรส่วนกลาง nebo NeboAppSDK.nebo คืออินสแตนซ์ของ SDK และทุกโมดูลถูก export ที่ระดับบนสุดด้วย ดังนั้น NeboAppSDK.storage และ NeboAppSDK.nebo.storage จึงเป็นออบเจกต์เดียวกัน เพื่อไม่ให้บดบังของเบราว์เซอร์ nebo.fetch จึงถูก export เป็น neboFetch และ nebo.WebSocket เป็น NeboWebSocket
identity
| การเรียก | ค่าที่ส่งกลับ |
|---|---|
identity.get() | {id, name, displayName, description, persona, model, skills, inputValues} สำหรับพนักงานของแอป มีการแคช |
identity.invalidate() | ล้างแคช |
storage
ที่เก็บแบบคีย์-ค่าสำหรับแอป ต้องใช้ storage:readwrite เป็นที่เก็บเดียวกับที่พนักงานของแอปอ่านและแก้ไข ข้อมูลที่เจ้าของเพิ่มโดยคุยกับพนักงานจะแสดงบนหน้า และข้อมูลที่พิมพ์ลงในหน้าก็เป็นข้อมูลที่พนักงานค้นหาได้
const deals = (await NeboAppSDK.storage.getItem('deals')) ?? [];
deals.push({ name: 'Example renewal', closes: '2026-10-31' });
await NeboAppSDK.storage.setItem('deals', deals); | การเรียก | พฤติกรรม |
|---|---|
storage.getItem(key) | ค่าที่ setItem เก็บไว้ตรงตามนั้น (ออบเจกต์ ลิสต์ ตัวเลข หรือสตริง) หรือ null |
storage.setItem(key, value) | เก็บค่า JSON ใดก็ได้ |
storage.removeItem(key) | ลบหนึ่งคีย์ คีย์นั้นจะไม่ปรากฏใน keys() อีก |
storage.keys() | คีย์ทั้งหมด |
storage.clear() | ลบทุกคีย์ |
storage.onChange(handler) | เรียก handler({appId, keys, action, source}) หลังทุกการเขียน ไม่ว่าจะโดยพนักงาน (source: "employee") หรือโดยหน้าต่างใด ๆ ของแอปที่เปิดอยู่ รวมถึงหน้าต่างนี้ (source: "page") ส่งกลับฟังก์ชันที่ใช้หยุดการรอรับ |
วาดใหม่เมื่อข้อมูลเปลี่ยน ไม่ว่าใครจะเป็นคนเปลี่ยน:
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();
}); มีเพียงพนักงานของแอปเองที่เข้าถึงที่เก็บนี้ได้ และเฉพาะสำหรับแอปของตัวเองเท่านั้น พนักงานคนอื่นต้องถามพนักงานของแอป เลือกคีย์ที่ทั้งสองฝ่ายค้นหาได้ (คีย์เดียวที่เก็บลิสต์ หรือหนึ่งคีย์ต่อหนึ่งรายการภายใต้คำนำหน้า เช่น deal:42) และอธิบายไว้ในคำแนะนำของพนักงาน สตริงที่เป็น JSON ที่ถูกต้องอยู่แล้ว เช่น "42" จะถูกแปลงกลับมา ดังนั้นให้ห่อไว้ในออบเจกต์หากประเภทข้อมูลสำคัญ ให้แต่ละค่ามีขนาดต่ำกว่า 2 MB มาก ๆ setItem จะไม่โยนข้อผิดพลาดเมื่อการเขียนถูกปฏิเสธ
agents
ถามพนักงานของแอปหรือพนักงานคนอื่น แล้วรับคำตอบ การถามพนักงานคนอื่นต้องใช้ 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;
} | การเรียก | ค่าที่ส่งกลับ |
|---|---|
agents.invoke(message, {agent, data}) | {text, tools} เมื่อพนักงานทำเสร็จ |
agents.stream(message, {agent, data}) | async iterator ของ {text, done} |
janus
การเรียกโมเดลโดยตรง โดยไม่มีบุคลิก ความทรงจำ หรือเครื่องมือ
| การเรียก | ค่าที่ส่งกลับ |
|---|---|
janus.complete({messages, model, temperature, max_tokens, system}) | ข้อความตอบกลับเป็นสตริง |
janus.stream(same) | async iterator ของส่วนข้อความ |
decide
การตัดสินใจแบบมีประเภท: ถามคำถามที่ตั้งชื่อไว้เกี่ยวกับข้อมูลบางอย่าง แล้วได้คำตอบแต่ละข้อกลับมาพร้อมความน่าจะเป็นและความมั่นใจ ในการเรียกที่รวดเร็วครั้งเดียว ไม่มีอะไรถูกเขียนเป็นข้อความ จึงเหมาะสำหรับการตัดสิน (ลูกค้าเป้าหมายนี้น่าสนใจไหม ทิกเก็ตนี้อยู่หมวดไหน ด่วนแค่ไหน) ส่วนการนับ วันที่ และเกณฑ์ให้เก็บไว้ในโค้ดของคุณเอง พนักงานของแอปถามคำถามเดียวกันได้ด้วยเครื่องมือ decide เช่น กับข้อมูลที่แอปจัดเก็บไว้
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. | ประเภทคำถาม | criteria | คำตอบ |
|---|---|---|
choice | ออบเจกต์ของตัวเลือกที่ตั้งชื่อไว้ 2 ถึง 255 รายการ {option: description} เพิ่มตัวเลือกสำรอง เช่น other เมื่อลิสต์ยังไม่ครบ | choice (ตัวเลือกที่เลือก), confidence (0 ถึง 1) และ probabilities ต่อตัวเลือก |
score | ลิสต์ของระดับที่เรียงลำดับ 2 ถึง 10 ระดับ เริ่มจากต่ำสุด | score (ค่าทศนิยม 0 คือระดับแรก), confidence และ probabilities ต่อระดับ |
noul | ไม่มี: คำถามคือข้อความหนึ่งข้อที่ต้องตัดสิน | noul ความน่าจะเป็นที่ข้อความนั้นเป็นจริง ไม่มีค่าความมั่นใจแยก |
decide({state, questions})จะคืนค่าเป็น{model, answers, usage}โดยแต่ละคำตอบอยู่ภายใต้ชื่อที่คุณตั้งให้คำถามนั้นstateเป็นข้อความหรือ JSON ใดก็ได้ ใส่เฉพาะฟิลด์ที่คำถามต้องใช้ และระบุชื่อฟิลด์เหล่านั้นใน backtick ภายในinstructionsคำถามทั้งหมดอยู่ในinstructionsชื่อของคำถามเป็นเพียงป้ายกำกับคำตอบ state ที่ยาวมากจะถูกตัดตรงกลางก่อนส่ง- จะเกิดข้อผิดพลาดซึ่งข้อความระบุเหตุผล ข้อผิดพลาดไม่มีรหัสสถานะ ดังนั้นหากต้องแยกแยะกรณีต่าง ๆ ให้เปรียบเทียบข้อความ:
- คำถามที่รูปแบบไม่ถูกต้อง เช่น choice ที่มีตัวเลือกเดียว (บอทตอบ 400 พร้อมบอกว่าผิดตรงไหน)
- ไม่มีงานเหลือในบัญชีของเจ้าของ: "คุณใช้งานที่รวมอยู่ในบัญชีครบแล้ว เลือกแพ็กเกจหรือเติมเครดิตเพื่อดำเนินการต่อ" (429) การลองใหม่จะไม่ช่วยจนกว่าเจ้าของจะเพิ่มแพ็กเกจหรือเครดิต
- การตัดสินใจพร้อมกันมากเกินไป: "การตัดสินใจพร้อมกันมากเกินไป โปรดลองอีกครั้งในอีกสักครู่" (429)
- บอทไม่ได้ลงชื่อเข้าใช้: "การตัดสินใจต้องเชื่อมต่อ NeboAI ลงชื่อเข้าใช้ NeboAI แล้วลองอีกครั้ง" (503)
- บริการตัดสินใจล้มเหลว (502)
- การตัดสินใจคิดค่าบริการกับบัญชี NeboAI ของเจ้าของบอทเหมือนการเรียกโมเดลทั่วไป ดูราคา
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'); พาธแบบสัมพัทธ์จะไปที่ sidecar ของแอปที่ /apps/<id>/api/<path> URL http หรือ https แบบสัมบูรณ์จะผ่านพร็อกซีของ Nebo และต้องใช้ network:<host> หรือ network:*
NeboWebSocket
new NeboAppSDK.NeboWebSocket() เปิด socket แบบสดไปยังพนักงานของแอปและเชื่อมต่อใหม่ด้วย backoff ไม่รับอาร์กิวเมนต์ และมี send(data), close(), onopen, onmessage, onerror และ onclose
surfaces และ a2ui
surfaces.connect() เปิดช่องทางสดของแอป ปัจจุบันใช้ส่งการ์ดแบบโต้ตอบจากพนักงานของแอป เรียก a2ui.init(processor) พร้อม MessageProcessor จาก @a2ui/web_core ซึ่งหน้าของคุณต้องรวมไว้เอง (SDK ไม่มีตัวเรนเดอร์ของตัวเอง) การ์ดจะไปถึงเฉพาะแอปที่สร้างการ์ดนั้น การคลิกการ์ดจะส่งไปยังพนักงานของแอปนั้น และหน้าที่เปิดหลังจากส่งการ์ดไปแล้วจะไม่ได้รับการ์ดนั้น ดังนั้นให้เก็บสิ่งที่หน้าต้องแสดงเสมอไว้ใน storage
SDK ยังกำหนดเหตุการณ์แบบมีประเภท เช่น text_content, state_delta และ surface_update พร้อม surfaces.on(type, handler), surfaces.send(name, payload) และ surfaces.state Nebo ยังไม่ส่งเหตุการณ์เหล่านั้นไปยังหน้าแอป และยังไม่มีอะไรตอบ send สำหรับข้อมูลสด ให้ใช้ storage.onChange
chat
ฝังแชทของ Nebo กับพนักงานของแอปไว้ในหน้า
NeboAppSDK.chat.mount(document.getElementById('chat'), {
placeholder: 'Ask about a deal',
contextId: 'deal-42'
});
NeboAppSDK.chat.setContext({ deal: 'Example renewal' }); | การเรียก | พฤติกรรม |
|---|---|
chat.mount(element, options) | ตัวเลือก: placeholder, theme, height, borderless, contextId, scope |
chat.send(text) | ส่งข้อความ |
chat.setContext(context) | ตั้งบริบทที่พนักงานเห็น null จะล้างบริบท |
chat.onMessage(handler) | รับข้อความ |
chat.newThread() | เริ่มเธรดใหม่ |
chat.unmount() | นำแชทออก |
การกำหนดค่า
ภายใน Nebo SDK จะหา app id และ base URL ได้เอง สำหรับหน้าที่ให้บริการจากที่อื่น ให้เรียก nebo.configure({appId, baseUrl}) หรือ NeboAppSDK.setAppId(id) และ NeboAppSDK.setBaseUrl(url) ส่วน getAppId() และ getBaseUrl() ใช้อ่านค่ากลับมา