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-инструменты, которые обслуживает sidecar приложения. См. «Инструменты sidecar».
scopesmapИменованные группы tools, skills и plugins. Когда область активна, сотруднику описываются её plugins.

Входные данные

Входной параметр — это вопрос, на который владелец отвечает при найме. Ответы видны сотруднику в разделе «Настроенные параметры» и подставляются в заполнители {{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Помечает денежную сумму. У денежного вопроса не может быть значения по умолчанию.

Инструменты sidecar

Приложение с sidecar открывает своему сотруднику HTTP-эндпоинты как инструменты. Nebo регистрирует каждую запись как app__<app>__<name> и отправляет вызовы в sidecar по method и path. См. Sidecar приложения.

"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 задаёт один рабочий процесс; имя служит его идентификатором. Полный формат описан в разделах Рабочие процессы, Триггеры и Действия.