مثال
{
"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/ فولڈر کی مہارتوں کے لیے کسی اندراج کی ضرورت نہیں۔ |
inputs | list | وہ سوالات جن کا جواب مالک ملازم رکھتے وقت دیتا ہے۔ ان پٹس دیکھیں۔ |
memory | object | گفتگوئیں اور یادداشت کیسے رکھی جاتی ہیں۔ شخصیت اور یادداشت دیکھیں۔ |
subscribes | اسٹرنگز کی فہرست | کمپنی کی معلومات کے وہ شعبے جنہیں ملازم تبدیل ہونے پر دوبارہ پڑھتا ہے، جیسے finance.ar.*۔ |
ceiling | map | کارروائی سے "approval" تک۔ وہ کارروائی اس ملازم کے لیے ہمیشہ مالک سے پوچھتی ہے۔ کوئی اور قدر قبول نہیں۔ |
workflows | map | ورک فلو کا نام اور اس کا ورک فلو۔ ورک فلوز دیکھیں۔ |
tools | list | ایپ کے سائیڈکار کے فراہم کردہ HTTP ٹولز۔ سائیڈکار ٹولز دیکھیں۔ |
scopes | map | 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 | لازمی | پلیس ہولڈرز میں استعمال ہونے والا نام۔ name متبادل کے طور پر قبول ہے۔ |
label | key سے | مالک کو دکھایا جانے والا سوال۔ |
type | text | text، textarea، number، select، checkbox یا radio۔ |
required | false | سوال کو ایسا نشان زد کرتا ہے جس کا جواب مالک کو لازماً دینا ہے۔ |
default | کوئی نہیں | پہلے سے بھرا جواب۔ رقم کے سوال پر اجازت نہیں۔ |
placeholder, description | کوئی نہیں | مددگار متن۔ |
options | کوئی نہیں | select اور radio کے لیے: {value, label} آبجیکٹس یا سادہ اسٹرنگز۔ |
id | کوئی نہیں | معلومات کا ایک مستقل، نقطوں والا نام، جیسے finance.ap.invoice_mailbox، تاکہ دوسرے ملازمین بھی اسے استعمال کر سکیں۔ |
scope | company | company: کمپنی کی مشترکہ معلومات۔ seat: صرف یہ ملازم۔ |
missing | کوئی نہیں | جب تک سوال کا جواب نہ ملے ملازم کیا کرتا ہے۔ |
money | false | رقم کی مقدار کو نشان زد کرتا ہے۔ رقم کے سوال کی کوئی طے شدہ قدر نہیں ہو سکتی۔ |
سائیڈکار ٹولز
سائیڈکار والی ایپ اپنے ملازم کو 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 کے تحت ہر کلید ایک ورک فلو کا نام ہے؛ یہی نام اس کا شناخت کنندہ ہے۔ مکمل فارمیٹ ورک فلوز، ٹرگرز اور سرگرمیاں پر موجود ہے۔