NeboAI
NeboAI
Kezdés

plugin.json referencia

A plugin.json az a jegyzék, amelyet a Nebo beolvas egy bővítmény telepítéséhez és futtatásához. A kulcsok camelCase formájúak. Ez az oldal felsorol minden mezőt, amelyet a Nebo jelenleg beolvas, és hogy melyik mit csinál.

Felső szintű mezők

MezőTípusKötelezőJelentés
idstringigenA bővítmény piactéri azonosítója. Fejlesztés közben használja a slugot.
slugstringigenÁllandó azonosító. [a-z0-9-], legfeljebb 64 karakter, nem kezdődhet és nem végződhet kötőjellel, és nem tartalmazhat dupla kötőjelet. Ez adja a plugin__<slug> eszköz és a <SLUG>_BIN változó nevét.
namestringigenMegjelenített név. Nevezze meg a szolgáltatást, amelyhez kapcsolódik.
versionstringigenSzemantikus verzió, például 0.1.0.
platformsmapigenPlatformkulcs és bináris összerendelése. Lásd: Platformok.
descriptionstringnemEgy mondat embereknek és munkatársaknak.
authorstringnemA kiadó neve.
categorystringnemSegít a munkatársaknak megtalálni a bővítményt.
triggerskarakterláncok listájanemSzavak, amelyek leírják, mikor alkalmazható a bővítmény. Keresési javaslatokhoz használatos.
entrySkillskarakterláncok listájanemA csomagban lévő készségek, amelyeket elsőként kell megnevezni a bővítmény eszközleírásában.
dependencies{name, version, optional} listájanemMás bővítmények, amelyeket ez futtat. A version alapértéke "*", az optional értéke false. A <SLUG>_BIN elérési útjaik minden hívásnál be vannak állítva.
authobjectnemBejelentkezés és fiókok. Lásd: Hitelesítés.
capabilitiesobjectnemconfigSchema, hooks, commands, routes, providers.
permissionsobjectnemKörnyezeti szűrés és az időkorlát felső határa.
eventslistnemFigyelők, amelyek a munkatársak munkafolyamatait táplálják.
interfaceBindingsmapnemA bővítmény által nyújtott típusos műveletek.
channelobjectnemTartós híd egy üzenetküldő szolgáltatás felé.
setupobjectnemLépésenkénti beállítási varázsló.

A Nebo ellenőrzi a piactéri telepítéseket: a slug szabályait, a szemantikus verziót, legalább egy platformot, az útvonal-elválasztót és .. részt nem tartalmazó binaryName értéket, a login parancsot (hacsak az auth.type nem env), a nem üres eseményneveket és parancsokat, valamint azt, hogy a kötési sablonok értelmezhetők-e. A felhasználói bővítménymappában lévő bővítmények kihagyják az ellenőrzést.

Platformok

A kulcsok: darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64 és windows-amd64. Minden bejegyzés tartalmazza az alábbi öt mezőt. Közzétételkor a piactér beírja a valódi hasht, méretet, aláírást és letöltési URL-t, ezért a feltöltött fájlban hagyja ezeket üresen.

"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": "" }
}
MezőJelentés
binaryNameA futtatható fájl neve. Windowson tegye hozzá a .exe kiterjesztést.
sha256A bináris hashe. Telepítéskor ellenőrzi.
signatureA bináris aláírása. Telepítéskor ellenőrzi, ha elérhető aláírókulcs.
sizeMéret bájtban.
downloadUrlAhonnan a Nebo letölti a csomagot.

Hitelesítés

MezőJelentés
typeoauth_cli a bővítmény által futtatott böngészős bejelentkezéshez; env értékként megadott hitelesítő adatokhoz; neboai, hogy a bővítmény megkapja a tulajdonos NeboAI-tokenjét minden _TOKEN végű auth.env kulcsban.
envVáltozónév és alapérték összerendelése. Egyben ezek az egyetlen hitelesítőadat-nevek, amelyeket a Nebo átad a login parancsnak.
commands.loginBejelentkeztet. Kötelező, hacsak a type nem env. A fiókmappa beállításával fut.
commands.statusJSON-t ír ki arról, hogy a fiók be van-e jelentkezve.
commands.refreshFelhasználói beavatkozás nélkül megújít egy tokent.
commands.logoutKijelentkeztet. Csak a tulajdonos futtathatja.
profileDirEnvVáltozó, amely munkatársanként és fiókonként külön hitelesítőadat-mappát kap. Enélkül a bővítmény egyetlen közös fiókot használ.
label, descriptionA csatlakozási kártya szövege.
helpCsatlakozás közben megjelenő {url, urlLabel, text}.
publicRedirectÁllítsa true értékre, ha a szolgáltató elutasítja a http://localhost átirányításokat; ekkor a bejelentkezés a NeboAI nyilvános átirányításán keresztül történik.

A Nebo az állapotkimenetben az elsőt olvassa be a következők közül: authenticated, isAuthenticated, logged_in, loggedIn vagy token_valid. Egy nem üres token_error, vagy a none érték a credential_source, auth_method, storage vagy status mezőben kijelentkezett állapotot jelent. Az állapotparancsnak 45 másodperce van.

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

configSchema

A capabilities.configSchema azokat az értékeket írja le, amelyeket a tulajdonos beállít a bővítményhez. Minden érték a key által megnevezett környezeti változóként jut el a binárishoz. Az auth.env alatt is felsorolt hitelesítőadat-kulcsok esetén a séma a munkatársankénti csatlakozási űrlap mezőinek címkéit adja.

MezőTípusAlapértékJelentés
keystringkötelezőKörnyezeti változó neve.
labelstringkötelezőA mező címkéje.
descriptionstring""Súgószöveg.
fieldTypestring"string"Bemeneti típus, például string, number, boolean, select vagy password.
defaultstringnincsElőre kitöltött érték.
requiredbooleanfalseA bővítmény addig nem áll készen, amíg az érték nincs beállítva.
secretbooleanfalseVisszaolvasáskor az érték maszkolva jelenik meg.
optionskarakterláncok listájanincsVálasztási lehetőségek a select típushoz.

permissions

MezőAlapértékJelentés
envAllow[]Örökölt változók, amelyeket a bővítmény láthat. Üresen mindet engedi.
envDeny[]Örökölt változók, amelyek mindig eltávolításra kerülnek.
maxTimeoutSeconds300Bármely hívás időkorlátjának felső határa.
networkfalseHálózathasználatot jelez. Tájékoztató jellegű; nincs kikényszerítve.

events

Az esemény egy hosszan futó figyelő. A Nebo akkor indítja el, amikor egy munkatárs munkafolyamata figyeli, és újraindítja, ha leáll. A figyelő által a stdoutra írt minden sor egy esemény. Futáskor az esemény neve elé kerül a slug, így a note.created ebből lesz: notes-sync.note.created.

"events": [
  {
    "name": "note.created",
    "description": "A note was created in the watched notebook.",
    "command": "watch --notebook {{notebook}} --format ndjson"
  }
]
MezőJelentés
nameAz esemény neve slug nélkül. Kötelező.
commandA figyelőt elindító argumentumok. Kötelező. A {{key}} helyére a munkatárs bemeneti értékei kerülnek.
descriptionMi váltja ki az eseményt.
multiplexedHa true, egy figyelő több eseménytípust bocsát ki, és minden sor tartalmaz egy "event" mezőt.

A munkafolyamatok watch indítóval iratkoznak fel az eseményekre. Lásd: Indítók.

interfaceBindings

A kötés egy interfészműveletet rendel az Ön egyik parancsához. Minden kötésből típusos eszköz lesz a munkatársak számára, amelynek neve a művelet neve kisbetűvel, a pontok és kötőjelek helyén aláhúzással: a notes.search ebből lesz: notes_search. A bővítmény a kötésekkel teljesíti azokat a képességeket, amelyeket egy munkatárs megkövetel; lásd: Képességek.

"interfaceBindings": {
  "notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
  "invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
}
HelyőrzőErre bővül
{field}A mező értéke egyetlen szóként. A mezőt nem adja át kapcsolóként is.
{field[]:--flag}Egy --flag <item> pár egy listamező minden eleméhez.
{field?:--flag}--flag <value>, ha a mező jelen van; semmi, ha hiányzik.
{field:cents->dollars}Centben megadott egész összeg, dollárban kiírva.

A sablon által meg nem nevezett bemeneti mezők --field value formában a végére kerülnek. A lista- és opcionális helyőrzőknek teljes szavaknak kell lenniük. Egy jóváhagyást igénylő művelet nem érhető el úgy, hogy ugyanazt a parancsot a plugin__<slug> eszközön keresztül hívják meg.

Hookok, perjeles parancsok és útvonalak

"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

A hook az Ön parancsát futtatja egy munkatárs körének egy adott pontján. A Nebo JSON-adatot ír a stdin bemenetre. Az action hook kimenetét a rendszer figyelmen kívül hagyja. A filter hook {"payload": ..., "handled": false} értéket ad vissza; a "handled": true leállítja a későbbi hookokat. Hibák és időtúllépések esetén az előző adat marad meg, és a kör soha nem akad el. Három egymást követő hiba után a hook öt percre szünetel.

MezőAlapértékJelentés
hookkötelezőA következők egyike: tool.pre_execute, tool.post_execute, message.post_receive, session.message_append, steering.generate, agent.turn, agent.should_continue.
hookType"action"action vagy filter.
commandkötelezőArgumentumok a binárisához.
priority100Az alacsonyabb fut előbb.
timeoutMs500Időkorlát ezredmásodpercben.

commands

A "slash": true beállítással a csevegésbe írt /name args közvetlenül futtatja a command args parancsot, a munkatárs nélkül. A kimenet a válasz. Az időkorlát 30 másodperc.

routes

Az útvonal a boton a /api/v1/plugins/<slug>/api/<path> címen válaszol HTTP-kérésekre, a path és a method alapján illesztve. A kérés törzse a stdinre kerül, az Ön stdout kimenete pedig a válasz. Az időkorlát 30 másodperc.

providers

A szolgáltató egy csevegőmodell-forrást ad hozzá. Adja meg az id, displayName, providerType, modelsCommand és chatCommand értékeket. A Nebo a csevegési kérést JSON-ként küldi a chatCommand stdin bemenetére, és legfeljebb 300 másodpercig olvassa a stdoutról a soronként elválasztott JSON formátumú, folyamatosan érkező eseményeket. Jelenleg csak a csevegés folyamatos továbbítása használatos.

channel

A csatorna egy üzenetküldő szolgáltatást köt be. A Nebo folyamatosan futtatja a command parancsot, a stdoutjáról olvassa a bejövő üzeneteket, és a stdinjére írja a válaszokat, mindkettőt soronként elválasztott JSON-ként.

MezőAlapértékJelentés
commandkötelezőA hidat elindító argumentumok.
name, description""A beállításokban jelenik meg.
restartDelaySecs5Várakozás összeomlás utáni újraindítás előtt.
sharedfalseEgy híd az összes munkatársnak; az üzenetek a munkatárs neve alapján kerülnek továbbításra, és a válaszok az egyes munkatársak identitását hordozzák.
needsLocalApifalseMegadja a hídnak a bot helyi API-címét, egy tokent és a munkatárs azonosítóját. Kikapcsolva, hacsak nincs rá szüksége.

setup

A beállítási varázsló végigvezeti a tulajdonost azokon a lépéseken, amelyeket egyetlen űrlap nem tud lefedni. A form lépések értékei kitöltik a {{key}} helyőrzőket a későbbi generate argumentumokban. A credentials lépések értékei a bővítmény környezeti változóiként mentődnek.

"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" }
  ]
}
Lépés típusaMezők
formtitle, description, fields
generatetitle, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Megjeleníti a parancs kimenetét másoláshoz.
externaltitle, description, url, urlLabel, instructions
credentialstitle, description, fields, verifyCommand. A lépés akkor teljesül, amikor a verifyCommand sikeresen lefut.

A mezők tulajdonságai: key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) és required.