Ví dụ
{
"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." }
]
}
}
} Các trường
| Trường | Loại | Ý nghĩa |
|---|---|---|
requires.interfaces | danh sách chuỗi | Các khả năng mà vai trò cần, chẳng hạn mail hoặc ledger. Được cấp khi tuyển; mỗi thao tác cần phê duyệt vẫn là một mục cần phê duyệt. Xem Khả năng và phê duyệt. |
requires.plugins | danh sách chuỗi | Các plugin được cài cùng nhân viên. Chỉ dùng khi vai trò thực sự phụ thuộc vào một plugin; nên ưu tiên dùng khả năng. |
requires.tools | danh sách chuỗi | Các công cụ được nạp vào phiên của nhân viên ngay từ lượt đầu tiên. Điều này không bao giờ bỏ qua bước phê duyệt. |
skills | danh sách chuỗi | Các kỹ năng từ chợ ứng dụng cần cài và dùng: @org/skills/name, có thể kèm @version, hoặc một mã SKIL-. Các kỹ năng trong thư mục skills/ của chính gói không cần khai báo. |
inputs | list | Các câu hỏi mà chủ sở hữu trả lời khi tuyển. Xem Đầu vào. |
memory | object | Cách lưu giữ cuộc trò chuyện và bộ nhớ. Xem Tính cách và bộ nhớ. |
subscribes | danh sách chuỗi | Các lĩnh vực thông tin công ty mà nhân viên đọc lại khi chúng thay đổi, chẳng hạn finance.ar.*. |
ceiling | map | Ánh xạ thao tác tới "approval". Thao tác đó luôn hỏi chủ sở hữu đối với nhân viên này. Không chấp nhận giá trị nào khác. |
workflows | map | Ánh xạ tên quy trình tới quy trình. Xem Quy trình. |
tools | list | Các công cụ HTTP do sidecar của ứng dụng phục vụ. Xem Công cụ sidecar. |
scopes | map | Các nhóm có tên gồm tools, skills và plugins. plugins của một phạm vi được mô tả cho nhân viên khi phạm vi đó đang hoạt động. |
Đầu vào
Một input là câu hỏi mà chủ sở hữu trả lời khi tuyển nhân viên. Câu trả lời hiển thị cho nhân viên trong mục "Configured Inputs" và điền vào các placeholder {{key}} trong trình kích hoạt theo dõi và trình kích hoạt thư mục.
{
"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"
} | Trường | Mặc định | Ý nghĩa |
|---|---|---|
key | bắt buộc | Tên dùng trong các placeholder. name được chấp nhận làm phương án dự phòng. |
label | lấy từ key | Câu hỏi hiển thị cho chủ sở hữu. |
type | text | text, textarea, number, select, checkbox hoặc radio. |
required | false | Đánh dấu câu hỏi là câu chủ sở hữu bắt buộc phải trả lời. |
default | không có | Câu trả lời điền sẵn. Không được dùng cho câu hỏi về tiền. |
placeholder, description | không có | Văn bản trợ giúp. |
options | không có | Với select và radio: các đối tượng {value, label} hoặc chuỗi thuần. |
id | không có | Một tên ổn định, phân tách bằng dấu chấm cho thông tin đó, chẳng hạn finance.ap.invoice_mailbox, để các nhân viên khác có thể dùng chung. |
scope | company | company: một thông tin chung của công ty. seat: chỉ cho lượt tuyển này. |
missing | không có | Những gì nhân viên làm khi câu hỏi chưa được trả lời. |
money | false | Đánh dấu một số tiền. Câu hỏi về tiền không được có giá trị mặc định. |
Công cụ sidecar
Một ứng dụng có sidecar cung cấp các endpoint HTTP cho nhân viên của nó dưới dạng công cụ. Nebo đăng ký mỗi mục thành app__<app>__<name> và gửi các lệnh gọi tới sidecar tại method và path. Xem 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" } } }
}
] Quy trình
Mỗi khóa trong workflows đặt tên cho một quy trình; tên đó là định danh của quy trình. Định dạng đầy đủ có tại Quy trình, Trình kích hoạt và Hoạt động.