NeboAI
NeboAI
ចាប់ផ្ដើម

ឯកសារយោង plugin.json

plugin.json គឺជា manifest ដែល Nebo អានដើម្បីដំឡើង និងដំណើរការ Plugin មួយ។ Key ប្រើទម្រង់ camelCase។ ទំព័រនេះរាយបញ្ជីរាល់វាលដែល Nebo អានបច្ចុប្បន្ន និងអ្វីដែលវាលនីមួយៗធ្វើ។

វាលកម្រិតកំពូល

វាលប្រភេទចាំបាច់អត្ថន័យ
idstringបាទ/ចាសអត្តសញ្ញាណទីផ្សាររបស់ Plugin។ ប្រើ slug ពេលកំពុងអភិវឌ្ឍ។
slugstringបាទ/ចាសអត្តសញ្ញាណថេរ។ [a-z0-9-] យ៉ាងច្រើន 64 តួអក្សរ គ្មានសញ្ញាដកនៅដើម ចុង ឬសញ្ញាដកជាប់គ្នាពីរ។ ដាក់ឈ្មោះឧបករណ៍ plugin__<slug> និងអថេរ <SLUG>_BIN។
namestringបាទ/ចាសឈ្មោះបង្ហាញ។ ដាក់ឈ្មោះសេវាដែលវាភ្ជាប់ទៅ។
versionstringបាទ/ចាសកំណែតាមន័យ (semantic version) ដូចជា 0.1.0។
platformsmapបាទ/ចាសKey វេទិកាទៅកាន់ binary។ សូមមើល វេទិកា។
descriptionstringទេប្រយោគមួយសម្រាប់មនុស្ស និងបុគ្គលិក។
authorstringទេឈ្មោះអ្នកបោះផ្សាយ។
categorystringទេជួយបុគ្គលិកស្វែងរក Plugin។
triggersបញ្ជីនៃខ្សែអក្សរទេពាក្យដែលពិពណ៌នាពេលណា Plugin ត្រូវប្រើ។ ប្រើក្នុងការណែនាំការស្វែងរក។
entrySkillsបញ្ជីនៃខ្សែអក្សរទេជំនាញដែលភ្ជាប់មកជាមួយ ដើម្បីដាក់ឈ្មោះមុនគេក្នុងការពិពណ៌នាឧបករណ៍របស់ Plugin។
dependenciesបញ្ជីនៃ {name, version, optional}ទេPlugin ផ្សេងទៀតដែល Plugin នេះដំណើរការ។ version លំនាំដើមជា "*"; optional លំនាំដើមជា false។ ផ្លូវ <SLUG>_BIN របស់ពួកវាត្រូវបានកំណត់នៅរាល់ការហៅ។
authobjectទេការចូលគណនី និងគណនី។ សូមមើល ការផ្ទៀងផ្ទាត់។
capabilitiesobjectទេconfigSchema, hooks, commands, routes, providers.
permissionsobjectទេការត្រងបរិស្ថាន និងកម្រិតខ្ពស់បំផុតនៃពេលវេលាកំណត់។
eventslistទេអ្នកឃ្លាំមើលដែលផ្ដល់ទិន្នន័យដល់លំហូរការងាររបស់បុគ្គលិក។
interfaceBindingsmapទេប្រតិបត្តិការមានប្រភេទដែល Plugin ផ្ដល់ជូន។
channelobjectទេស្ពានជាប់លាប់ទៅកាន់សេវាផ្ញើសារ។
setupobjectទេអ្នកជំនួយការរៀបចំមួយជំហានម្ដងៗ។

Nebo ផ្ទៀងផ្ទាត់ការដំឡើងពីទីផ្សារ៖ ច្បាប់ slug កំណែតាមន័យ យ៉ាងហោចណាស់វេទិកាមួយ binaryName ដែលគ្មានសញ្ញាបំបែកផ្លូវ ឬ .. ពាក្យបញ្ជា login លើកលែងតែ auth.type ជា env ឈ្មោះព្រឹត្តិការណ៍ និងពាក្យបញ្ជាដែលមិនទទេ និងគំរូចងភ្ជាប់ដែលញែកបាន។ Plugin នៅក្នុងថត Plugin របស់អ្នកប្រើ រំលងការផ្ទៀងផ្ទាត់។

វេទិកា

Key គឺ darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64 និង windows-amd64។ ធាតុនីមួយៗមានវាលទាំងប្រាំខាងក្រោម។ ពេលអ្នកបោះផ្សាយ ទីផ្សារសរសេរ hash ទំហំ ហត្ថលេខា និង URL ទាញយកពិតប្រាកដ ដូច្នេះទុកវាឱ្យទទេនៅក្នុងឯកសារដែលអ្នកផ្ទុកឡើង។

"platforms": {
  "darwin-arm64":  { "binaryName": "notes-sync",     "sha256": "", "signature": "", "size": 0, "downloadUrl": "" },
  "linux-amd64":   { "binaryName": "notes-sync",     "sha256": "", "signature": "", "size": 0, "downloadUrl": "" },
  "windows-amd64": { "binaryName": "notes-sync.exe", "sha256": "", "signature": "", "size": 0, "downloadUrl": "" }
}
វាលអត្ថន័យ
binaryNameឈ្មោះឯកសាររបស់កម្មវិធីដំណើរការ។ បន្ថែម .exe នៅលើ Windows។
sha256Hash របស់ binary។ ពិនិត្យនៅពេលដំឡើង។
signatureហត្ថលេខារបស់ binary។ ពិនិត្យនៅពេលដំឡើង នៅពេលមានសោចុះហត្ថលេខា។
sizeទំហំគិតជាបៃ។
downloadUrlកន្លែងដែល Nebo ទាញយកកញ្ចប់។

ការផ្ទៀងផ្ទាត់

វាលអត្ថន័យ
typeoauth_cli សម្រាប់ការចូលគណនីតាមកម្មវិធីរុករកដែល Plugin ដំណើរការ; env សម្រាប់ព័ត៌មានសម្ងាត់ដែលបញ្ចូលជាតម្លៃ; neboai ដើម្បីទទួល token NeboAI របស់ម្ចាស់នៅក្នុងរាល់ key auth.env ដែលបញ្ចប់ដោយ _TOKEN។
envផែនទីពីឈ្មោះអថេរទៅតម្លៃលំនាំដើម។ ក៏ជាឈ្មោះព័ត៌មានសម្ងាត់តែមួយគត់ដែល Nebo បញ្ជូនទៅ login។
commands.loginចូលគណនី។ ចាំបាច់ លើកលែងតែ type ជា env។ ដំណើរការជាមួយថតគណនីដែលបានកំណត់។
commands.statusបង្ហាញ JSON ដែលប្រាប់ថាតើគណនីបានចូលហើយឬនៅ។
commands.refreshបន្តសុពលភាព token ដោយគ្មានអន្តរកម្ម។
commands.logoutចាកចេញ។ មានតែម្ចាស់ទេដែលអាចដំណើរការវាបាន។
profileDirEnvអថេរដែលទទួលថតព័ត៌មានសម្ងាត់ដាច់ដោយឡែកសម្រាប់បុគ្គលិក និងគណនីនីមួយៗ។ បើគ្មានវាទេ Plugin កាន់គណនីរួមតែមួយ។
label, descriptionអត្ថបទនៅលើកាតតភ្ជាប់។
help{url, urlLabel, text} ដែលបង្ហាញពេលកំពុងតភ្ជាប់។
publicRedirectកំណត់ true នៅពេលអ្នកផ្ដល់សេវាបដិសេធការបញ្ជូនបន្តទៅ http://localhost; ពេលនោះការចូលគណនីឆ្លងកាត់ការបញ្ជូនបន្តសាធារណៈរបស់ NeboAI។

Nebo អានធាតុទីមួយក្នុងចំណោម authenticated, isAuthenticated, logged_in, loggedIn ឬ token_valid នៅក្នុងលទ្ធផលស្ថានភាព។ token_error ដែលមិនទទេ ឬតម្លៃ none នៅក្នុង credential_source, auth_method, storage ឬ status មានន័យថាបានចាកចេញ។ ពាក្យបញ្ជាស្ថានភាពមានពេល 45 វិនាទី។

{"authenticated": true, "account": "finance@example.com"}

configSchema

capabilities.configSchema ពិពណ៌នាតម្លៃដែលម្ចាស់កំណត់សម្រាប់ Plugin។ តម្លៃនីមួយៗទៅដល់ binary ជាអថេរបរិស្ថានដែលដាក់ឈ្មោះដោយ key។ សម្រាប់ key ព័ត៌មានសម្ងាត់ដែលក៏មាននៅក្នុង auth.env ផងដែរ schema ដាក់ស្លាកវាលនៃទម្រង់តភ្ជាប់តាមបុគ្គលិក។

វាលប្រភេទលំនាំដើមអត្ថន័យ
keystringចាំបាច់ឈ្មោះអថេរបរិស្ថាន។
labelstringចាំបាច់ស្លាកវាល។
descriptionstring""អត្ថបទជំនួយ។
fieldTypestring"string"ប្រភេទការបញ្ចូល ដូចជា string, number, boolean, select ឬ password។
defaultstringគ្មានតម្លៃដែលបំពេញជាមុន។
requiredbooleanfalsePlugin មិនទាន់រួចរាល់ទេ រហូតដល់តម្លៃត្រូវបានកំណត់។
secretbooleanfalseតម្លៃត្រូវបានបិទបាំងនៅពេលអានត្រឡប់មកវិញ។
optionsបញ្ជីនៃខ្សែអក្សរគ្មានជម្រើសសម្រាប់ select។

permissions

វាលលំនាំដើមអត្ថន័យ
envAllow[]អថេរដែលទទួលមរតក ដែល Plugin អាចមើលឃើញ។ ទុកទទេ គឺអនុញ្ញាតទាំងអស់។
envDeny[]អថេរដែលទទួលមរតក ដែលតែងតែត្រូវបានដកចេញ។
maxTimeoutSeconds300ដែនកំណត់ខាងលើសម្រាប់ពេលវេលាកំណត់នៃការហៅណាមួយ។
networkfalseប្រកាសការប្រើប្រាស់បណ្ដាញ។ សម្រាប់ជាព័ត៌មានប៉ុណ្ណោះ មិនត្រូវបានអនុវត្តជាកំហិតទេ។

events

ព្រឹត្តិការណ៍គឺជាអ្នកឃ្លាំមើលដែលដំណើរការយូរ។ Nebo ចាប់ផ្ដើមវានៅពេលលំហូរការងាររបស់បុគ្គលិកឃ្លាំមើលវា ហើយចាប់ផ្ដើមវាឡើងវិញប្រសិនបើវាចេញ។ បន្ទាត់នីមួយៗដែលអ្នកឃ្លាំមើលសរសេរទៅ stdout គឺជាព្រឹត្តិការណ៍មួយ។ ឈ្មោះព្រឹត្តិការណ៍ត្រូវបានដាក់ slug នៅខាងមុខនៅពេលដំណើរការ ដូច្នេះ note.created ក្លាយជា notes-sync.note.created។

"events": [
  {
    "name": "note.created",
    "description": "A note was created in the watched notebook.",
    "command": "watch --notebook {{notebook}} --format ndjson"
  }
]
វាលអត្ថន័យ
nameឈ្មោះព្រឹត្តិការណ៍ ដោយគ្មាន slug។ ចាំបាច់។
commandអាគុយម៉ង់ដែលចាប់ផ្ដើមអ្នកឃ្លាំមើល។ ចាំបាច់។ {{key}} ត្រូវបានជំនួសដោយតម្លៃបញ្ចូលរបស់បុគ្គលិក។
descriptionអ្វីដែលបង្កឱ្យមានព្រឹត្តិការណ៍។
multiplexedនៅពេលជា true អ្នកឃ្លាំមើលមួយបញ្ចេញព្រឹត្តិការណ៍ច្រើនប្រភេទ ហើយបន្ទាត់នីមួយៗមានវាល "event"។

លំហូរការងារជាវព្រឹត្តិការណ៍ដោយប្រើកត្តាបង្ក watch។ សូមមើល កត្តាបង្ក។

interfaceBindings

ការចងភ្ជាប់ផ្គូផ្គងប្រតិបត្តិការចំណុចប្រទាក់មួយទៅនឹងពាក្យបញ្ជាមួយរបស់អ្នក។ ការចងភ្ជាប់នីមួយៗក្លាយជាឧបករណ៍មានប្រភេទសម្រាប់បុគ្គលិក ដែលដាក់ឈ្មោះតាមប្រតិបត្តិការជាអក្សរតូច ដោយប្ដូរចំណុច និងសញ្ញាដកទៅជាសញ្ញាគូសក្រោម៖ notes.search ក្លាយជា notes_search។ ការចងភ្ជាប់គឺជារបៀបដែល Plugin បំពេញសមត្ថភាពដែលបុគ្គលិកត្រូវការ; សូមមើល សមត្ថភាព។

"interfaceBindings": {
  "notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
  "invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
}
កន្លែងដាក់ជំនួសពង្រីកទៅជា
{field}តម្លៃរបស់វាលជាពាក្យតែមួយ។ វាលនេះមិនត្រូវបានបញ្ជូនជា flag ទៀតទេ។
{field[]:--flag}គូ --flag <item> មួយសម្រាប់ធាតុនីមួយៗក្នុងវាលបញ្ជី។
{field?:--flag}--flag <value> នៅពេលមានវាល; គ្មានអ្វីសោះនៅពេលគ្មានវា។
{field:cents->dollars}ចំនួនគត់គិតជាសេន ដែលសរសេរជាដុល្លារ។

វាលបញ្ចូលដែលគំរូមិនបានដាក់ឈ្មោះ ត្រូវបានបន្ថែមនៅខាងចុងជា --field value។ កន្លែងដាក់ជំនួសសម្រាប់បញ្ជី និងស្រេចចិត្ត ត្រូវតែជាពាក្យពេញ។ ប្រតិបត្តិការដែលទាមទារការយល់ព្រម មិនអាចទៅដល់បានដោយហៅពាក្យបញ្ជាដដែលតាមរយៈ plugin__<slug> ទេ។

Hook ពាក្យបញ្ជាសញ្ញាទ្រេត និងផ្លូវ

"capabilities": {
  "hooks": [
    { "hook": "tool.post_execute", "hookType": "filter", "command": "hook redact", "priority": 50, "timeoutMs": 500 }
  ],
  "commands": [
    { "name": "notes", "description": "Show today's notes", "command": "notes today", "slash": true }
  ],
  "routes": [
    { "path": "/callback", "method": "GET", "command": "http callback" }
  ]
}

hooks

Hook ដំណើរការពាក្យបញ្ជារបស់អ្នកនៅចំណុចមួយក្នុងវេនរបស់បុគ្គលិក។ Nebo សរសេរ payload ជា JSON ទៅ stdin។ លទ្ធផលរបស់ hook ប្រភេទ action ត្រូវបានមិនអើពើ។ Hook ប្រភេទ filter ត្រឡប់ {"payload": ..., "handled": false}; "handled": true បញ្ឈប់ hook បន្ទាប់ៗ។ កំហុស និងការអស់ពេលរក្សា payload មុន ហើយមិនដែលរារាំងវេននោះទេ។ បន្ទាប់ពីបរាជ័យបីដងជាប់ៗគ្នា hook ត្រូវបានផ្អាករយៈពេលប្រាំនាទី។

វាលលំនាំដើមអត្ថន័យ
hookចាំបាច់មួយក្នុងចំណោម tool.pre_execute, tool.post_execute, message.post_receive, session.message_append, steering.generate, agent.turn, agent.should_continue។
hookType"action"action ឬ filter។
commandចាំបាច់អាគុយម៉ង់សម្រាប់ binary របស់អ្នក។
priority100តម្លៃទាបដំណើរការមុន។
timeoutMs500ដែនកំណត់ពេលវេលាគិតជាមិល្លីវិនាទី។

commands

ជាមួយ "slash": true ការវាយ /name args ក្នុងការជជែក ដំណើរការ command args ដោយផ្ទាល់ ដោយគ្មានបុគ្គលិក។ លទ្ធផលគឺជាការឆ្លើយតប។ ដែនកំណត់ពេលវេលាគឺ 30 វិនាទី។

routes

ផ្លូវមួយឆ្លើយតបសំណើ HTTP នៅ /api/v1/plugins/<slug>/api/<path> នៅលើបូត ដោយផ្គូផ្គងតាម path និង method។ តួសំណើទៅកាន់ stdin ហើយ stdout របស់អ្នកគឺជាការឆ្លើយតប។ ដែនកំណត់ពេលវេលាគឺ 30 វិនាទី។

providers

អ្នកផ្ដល់សេវាបន្ថែមប្រភពម៉ូដែលជជែកមួយ។ ប្រកាស id, displayName, providerType, modelsCommand និង chatCommand។ Nebo ផ្ញើសំណើជជែកជា JSON តាម stdin ទៅកាន់ chatCommand ហើយអានព្រឹត្តិការណ៍ដែលស្ទ្រីមជា JSON បំបែកដោយបន្ទាត់ថ្មីនៅលើ stdout រហូតដល់ 300 វិនាទី។ បច្ចុប្បន្នប្រើតែការស្ទ្រីមជជែកប៉ុណ្ណោះ។

channel

ឆានែលមួយភ្ជាប់សេវាផ្ញើសារ។ Nebo រក្សា command ឱ្យដំណើរការជានិច្ច អានសារចូលពី stdout របស់វា ហើយសរសេរការឆ្លើយតបទៅ stdin របស់វា ទាំងពីរជា JSON បំបែកដោយបន្ទាត់ថ្មី។

វាលលំនាំដើមអត្ថន័យ
commandចាំបាច់អាគុយម៉ង់ដែលចាប់ផ្ដើមស្ពាន។
name, description""បង្ហាញក្នុងការកំណត់។
restartDelaySecs5រង់ចាំមុនពេលចាប់ផ្ដើមឡើងវិញ បន្ទាប់ពីគាំង។
sharedfalseស្ពានតែមួយសម្រាប់បុគ្គលិកទាំងអស់; សារត្រូវបានបញ្ជូនតាមឈ្មោះបុគ្គលិក ហើយការឆ្លើយតបមានអត្តសញ្ញាណរបស់បុគ្គលិកម្នាក់ៗ។
needsLocalApifalseផ្ដល់អាសយដ្ឋាន API មូលដ្ឋានរបស់បូត token មួយ និង id បុគ្គលិក ដល់ស្ពាន។ បិទ លើកលែងតែអ្នកត្រូវការវា។

setup

អ្នកជំនួយការរៀបចំ (setup wizard) នាំម្ចាស់ឆ្លងកាត់ជំហានដែលទម្រង់តែមួយមិនអាចគ្របដណ្ដប់បាន។ តម្លៃពីជំហាន form បំពេញ {{key}} នៅក្នុងអាគុយម៉ង់ generate ជំហានក្រោយៗ។ តម្លៃពីជំហាន credentials ត្រូវបានរក្សាទុកជាអថេរបរិស្ថានរបស់ Plugin។

"setup": {
  "title": "Connect Example Chat",
  "steps": [
    { "kind": "form", "title": "Bot name", "fields": [ { "key": "bot_name", "label": "Name", "required": true } ] },
    { "kind": "generate", "title": "App manifest", "command": "manifest", "args": ["--name", "{{bot_name}}"], "outputFormat": "yaml" },
    { "kind": "external", "title": "Create the app", "url": "https://example.com/apps", "urlLabel": "Open admin" },
    { "kind": "credentials", "title": "Paste the token", "fields": [ { "key": "EXAMPLE_CHAT_TOKEN", "label": "Token", "inputType": "password", "required": true } ], "verifyCommand": "auth status" }
  ]
}
ប្រភេទជំហានវាល
formtitle, description, fields
generatetitle, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel។ បង្ហាញលទ្ធផលរបស់ពាក្យបញ្ជាសម្រាប់ចម្លង។
externaltitle, description, url, urlLabel, instructions
credentialstitle, description, fields, verifyCommand។ ជំហាននេះបញ្ចប់នៅពេល verifyCommand ជោគជ័យ។

វាលមាន key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) និង required។