SDK-ஐ ஏற்றுங்கள்
<script src="/sdk/nebo.global.js"></script>
<script>
const { nebo, identity, storage, agents, janus, decide, chat, surfaces } = NeboAppSDK;
</script> global என்பது NeboAppSDK; nebo global இல்லை. 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) | ஒவ்வொரு எழுதுதலுக்குப் பிறகும் — பணியாளராலோ (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 போன்ற முன்னொட்டின் கீழ் ஒவ்வொரு பதிவுக்கும் ஒரு சாவி), அவற்றைப் பணியாளரின் வழிமுறைகளில் விவரியுங்கள். "42" போலத் தானே செல்லுபடியான JSON ஆக இருக்கும் சரம் பகுக்கப்பட்டுத் திரும்ப வரும், எனவே வகை முக்கியமென்றால் அதை ஒரு பொருளுக்குள் வையுங்கள். ஒவ்வொரு மதிப்பையும் 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
வகையிடப்பட்ட முடிவுகள்: சில தரவைப் பற்றிப் பெயரிடப்பட்ட கேள்விகளைக் கேட்டு, ஒவ்வொரு பதிலையும் நிகழ்தகவுகள் மற்றும் நம்பகத்தன்மையுடன், ஒரே வேகமான அழைப்பில் பெறுங்கள். எதுவும் உரையாக எழுதப்படுவதில்லை, எனவே மதிப்பீடுகளுக்கு (இந்த வாய்ப்பாளர் ஆர்வமாக இருக்கிறாரா, இந்த டிக்கெட் எந்த வகையைச் சேர்ந்தது, எவ்வளவு அவசரம்) இதைப் பயன்படுத்துங்கள், எண்ணுதல், தேதிகள், வரம்புகளை உங்கள் சொந்தக் குறியீட்டில் வையுங்கள். ஆப்பின் பணியாளர் தன் 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-உம். கேள்விகளுக்குத் தேவையான புலங்களை மட்டும் வைத்து, அவற்றைinstructions-க்குள் backtick-களில் பெயரிடுங்கள். முழுக் கேள்வியும்instructions-இல் இருக்கிறது; கேள்வியின் பெயர் பதிலுக்கு லேபிள் மட்டுமே. மிக நீளமான state அனுப்பப்படுவதற்கு முன் நடுவில் சுருக்கப்படும்.- காரணத்தையே செய்தியாகக் கொண்ட ஒரு பிழையை அது எழுப்பும். அந்தப் பிழைக்கு status code இல்லை, எனவே நிலைகளை வேறுபடுத்த வேண்டுமானால் செய்தியை ஒப்பிடுங்கள்:
- தவறான வடிவக் கேள்வி, எடுத்துக்காட்டாக ஒரே விருப்பம் கொண்ட 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>-இல் செல்கிறது. ஒரு முழுமையான 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 போன்ற வகையிடப்பட்ட நிகழ்வுகளையும், 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() அவற்றைத் திரும்பப் படிக்கும்.