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список рядківПлагіни, що встановлюються разом зі співробітником. Використовуйте, лише коли роль справді залежить від одного плагіна; краще вказуйте можливість.
requires.toolsсписок рядківІнструменти, що завантажуються в сесію співробітника з першого ходу. Це ніколи не обходить схвалення.
skillsсписок рядківНавички з маркетплейсу для встановлення й використання: @org/skills/name, за бажанням @version, або код SKIL-. Навички з власної папки пакета skills/ не потребують запису.
inputslistЗапитання, на які власник відповідає під час наймання. Див. «Вхідні дані».
memoryobjectЯк зберігаються розмови й пам’ять. Див. «Персона й пам’ять».
subscribesсписок рядківОбласті фактів компанії, які співробітник перечитує, коли вони змінюються, наприклад finance.ar.*.
ceilingmapОперація → "approval". Ця операція завжди потребує дозволу власника для цього співробітника. Інші значення не приймаються.
workflowsmapНазва робочого процесу → робочий процес. Див. «Робочі процеси».
toolslistHTTP-інструменти, які надає супровідний процес застосунку. Див. «Інструменти супровідного процесу».
scopesmapІменовані групи tools, 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.
labelз keyЗапитання, яке бачить власник.
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 називає один робочий процес; назва є його ідентифікатором. Повний формат описано в розділах Робочі процеси, Тригери і Дії.