ផ្ទុក 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 គឺជា instance SDK ហើយម៉ូឌុលនីមួយៗក៏ត្រូវបាននាំចេញនៅកម្រិតកំពូលផងដែរ ដូច្នេះ NeboAppSDK.storage និង NeboAppSDK.nebo.storage គឺជាវត្ថុតែមួយ។ ដើម្បីជៀសវាងការគ្របលើកម្មវិធីរុករក nebo.fetch ត្រូវបាននាំចេញជា neboFetch ហើយ nebo.WebSocket ជា NeboWebSocket។
identity
| ការហៅ | ត្រឡប់ |
|---|---|
identity.get() | {id, name, displayName, description, persona, model, skills, inputValues} សម្រាប់បុគ្គលិករបស់កម្មវិធី។ រក្សាក្នុង cache។ |
identity.invalidate() | សម្អាត cache។ |
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 បានរក្សាទុក (object, list, number ឬ string) ឬ 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" ត្រឡប់មកវិញដោយបានញែករួច ដូច្នេះរុំវាក្នុង object ប្រសិនបើប្រភេទសំខាន់។ រក្សាតម្លៃនីមួយៗឱ្យតិចជាង 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 | object នៃជម្រើសដែលមានឈ្មោះពី 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 ដែលវែងខ្លាំងត្រូវបានកាត់ខ្លីនៅកណ្ដាល មុនពេលផ្ញើ។- វាបោះកំហុសមួយដែលសាររបស់វាគឺជាមូលហេតុ។ កំហុសនោះគ្មានលេខកូដស្ថានភាពទេ ដូច្នេះសូមប្រៀបធៀបសារ ប្រសិនបើអ្នកត្រូវការបែងចែកករណីនីមួយៗ៖
- សំណួរដែលមានទម្រង់ខុស ឧទាហរណ៍ជម្រើសដែលមានជម្រើសតែមួយ (បូតឆ្លើយ 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 ដាច់ខាតឆ្លងកាត់ proxy របស់ 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 ដែលទំព័ររបស់អ្នកបញ្ចូលក្នុង bundle (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 និង base URL ដោយខ្លួនឯង។ សម្រាប់ទំព័រដែលបម្រើពីកន្លែងផ្សេង សូមហៅ nebo.configure({appId, baseUrl}) ឬ NeboAppSDK.setAppId(id) និង NeboAppSDK.setBaseUrl(url)។ getAppId() និង getBaseUrl() អានវាត្រឡប់មកវិញ។