NeboAI
NeboAI
Бастау

App SDK

App SDK қолданба бетін Nebo-ға қосады. Бұл — Nebo әр қолданбаға ұсынатын бір скрипт, ол бетке бір жаһандық нысан — NeboAppSDK қосады. Ештеңе орнатудың немесе жинаудың қажеті жоқ.

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 данасы, ал әр модуль жоғарғы деңгейде де экспортталады, сондықтан 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)Қызметкер (source: "employee") немесе қолданбаның кез келген ашық терезесі, соның ішінде осы терезе (source: "page") әр жазғаннан кейін handler({appId, keys, action, source}) шақырады. Тыңдауды тоқтататын функцияны қайтарады.

Деректер өзгергенде, кім өзгертсе де, қайта салыңыз:

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}){text, done} асинхронды итераторы.

janus

Тұлғасыз, жадысыз немесе құралдарсыз модельді тікелей шақыру.

ШақыруҚайтарады
janus.complete({messages, model, temperature, max_tokens, system})Жауап мәтіні жол ретінде.
janus.stream(same)Мәтін бөліктерінің асинхронды итераторы.

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Жауап
choice2-ден 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. Оны сұрақтарға қажет өрістермен шектеңіз және сол өрістерді instructions ішінде кері тырнақшаларда атаңыз. Бүкіл сұрақ instructions ішінде тұрады; сұрақтың атауы тек жауапты белгілейді. Тым ұзын state жіберілмес бұрын ортасынан қысқартылады.
  • Ол хабарламасында себебі көрсетілген қате шығарады. Қатеде статус коды жоқ, сондықтан жағдайларды ажырату керек болса, хабарламаны салыстырыңыз:
    • Қате құрылған сұрақ, мысалы, бір ғана нұсқасы бар таңдау (бот 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).
    • Бот жүйеге кірмеген: "Decisions need NeboAI connected. Sign in to NeboAI and try again." (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> мекенжайы бойынша барады. Абсолюттік http немесе https URL Nebo проксиі арқылы өтеді және network:<host> немесе network:* қажет етеді.

NeboWebSocket

new NeboAppSDK.NeboWebSocket() қолданба қызметкеріне тірі сокет ашады және кідіріспен қайта қосылады. Ол аргумент қабылдамайды және send(data), close(), onopen, onmessage, onerror және onclose мүшелері бар.

surfaces және a2ui

surfaces.connect() қолданбаның тірі арнасын ашады. Бүгін ол қолданба қызметкерінен интерактивті карталарды жеткізеді: бетіңіз өзі жинайтын @a2ui/web_core ішіндегі MessageProcessor-мен a2ui.init(processor) шақырыңыз (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 қолданба id-ін және негізгі URL-ді өзі табады. Басқа жерде орналасқан бет үшін nebo.configure({appId, baseUrl}) немесе NeboAppSDK.setAppId(id) және NeboAppSDK.setBaseUrl(url) шақырыңыз. getAppId() және getBaseUrl() оларды қайта оқиды.