NeboAI
NeboAI
はじめる

agent.jsonリファレンス

agent.jsonには、社員について文章以外のすべてが入ります。必要な機能、オーナーへの質問、メモリの保ち方、常に承認が必要な操作、実行するワークフローです。すべてのフィールドは任意です。

例

{
  "requires": {
    "interfaces": ["ledger", "mail"],
    "plugins": [],
    "tools": []
  },
  "skills": ["@example/skills/receipt-capture"],
  "inputs": [
    {
      "key": "invoice_mailbox",
      "label": "Mailbox that receives vendor invoices",
      "type": "text",
      "id": "finance.ap.invoice_mailbox",
      "scope": "company",
      "required": true,
      "missing": "Ask the owner which mailbox to watch before processing invoices."
    }
  ],
  "memory": {
    "mode": "separate",
    "topics": [
      { "slug": "vendor", "description": "A supplier: terms, usual amounts, contacts, open disputes" }
    ]
  },
  "subscribes": ["finance.ap.*"],
  "ceiling": { "ledger.bill.create": "approval" },
  "workflows": {
    "invoice-intake": {
      "trigger": { "type": "watch", "plugin": "mail", "event": "email.new" },
      "activities": [
        { "id": "record", "intent": "If the message in _watch_payload is a vendor invoice, record it as a bill." }
      ]
    }
  }
}

フィールド

フィールド種類意味
requires.interfaces文字列のリスト役割に必要な機能(mailやledgerなど)。雇用時に付与されます。承認が必要な操作は、それぞれ承認項目のままです。「機能と承認」を参照してください。
requires.plugins文字列のリスト社員と一緒にインストールされるプラグイン。役割が本当に1つのプラグインに依存する場合にだけ使い、できるだけ機能を指定してください。
requires.tools文字列のリスト社員のセッションに最初のターンから読み込まれるツール。これで承認が省略されることはありません。
skills文字列のリストインストールして使うマーケットプレイスのスキル: @org/skills/name(任意で@version)、またはSKIL-コード。パッケージ自身のskills/フォルダにあるスキルは記載不要です。
inputslist雇用時にオーナーが答える質問。「入力」を参照してください。
memoryobject会話とメモリの保ち方。「ペルソナとメモリ」を参照してください。
subscribes文字列のリスト変更があったときに社員が読み直す会社の情報領域(finance.ar.*など)。
ceilingmap操作から"approval"への対応。その操作は、この社員については常にオーナーに確認します。他の値は受け付けません。
workflowsmapワークフロー名からワークフローへの対応。「ワークフロー」を参照してください。
toolslistアプリのサイドカーが提供するHTTPツール。「サイドカーツール」を参照してください。
scopesmaptools、skills、pluginsの名前付きグループ。スコープが有効なとき、そのスコープのpluginsが社員に説明されます。

入力

入力とは、オーナーが採用時に答える質問です。回答は「Configured Inputs」の下に社員向けに表示され、監視トリガーとフォルダートリガーの {{key}} プレースホルダーに入ります。

{
  "key": "close_day",
  "label": "Business day to finish the close",
  "type": "select",
  "options": [
    { "value": "3", "label": "Third business day" },
    { "value": "5", "label": "Fifth business day" }
  ],
  "default": "5",
  "scope": "company",
  "id": "finance.close.day"
}
フィールドデフォルト意味
key必須プレースホルダーで使う名前。代わりにnameも受け付けます。
labelkeyからオーナーに表示される質問。
typetexttext、textarea、number、select、checkbox、radioのいずれか。
requiredfalseオーナーが必ず答える質問であることを示します。
defaultなしあらかじめ入力された回答。金額の質問には使えません。
placeholder, descriptionなしヘルプテキスト。
optionsなしselectとradio用: {value, label}オブジェクト、またはただの文字列。
idなしその情報を表す、安定したドット区切りの名前(finance.ap.invoice_mailboxなど)。他の社員と共有できます。
scopecompanycompany: 会社で共有される情報。seat: この雇用だけ。
missingなし質問が未回答の間に社員がすること。
moneyfalse金額であることを示します。金額の質問にはデフォルト値を設定できません。

サイドカーツール

サイドカーを持つアプリは、HTTPエンドポイントをツールとして社員に公開します。Neboは各エントリーをapp__<app>__<name>として登録し、呼び出しをmethodとpathでサイドカーに送ります。アプリのサイドカーをご覧ください。

"tools": [
  {
    "name": "list_entries",
    "description": "List journal entries for a date range.",
    "method": "GET",
    "path": "/entries",
    "input_schema": { "type": "object", "properties": { "from": { "type": "string" } } }
  }
]

ワークフロー

workflowsの下の各キーが1つのワークフローを表し、その名前が識別子になります。完全な形式はワークフロー、トリガー、アクティビティにあります。