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نام گردش‌کار به گردش‌کار. گردش‌کارها را ببینید.
toolslistابزارهای HTTP که sidecar یک برنامه ارائه می‌دهد. ابزارهای Sidecar را ببینید.
scopesmapگروه‌های نام‌دار از tools، skills و plugins. وقتی یک scope فعال است، 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الزامینامی که در placeholderها استفاده می‌شود. 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> ثبت می‌کند و فراخوانی‌ها را با method و path به sidecar می‌فرستد. App 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 نام یک گردش‌کار است؛ این نام شناسه آن است. قالب کامل در گردش‌کارها، محرک‌ها و فعالیت‌ها آمده است.