NeboAI
NeboAI
ይጀምሩ

የplugin.json ማጣቀሻ

plugin.json Nebo ተሰኪን ለመጫን እና ለማሄድ የሚያነበው ማኒፌስት ነው። ቁልፎቹ በcamelCase ይጻፋሉ። ይህ ገጽ Nebo ዛሬ የሚያነባቸውን መስኮች ሁሉ እና እያንዳንዳቸው ምን እንደሚያደርጉ ይዘረዝራል።

የላይኛው ደረጃ መስኮች

መስክዓይነትግዴታትርጉም
idstringአዎየተሰኪው የገበያ ቦታ መለያ። በማበልጸግ ላይ ሳሉ slugን ይጠቀሙ።
slugstringአዎቋሚ መለያ። [a-z0-9-]፣ ቢበዛ 64 ቁምፊዎች፣ በመጀመሪያ ወይም በመጨረሻ ሰረዝ ወይም ድርብ ሰረዝ የሌለበት። የplugin__<slug> መሣሪያውን እና የ<SLUG>_BIN ተለዋዋጩን ይሰይማል።
namestringአዎየሚታይ ስም። የሚገናኝበትን አገልግሎት ይሰይሙ።
versionstringአዎእንደ 0.1.0 ያለ ሴማንቲክ ስሪት።
platformsmapአዎከመድረክ ቁልፍ ወደ ባይነሪ። መድረኮችን ይመልከቱ።
descriptionstringአይለሰዎች እና ለሰራተኞች አንድ ዓረፍተ ነገር።
authorstringአይየአሳታሚው ስም።
categorystringአይሰራተኞች ተሰኪውን እንዲያገኙ ይረዳል።
triggersየሕብረቁምፊዎች ዝርዝርአይተሰኪው መቼ እንደሚያገለግል የሚገልጹ ቃላት። በፍለጋ ፍንጮች ውስጥ ጥቅም ላይ ይውላሉ።
entrySkillsየሕብረቁምፊዎች ዝርዝርአይበተሰኪው የመሣሪያ መግለጫ ውስጥ መጀመሪያ የሚጠቀሱ አብረው የተካተቱ ክህሎቶች።
dependenciesየ{name, version, optional} ዝርዝርአይይህ ተሰኪ የሚያሄዳቸው ሌሎች ተሰኪዎች። version በነባሪ "*" ነው፤ optional ደግሞ false። የእነሱ <SLUG>_BIN ዱካዎች በእያንዳንዱ ጥሪ ላይ ይዘጋጃሉ።
authobjectአይመግቢያ እና መለያዎች። ማረጋገጫን ይመልከቱ።
capabilitiesobjectአይconfigSchema, hooks, commands, routes, providers.
permissionsobjectአይየአካባቢ ማጣሪያ እና የጊዜ ገደቡ ከፍተኛ ወሰን።
eventslistአይየሰራተኛ የሥራ ፍሰቶችን የሚመግቡ ተከታታዮች።
interfaceBindingsmapአይተሰኪው የሚያቀርባቸው ዓይነት ያላቸው ክንውኖች።
channelobjectአይከመልእክት አገልግሎት ጋር ዘላቂ ድልድይ።
setupobjectአይደረጃ በደረጃ የማዋቀሪያ አዋቂ።

Nebo ከገበያ ቦታ የሚደረጉ ጭነቶችን ያረጋግጣል፦ የslug ደንቦችን፣ ሴማንቲክ ስሪትን፣ ቢያንስ አንድ መድረክን፣ የዱካ መለያያዎች ወይም .. የሌሉበት binaryNameን፣ auth.type env ካልሆነ በስተቀር የlogin ትዕዛዝን፣ ባዶ ያልሆኑ የክስተት ስሞችን እና ትዕዛዞችን፣ እንዲሁም በትክክል የሚተነተኑ የማሰሪያ አብነቶችን። በተጠቃሚ ተሰኪዎች አቃፊ ውስጥ ያሉ ተሰኪዎች ይህን ማረጋገጫ አያልፉም፤ ይዘለላሉ።

መድረኮች

ቁልፎቹ darwin-arm64፣ darwin-amd64፣ linux-arm64፣ linux-amd64፣ windows-arm64 እና windows-amd64 ናቸው። እያንዳንዱ ግቤት ከታች ያሉትን አምስቱንም መስኮች ይይዛል። ሲያትሙ የገበያ ቦታው ትክክለኛውን ሃሽ፣ መጠን፣ ፊርማ እና የማውረጃ 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የሚተገበረው ፋይል ስም። በWindows ላይ .exe ያክሉ።
sha256የባይነሪው ሃሽ። በጭነት ጊዜ ይረጋገጣል።
signatureየባይነሪው ፊርማ። የመፈረሚያ ቁልፍ ሲገኝ በጭነት ጊዜ ይረጋገጣል።
sizeመጠን በባይት።
downloadUrlNebo ጥቅሉን የሚያወርድበት ቦታ።

ማረጋገጫ

መስክትርጉም
typeoauth_cli በተሰኪው ለሚካሄድ የአሳሽ መግቢያ፤ env እንደ እሴቶች ለሚገቡ የመግቢያ መረጃዎች፤ neboai የባለቤቱን የNeboAI ቶከን በ_TOKEN በሚያልቅ በእያንዳንዱ የauth.env ቁልፍ ውስጥ ለመቀበል።
envከተለዋዋጭ ስም ወደ ነባሪ እሴት የሚያገናኝ ካርታ። Nebo ለlogin የሚያስተላልፋቸው የመግቢያ መረጃ ስሞችም እነዚህ ብቻ ናቸው።
commands.loginያስገባል። type env ካልሆነ በስተቀር ግዴታ ነው። የመለያው አቃፊ ተዘጋጅቶ ይሄዳል።
commands.statusመለያው መግባቱን የሚገልጽ JSON ያትማል።
commands.refreshያለ ተጠቃሚ መስተጋብር ቶከንን ያድሳል።
commands.logoutከመለያው ያስወጣል። ሊያሄደው የሚችለው ባለቤቱ ብቻ ነው።
profileDirEnvለእያንዳንዱ ሰራተኛ እና መለያ የተለየ የመግቢያ መረጃ አቃፊ የሚቀበል ተለዋዋጭ። ያለሱ ተሰኪው አንድ የጋራ መለያ ይይዛል።
label, descriptionበማገናኛ ካርዱ ላይ ያለ ጽሑፍ።
helpበማገናኘት ላይ ሳለ የሚታይ {url, urlLabel, text}።
publicRedirectአቅራቢው የhttp://localhost ማዘዋወሪያዎችን ሲከለክል true ያድርጉት፤ ከዚያ መግቢያው በNeboAI ይፋዊ ማዘዋወሪያ በኩል ያልፋል።

Nebo በሁኔታ ውፅዓቱ ውስጥ ከauthenticated፣ isAuthenticated፣ logged_in፣ loggedIn ወይም token_valid መጀመሪያ የሚገኘውን ያነባል። ባዶ ያልሆነ token_error፣ ወይም በcredential_source፣ auth_method፣ storage ወይም status ውስጥ ያለ የnone እሴት ከመለያው ወጥቷል ማለት ነው። የሁኔታ ትዕዛዙ 45 ሰከንዶች አሉት።

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

configSchema

capabilities.configSchema ባለቤቱ ለተሰኪው የሚያዘጋጃቸውን እሴቶች ይገልጻል። እያንዳንዱ እሴት በkey የተሰየመ የአካባቢ ተለዋዋጭ ሆኖ ባይነሪው ጋር ይደርሳል። በauth.env ውስጥም ለተዘረዘሩ የመግቢያ መረጃ ቁልፎች፣ ሼማው በእያንዳንዱ ሰራተኛ የማገናኛ ቅጽ ውስጥ ላሉት መስኮች ስያሜ ይሰጣል።

መስክዓይነትነባሪትርጉም
keystringግዴታየአካባቢ ተለዋዋጭ ስም።
labelstringግዴታየመስኩ ስያሜ።
descriptionstring""የእገዛ ጽሑፍ።
fieldTypestring"string"እንደ string፣ number፣ boolean፣ select ወይም password ያለ የግብዓት ዓይነት።
defaultstringየለምአስቀድሞ የተሞላ እሴት።
requiredbooleanfalseእሴቱ እስኪዘጋጅ ድረስ ተሰኪው ዝግጁ አይሆንም።
secretbooleanfalseመልሶ ሲነበብ እሴቱ ይሸፈናል።
optionsየሕብረቁምፊዎች ዝርዝርየለምለselect የሚሆኑ ምርጫዎች።

permissions

መስክነባሪትርጉም
envAllow[]ተሰኪው ሊያያቸው የሚችላቸው የተወረሱ ተለዋዋጮች። ባዶ ከሆነ ሁሉንም ይፈቅዳል።
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ክስተቱን የሚያስከትለው።
multiplexedtrue ሲሆን አንድ ተከታታይ በርካታ የክስተት ዓይነቶችን ያወጣል፣ እያንዳንዱ መስመርም የ"event" መስክ ይይዛል።

የሥራ ፍሰቶች በwatch ቀስቃሽ ለክስተቶች ይመዘገባሉ። ቀስቃሾችን ይመልከቱ።

interfaceBindings

ማሰሪያ የበይነገጽ ክንውንን ከትዕዛዞችዎ ከአንዱ ጋር ያገናኛል። እያንዳንዱ ማሰሪያ ለሰራተኞች ዓይነት ያለው መሣሪያ ይሆናል፤ ስሙም የክንውኑ ስም በትንሽ ፊደላት፣ ነጥቦች እና ሰረዞች በታችኛው ሰረዝ ተተክተው ነው፦ notes.search notes_search ይሆናል። ተሰኪ አንድ ሰራተኛ የሚፈልጋቸውን ችሎታዎች የሚያሟላው በማሰሪያዎች ነው፤ ችሎታዎችን ይመልከቱ።

"interfaceBindings": {
  "notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
  "invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
}
ቦታ ያዥየሚሰፋው ወደ
{field}የመስኩ እሴት እንደ አንድ ቃል። መስኩ በተጨማሪ እንደ ባንዲራ አይተላለፍም።
{field[]:--flag}በዝርዝር መስክ ውስጥ ላለ እያንዳንዱ ንጥል አንድ --flag <item> ጥንድ።
{field?:--flag}መስኩ ሲኖር --flag <value>፤ ሲጎድል ምንም።
{field:cents->dollars}በሳንቲም የተገለጸ ሙሉ ቁጥር መጠን፣ በዶላር ተጽፎ።

አብነቱ ያልጠቀሳቸው የግብዓት መስኮች እንደ --field value ይታከላሉ። የዝርዝር እና የአማራጭ ቦታ ያዦች ሙሉ ቃላት መሆን አለባቸው። ማጽደቅ የሚያስፈልገው ክንውን ያንኑ ትዕዛዝ በplugin__<slug> በኩል በመጥራት ሊደረስበት አይችልም።

መንጠቆዎች፣ የስላሽ ትዕዛዞች እና መስመሮች

"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 የJSON payload ወደ stdin ይጽፋል። የaction hook ውጤት ችላ ይባላል። የfilter hook {"payload": ..., "handled": false} ይመልሳል፤ "handled": true ቀጣይ hooksን ያቆማል። ስህተቶች እና የጊዜ ገደብ ማለፎች የቀደመውን 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ግዴታለባይነሪዎ የሚሰጡ ነጋሪ እሴቶች።
priority100ዝቅተኛው መጀመሪያ ይሄዳል።
timeoutMs500የጊዜ ገደብ በሚሊሰከንዶች።

commands

በ"slash": true፣ በውይይት ውስጥ /name args መተየብ ያለ ሰራተኛው command argsን በቀጥታ ያሄዳል። ውፅዓቱ ምላሹ ነው። የጊዜ ገደቡ 30 ሰከንዶች ነው።

routes

መስመር በቦቱ ላይ በ/api/v1/plugins/<slug>/api/<path> ለሚመጡ የHTTP ጥያቄዎች ምላሽ ይሰጣል፤ በ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 አድራሻ፣ ቶከን እና የሰራተኛውን መለያ ቁጥር ይስጡት። ካላስፈለገዎት ጠፍቶ ይቆያል።

setup

የማዋቀሪያ አዋቂ ባለቤቱን አንድ ቅጽ ሊሸፍናቸው በማይችላቸው ደረጃዎች ውስጥ ይመራዋል። ከform ደረጃዎች የሚገኙ እሴቶች በኋለኞቹ የgenerate ነጋሪ እሴቶች ውስጥ {{key}}ን ይሞላሉ። ከcredentials ደረጃዎች የሚገኙ እሴቶች እንደ ተሰኪው የአካባቢ ተለዋዋጮች ይቀመጣሉ።

"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 አሏቸው።