Àpẹẹrẹ
{
"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." }
]
}
}
} Àwọn pápá
| Pápá | Irú | Ìtumọ̀ |
|---|---|---|
requires.interfaces | àtòjọ àwọn string | Àwọn agbára tí ipò náà nílò, bí mail tàbí ledger. A ń fún un ní wọn nígbà ìgbàsíṣẹ́; iṣẹ́ kọ̀ọ̀kan tí ó nílò ìfọwọ́sí ṣì ń jẹ́ ohun tí a ó fọwọ́ sí. Wo Àwọn agbára àti àwọn ìfọwọ́sí. |
requires.plugins | àtòjọ àwọn string | Àwọn plugin tí a fi sórí ẹ̀rọ pẹ̀lú òṣìṣẹ́ náà. Lò ó kìkì nígbà tí ipò náà bá gbára lé plugin kan gan-an; agbára ló dára jù. |
requires.tools | àtòjọ àwọn string | Àwọn irinṣẹ́ tí a gbé wọ inú ìgbà ìjíròrò òṣìṣẹ́ náà láti ìyípo àkọ́kọ́ rẹ̀. Èyí kì í fo ìfọwọ́sí rárá. |
skills | àtòjọ àwọn string | Àwọn ọgbọ́n ọjà láti fi sórí ẹ̀rọ àti láti lò: @org/skills/name, pẹ̀lú @version bí o bá fẹ́, tàbí kóòdù SKIL-. Àwọn ọgbọ́n tí ó wà nínú fódà skills/ ti àpò náà fúnra rẹ̀ kò nílò àkọsílẹ̀ kankan. |
inputs | list | Àwọn ìbéèrè tí olùní ń dáhùn nígbà ìgbàsíṣẹ́. Wo Ohun tí ó ń wọlé. |
memory | object | Bí a ṣe ń pa àwọn ìjíròrò àti ìrántí mọ́. Wo Ìwà àti ìrántí. |
subscribes | àtòjọ àwọn string | Àwọn agbègbè òtítọ́ ilé-iṣẹ́ tí òṣìṣẹ́ náà ń tún kà nígbà tí wọ́n bá yí padà, bí finance.ar.*. |
ceiling | map | Iṣẹ́ sí "approval". Iṣẹ́ yẹn máa ń béèrè lọ́wọ́ olùní nígbà gbogbo fún òṣìṣẹ́ yìí. A kò gba iye míì. |
workflows | map | Orúkọ ìlànà iṣẹ́ sí ìlànà iṣẹ́. Wo Àwọn ìlànà iṣẹ́. |
tools | list | Àwọn irinṣẹ́ HTTP tí sidecar áàpù kan ń pèsè. Wo Àwọn irinṣẹ́ sidecar. |
scopes | map | Àwọn ẹgbẹ́ tí a dárúkọ ti tools, skills àti plugins. A ń ṣàpèjúwe plugins scope kan fún òṣìṣẹ́ náà nígbà tí scope náà bá ń ṣiṣẹ́. |
Ohun tí ó ń wọlé
Ìtẹ̀wọlé jẹ́ ìbéèrè tí olúwa máa ń dáhùn nígbà tí ó bá ń gba òṣìṣẹ́ síṣẹ́. Àwọn ìdáhùn máa ń hàn fún òṣìṣẹ́ náà lábẹ́ "Configured Inputs", wọ́n sì máa ń kún àwọn àyè {{key}} nínú àwọn ohun ìfàsókè watch àti folder.
{
"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"
} | Pápá | Ìpìlẹ̀ | Ìtumọ̀ |
|---|---|---|
key | ó pọn dandan | Orúkọ tí a ń lò nínú àwọn placeholder. A gba name gẹ́gẹ́ bí àfidípò. |
label | láti key | Ìbéèrè tí a fi hàn olùní. |
type | text | text, textarea, number, select, checkbox tàbí radio. |
required | false | Ó ń sàmì sí ìbéèrè náà gẹ́gẹ́ bí èyí tí olùní gbọ́dọ̀ dáhùn. |
default | kò sí | Ìdáhùn tí a ti kọ sílẹ̀ tẹ́lẹ̀. A kò gbà á láàyè lórí ìbéèrè owó. |
placeholder, description | kò sí | Ọ̀rọ̀ ìrànlọ́wọ́. |
options | kò sí | Fún select àti radio: àwọn ohun {value, label} tàbí àwọn string lásán. |
id | kò sí | Orúkọ tí ó dúró ṣinṣin, tí ó ní àmì ìdúró, fún òtítọ́ náà, bí finance.ap.invoice_mailbox, kí àwọn òṣìṣẹ́ míì lè pín in. |
scope | company | company: òtítọ́ ilé-iṣẹ́ àjọlò. seat: ìgbàsíṣẹ́ yìí nìkan. |
missing | kò sí | Ohun tí òṣìṣẹ́ náà ń ṣe nígbà tí a kò tíì dáhùn ìbéèrè náà. |
money | false | Ó ń sàmì sí iye owó kan. Ìbéèrè owó kò lè ní ìpìlẹ̀. |
Àwọn irinṣẹ́ sidecar
Áàpù tí ó ní sidecar ń ṣí àwọn endpoint HTTP sílẹ̀ fún òṣìṣẹ́ rẹ̀ gẹ́gẹ́ bí irinṣẹ́. Nebo ń forúkọ àkọsílẹ̀ kọ̀ọ̀kan sílẹ̀ gẹ́gẹ́ bí app__<app>__<name>, ó sì ń fi àwọn ìpè ránṣẹ́ sí sidecar ní method àti path. Wo Sidecar áàpù.
"tools": [
{
"name": "list_entries",
"description": "List journal entries for a date range.",
"method": "GET",
"path": "/entries",
"input_schema": { "type": "object", "properties": { "from": { "type": "string" } } }
}
] Àwọn ìlànà iṣẹ́
Kọ́kọ́rọ́ kọ̀ọ̀kan lábẹ́ workflows ń dárúkọ ìlànà iṣẹ́ kan; orúkọ náà ni ìdámọ̀ rẹ̀. Ìrísí kíkún wà lórí Àwọn ìlànà iṣẹ́, Àwọn ohun ìbẹ̀rẹ̀ àti Àwọn ìgbòkègbodò.