NeboAI
NeboAI
شروع کریں

ایپ SDK

ایپ 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

ایپ کے لیے ایک key-value اسٹور۔ اسے 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"، وہ parse ہو کر واپس آتی ہے، اس لیے اگر قسم اہم ہو تو اسے کسی آبجیکٹ میں لپیٹیں۔ ہر قدر کو 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} کا ایک async iterator۔

janus

شخصیت، یادداشت یا ٹولز کے بغیر براہِ راست ماڈل کال۔

کالواپس کرتا ہے
janus.complete({messages, model, temperature, max_tokens, system})جواب کا متن بطور اسٹرنگ۔
janus.stream(same)متن کے ٹکڑوں کا ایک async iterator۔

decide

Typed فیصلے: کسی ڈیٹا کے بارے میں نامزد سوالات پوچھیں اور ہر جواب امکانات اور اعتماد کے ساتھ، ایک تیز کال میں، واپس پائیں۔ کچھ بھی متن کے طور پر نہیں لکھا جاتا، اس لیے اسے فیصلوں کے لیے استعمال کریں (کیا یہ لیڈ گرم ہے، یہ ٹکٹ کس زمرے کا ہے، یہ کتنا فوری ہے) اور گنتی، تاریخیں اور حدیں اپنے کوڈ میں رکھیں۔ ایپ کا ملازم اپنے 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۔
score2 سے 10 ترتیب وار سطحوں کی فہرست، سب سے نچلی پہلے۔score (کسری، 0 پہلی سطح ہے)، confidence اور ہر سطح کے لیے probabilities۔
noulکچھ نہیں: سوال جانچنے کے لیے ایک بیان ہے۔noul، اس بات کا امکان کہ بیان درست ہے۔ کوئی الگ اعتماد نہیں۔
  • decide({state, questions}) کا نتیجہ {model, answers, usage} ہوتا ہے، جس میں ہر جواب اسی نام کے تحت ہوتا ہے جو آپ نے اس کے سوال کو دیا۔
  • state متن یا کوئی بھی JSON ہے۔ اسے انہی فیلڈز تک محدود رکھیں جو سوالات کو درکار ہیں اور instructions کے اندر backticks میں ان فیلڈز کے نام لکھیں۔ پورا سوال instructions میں ہوتا ہے؛ سوال کا نام صرف جواب پر لیبل لگاتا ہے۔ بہت لمبی state بھیجنے سے پہلے درمیان سے مختصر کر دی جاتی ہے۔
  • یہ ایک خرابی پھینکتا ہے جس کا پیغام ہی وجہ ہوتا ہے۔ خرابی کا کوئی اسٹیٹس کوڈ نہیں ہوتا، اس لیے اگر آپ کو صورتوں میں فرق کرنا ہو تو پیغام کا موازنہ کریں:
    • غلط بنا ہوا سوال، مثلاً ایک اختیار والا انتخاب (بوٹ 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');

رشتہ دار راستہ ایپ کے سائیڈکار کو /apps/<id>/api/<path> پر جاتا ہے۔ مطلق http یا https URL، Nebo کی پراکسی سے گزرتا ہے اور اسے network:<host> یا network:* درکار ہے۔

NeboWebSocket

new NeboAppSDK.NeboWebSocket() ایپ کے ملازم کے ساتھ ایک لائیو ساکٹ کھولتا ہے اور backoff کے ساتھ دوبارہ جڑتا ہے۔ یہ کوئی آرگیومنٹ نہیں لیتا اور اس میں 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 جیسے typed ایونٹس بھی متعین کرتا ہے، ساتھ میں 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() انہیں واپس پڑھتے ہیں۔