Φόρτωση του SDK
<script src="/sdk/nebo.global.js"></script>
<script>
const { nebo, identity, storage, agents, janus, decide, chat, surfaces } = NeboAppSDK;
</script> Το global είναι το NeboAppSDK· δεν υπάρχει global nebo. Το NeboAppSDK.nebo είναι το στιγμιότυπο του SDK και κάθε module εξάγεται επίσης στο ανώτατο επίπεδο, οπότε τα NeboAppSDK.storage και NeboAppSDK.nebo.storage είναι το ίδιο αντικείμενο. Για να μην επισκιάζονται τα αντίστοιχα του προγράμματος περιήγησης, το nebo.fetch εξάγεται ως 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}) | Ένας ασύγχρονος iterator από {text, done}. |
janus
Μια απευθείας κλήση μοντέλου χωρίς περσόνα, μνήμη ή εργαλεία.
| Κλήση | Επιστρέφει |
|---|---|
janus.complete({messages, model, temperature, max_tokens, system}) | Το κείμενο της απάντησης ως συμβολοσειρά. |
janus.stream(same) | Ένας ασύγχρονος 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. Περιορίστε το στα πεδία που χρειάζονται οι ερωτήσεις και ονομάστε αυτά τα πεδία μέσα σε backticks στοinstructions. Ολόκληρη η ερώτηση βρίσκεται στοinstructions· το όνομα της ερώτησης απλώς ονομάζει την απάντηση. Ένα πολύ μεγάλο state συντομεύεται στη μέση πριν σταλεί. - Προκαλεί ένα σφάλμα του οποίου το μήνυμα είναι η αιτία. Το σφάλμα δεν έχει κωδικό κατάστασης, οπότε συγκρίνετε το μήνυμα αν χρειάζεται να ξεχωρίσετε τις περιπτώσεις:
- Μια κακοσχηματισμένη ερώτηση, για παράδειγμα μια επιλογή με μία μόνο δυνατότητα (το bot απαντά 400, με το τι είναι λάθος).
- Δεν απομένει εργασία στον λογαριασμό του ιδιοκτήτη: "You've used all the work included in your account. Choose a plan or add credits to continue." (429). Η επανάληψη δεν βοηθά μέχρι ο ιδιοκτήτης να προσθέσει πρόγραμμα ή πιστώσεις.
- Πάρα πολλές αποφάσεις ταυτόχρονα: "Too many decisions at once. Try again in a moment." (429).
- Το bot δεν είναι συνδεδεμένο: "Decisions need NeboAI connected. Sign in to NeboAI and try again." (503).
- Η υπηρεσία αποφάσεων απέτυχε (502).
- Οι αποφάσεις χρεώνονται στον λογαριασμό NeboAI του ιδιοκτήτη του bot όπως κάθε κλήση μοντέλου. Δείτε τις τιμές.
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 δεν έχει δικό του renderer). Μια κάρτα φτάνει μόνο στην εφαρμογή για την οποία φτιάχτηκε, ένα κλικ πάνω της πηγαίνει στον υπάλληλο αυτής της εφαρμογής και μια σελίδα που άνοιξε αφού στάλθηκε μια κάρτα δεν τη λαμβάνει, οπότε κρατήστε στο 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 και τη βασική διεύθυνση URL. Για μια σελίδα που εξυπηρετείται αλλού, καλέστε nebo.configure({appId, baseUrl}) ή NeboAppSDK.setAppId(id) και NeboAppSDK.setBaseUrl(url). Τα getAppId() και getBaseUrl() τα διαβάζουν πίσω.