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) | キーを1つ削除します。そのキーは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();
}); このストアにアクセスできるのはアプリ自身の社員だけで、それも自分のアプリに限られます。他の社員は、アプリの社員に問い合わせます。双方が見つけられるキーを選び(リストを持つ1つのキー、またはdeal:42のようなプレフィックス付きで記録ごとに1つのキー)、社員の指示にそのキーを記述してください。"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}の非同期イテレーター。 |
janus
ペルソナ、メモリ、ツールなしでのモデルの直接呼び出し。
| 呼び出し | 戻り値 |
|---|---|
janus.complete({messages, model, temperature, max_tokens, system}) | 文字列としての返信テキスト。 |
janus.stream(same) | テキストのチャンクの非同期イテレーター。 |
decide
型付きの判定: データについて名前付きの質問をして、それぞれの答えを確率と確信度付きで、1回の高速な呼び出しで受け取ります。文章としては何も書かれないので、判断(この見込み客は有望か、このチケットはどのカテゴリーか、どのくらい緊急か)に使い、数の集計、日付、しきい値は自分のコードで扱ってください。アプリの社員も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 | なし: 質問は判断すべき1つの記述です。 | noul: その記述が成り立つ確率。確信度は別にありません。 |
decide({state, questions})は{model, answers, usage}に解決され、各回答は質問に付けた名前の下に入ります。stateはテキストまたは任意のJSONです。質問に必要なフィールドだけに絞り、instructionsの中でそのフィールド名をバッククォートで囲んで示してください。質問の内容はすべてinstructionsに入れます。質問の名前は答えのラベルにすぎません。非常に長いstateは、送信前に中央部分が短縮されます。- 理由をメッセージに持つエラーをスローします。エラーにはステータスコードがないため、ケースを区別する必要がある場合はメッセージを比較してください:
- 不正な形式の質問。たとえば選択肢が1つしかない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'); 相対パスは、/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() で値を読み取れます。