NeboAI
NeboAI
Aloita

plugin.json-viite

plugin.json on manifesti, jonka Nebo lukee asentaakseen ja suorittaakseen laajennuksen. Avaimet kirjoitetaan camelCase-muodossa. Tällä sivulla on jokainen kenttä, jonka Nebo nykyään lukee, ja mitä kukin tekee.

Ylätason kentät

KenttäTyyppiPakollinenMerkitys
idstringkylläLaajennuksen tunniste kaupassa. Käytä slugia kehityksen aikana.
slugstringkylläPysyvä tunniste. [a-z0-9-], enintään 64 merkkiä, ei yhdysmerkkiä alussa tai lopussa eikä kahta peräkkäin. Nimeää plugin__<slug>-työkalun ja <SLUG>_BIN-muuttujan.
namestringkylläNäyttönimi. Nimeä palvelu, johon laajennus yhdistää.
versionstringkylläSemanttinen versio, esimerkiksi 0.1.0.
platformsmapkylläAlustan avain binääriin. Katso Alustat.
descriptionstringeiYksi lause ihmisille ja työntekijöille.
authorstringeiJulkaisijan nimi.
categorystringeiAuttaa työntekijöitä löytämään laajennuksen.
triggersmerkkijonolistaeiSanat, jotka kuvaavat, milloin laajennusta käytetään. Käytetään hakuvihjeissä.
entrySkillsmerkkijonolistaeiMukana tulevat taidot, jotka mainitaan ensimmäisinä laajennuksen työkalukuvauksessa.
dependencieslista muotoa {name, version, optional}eiMuut laajennukset, joita tämä laajennus suorittaa. version on oletuksena "*" ja optional false. Niiden <SLUG>_BIN-polut asetetaan jokaisessa kutsussa.
authobjecteiKirjautuminen ja tilit. Katso Todennus.
capabilitiesobjecteiconfigSchema, hooks, commands, routes, providers.
permissionsobjecteiYmpäristön suodatus ja aikakatkaisun yläraja.
eventslisteiTarkkailijat, jotka syöttävät työntekijöiden työnkulkuja.
interfaceBindingsmapeiLaajennuksen tarjoamat tyypitetyt toiminnot.
channelobjecteiPysyvä silta viestipalveluun.
setupobjecteiVaiheittainen ohjattu asennus.

Nebo tarkistaa kaupasta tehdyt asennukset: slug-säännöt, semanttisen version, vähintään yhden alustan, binaryName-arvon ilman polkuerottimia tai merkintää .., login-komennon, ellei auth.type ole env, ei-tyhjät tapahtumien nimet ja komennot sekä jäsentyvät sidontamallit. Käyttäjän laajennuskansiossa olevat laajennukset ohittavat tarkistuksen.

Alustat

Avaimet ovat darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64 ja windows-amd64. Jokaisessa merkinnässä on kaikki alla olevat viisi kenttää. Kun julkaiset, kauppa kirjoittaa oikean tiivisteen, koon, allekirjoituksen ja latausosoitteen, joten jätä ne tyhjiksi lataamassasi tiedostossa.

"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": "" }
}
KenttäMerkitys
binaryNameSuoritettavan tiedoston nimi. Lisää Windowsissa .exe.
sha256Binäärin tiiviste. Tarkistetaan asennuksen yhteydessä.
signatureBinäärin allekirjoitus. Tarkistetaan asennuksen yhteydessä, kun allekirjoitusavain on saatavilla.
sizeKoko tavuina.
downloadUrlMistä Nebo lataa paketin.

Todennus

KenttäMerkitys
typeoauth_cli laajennuksen suorittamaan selainkirjautumiseen; env arvoina syötettäviin tunnistetietoihin; neboai, jolloin omistajan NeboAI-tunnus välitetään jokaiseen _TOKEN-päätteiseen auth.env-avaimeen.
envMuuttujan nimien ja oletusarvojen kartta. Myös ainoat tunnistetietojen nimet, jotka Nebo välittää login-komennolle.
commands.loginKirjaa sisään. Pakollinen, ellei type ole env. Suoritetaan tilikansio asetettuna.
commands.statusTulostaa JSONin, joka kertoo, onko tili kirjautunut sisään.
commands.refreshUusii tunnuksen ilman vuorovaikutusta.
commands.logoutKirjaa ulos. Vain omistaja voi suorittaa sen.
profileDirEnvMuuttuja, joka saa erillisen tunnistetietokansion jokaiselle työntekijälle ja tilille. Ilman sitä laajennuksella on yksi jaettu tili.
label, descriptionYhdistämiskortin teksti.
help{url, urlLabel, text}, joka näytetään yhdistämisen aikana.
publicRedirectAseta arvoksi true, kun palveluntarjoaja ei hyväksy http://localhost-uudelleenohjauksia; kirjautuminen kulkee silloin NeboAI:n julkisen uudelleenohjauksen kautta.

Nebo lukee tilatulosteesta ensimmäisen näistä: authenticated, isAuthenticated, logged_in, loggedIn tai token_valid. Ei-tyhjä token_error tai arvo none kentässä credential_source, auth_method, storage tai status tarkoittaa, ettei tili ole kirjautunut. Tilakomennolla on aikaa 45 sekuntia.

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

configSchema

capabilities.configSchema kuvaa arvot, jotka omistaja asettaa laajennukselle. Jokainen arvo välitetään binäärille ympäristömuuttujana, jonka nimi on key. Tunnistetietoavaimille, jotka on lueteltu myös kohdassa auth.env, skeema nimeää työntekijäkohtaisen yhdistämislomakkeen kentät.

KenttäTyyppiOletusMerkitys
keystringpakollinenYmpäristömuuttujan nimi.
labelstringpakollinenKentän nimiö.
descriptionstring""Ohjeteksti.
fieldTypestring"string"Syötteen tyyppi, esimerkiksi string, number, boolean, select tai password.
defaultstringei mitäänValmiiksi täytetty arvo.
requiredbooleanfalseLaajennus ei ole valmis, ennen kuin arvo on asetettu.
secretbooleanfalseArvo peitetään, kun se luetaan takaisin.
optionsmerkkijonolistaei mitäänVaihtoehdot select-tyypille.

permissions

KenttäOletusMerkitys
envAllow[]Perityt muuttujat, jotka laajennus saa nähdä. Tyhjä sallii kaikki.
envDeny[]Perityt muuttujat, jotka poistetaan aina.
maxTimeoutSeconds300Minkä tahansa kutsun aikakatkaisun yläraja.
networkfalseIlmoittaa verkon käytöstä. Tiedoksi; ei valvota.

events

Tapahtuma on pitkään käynnissä oleva tarkkailija. Nebo käynnistää sen, kun työntekijän työnkulku tarkkailee sitä, ja käynnistää sen uudelleen, jos se pysähtyy. Jokainen rivi, jonka tarkkailija kirjoittaa stdoutiin, on yksi tapahtuma. Tapahtuman nimen eteen lisätään ajon aikana slug, joten note.created muuttuu muotoon notes-sync.note.created.

"events": [
  {
    "name": "note.created",
    "description": "A note was created in the watched notebook.",
    "command": "watch --notebook {{notebook}} --format ndjson"
  }
]
KenttäMerkitys
nameTapahtuman nimi ilman slugia. Pakollinen.
commandArgumentit, jotka käynnistävät tarkkailijan. Pakollinen. {{key}} korvataan työntekijän syötearvoilla.
descriptionMikä aiheuttaa tapahtuman.
multiplexedKun arvo on true, yksi tarkkailija lähettää useita tapahtumatyyppejä ja jokaisella rivillä on "event"-kenttä.

Työnkulut tilaavat tapahtumia watch-laukaisimella. Katso Laukaisimet.

interfaceBindings

Sidonta yhdistää rajapinnan toiminnon yhteen komennoistasi. Jokaisesta sidonnasta tulee työntekijöille tyypitetty työkalu, joka on nimetty toiminnon mukaan pienillä kirjaimilla, pisteet ja yhdysmerkit alaviivoiksi muutettuina: notes.search muuttuu muotoon notes_search. Sidonnoilla laajennus täyttää työntekijän vaatimat kyvyt; katso Kyvyt.

"interfaceBindings": {
  "notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
  "invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
}
PaikkamerkkiLaajenee muotoon
{field}Kentän arvo yhtenä sanana. Kenttää ei välitetä lisäksi lippuna.
{field[]:--flag}Yksi --flag <item>-pari jokaiselle listakentän kohteelle.
{field?:--flag}--flag <value>, kun kenttä on mukana; ei mitään, kun se puuttuu.
{field:cents->dollars}Kokonaislukusumma sentteinä, kirjoitettuna dollareina.

Syötekentät, joita malli ei nimeä, lisätään loppuun muodossa --field value. Lista- ja valinnaisten paikkamerkkien on oltava kokonaisia sanoja. Hyväksyntää vaativaan toimintoon ei pääse kutsumalla samaa komentoa plugin__<slug>-työkalun kautta.

Koukut, kauttaviivakomennot ja reitit

"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 suorittaa komentosi tietyssä kohdassa työntekijän vuoroa. Nebo kirjoittaa JSON-sisällön stdiniin. action-hookin tuloste ohitetaan. filter-hook palauttaa {"payload": ..., "handled": false}; "handled": true pysäyttää myöhemmät hookit. Virheet ja aikakatkaisut säilyttävät edellisen sisällön eivätkä koskaan estä vuoroa. Kolmen peräkkäisen epäonnistumisen jälkeen hook keskeytetään viideksi minuutiksi.

KenttäOletusMerkitys
hookpakollinenYksi seuraavista: tool.pre_execute, tool.post_execute, message.post_receive, session.message_append, steering.generate, agent.turn, agent.should_continue.
hookType"action"action tai filter.
commandpakollinenBinäärisi argumentit.
priority100Pienempi suoritetaan ensin.
timeoutMs500Aikaraja millisekunteina.

commands

Kun asetus on "slash": true, /name args -komennon kirjoittaminen keskusteluun suorittaa command args suoraan, ilman työntekijää. Tuloste on vastaus. Aikaraja on 30 sekuntia.

routes

Reitti vastaa botin HTTP-pyyntöihin osoitteessa /api/v1/plugins/<slug>/api/<path>, ja se valitaan kenttien path ja method perusteella. Pyynnön runko menee stdiniin, ja stdout-tulosteesi on vastaus. Aikaraja on 30 sekuntia.

providers

Palveluntarjoaja lisää keskustelumallien lähteen. Määritä id, displayName, providerType, modelsCommand ja chatCommand. Nebo lähettää keskustelupyynnön JSONina stdiniin komennolle chatCommand ja lukee suoratoistetut tapahtumat rivinvaihdoin erotettuna JSONina stdoutista enintään 300 sekunnin ajan. Nykyään käytetään vain keskustelun suoratoistoa.

channel

Kanava yhdistää viestipalvelun. Nebo pitää command-komennon käynnissä, lukee saapuvat viestit sen stdoutista ja kirjoittaa vastaukset sen stdiniin, molemmat rivinvaihdoin erotettuna JSONina.

KenttäOletusMerkitys
commandpakollinenArgumentit, jotka käynnistävät sillan.
name, description""Näytetään asetuksissa.
restartDelaySecs5Odotusaika ennen uudelleenkäynnistystä kaatumisen jälkeen.
sharedfalseYksi silta kaikille työntekijöille; viestit reititetään työntekijän nimen mukaan, ja vastauksissa on kunkin työntekijän identiteetti.
needsLocalApifalseAnna sillalle botin paikallisen API:n osoite, tunnus ja työntekijän tunniste. Pois päältä, ellet tarvitse sitä.

setup

Ohjattu asennus vie omistajan vaiheiden läpi, joita yksi lomake ei kata. form-vaiheiden arvot täyttävät {{key}}-kohdat myöhemmissä generate-argumenteissa. credentials-vaiheiden arvot tallennetaan laajennuksen ympäristömuuttujiksi.

"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" }
  ]
}
Vaiheen lajiKentät
formtitle, description, fields
generatetitle, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Näyttää komennon tulosteen kopioitavaksi.
externaltitle, description, url, urlLabel, instructions
credentialstitle, description, fields, verifyCommand. Vaihe valmistuu, kun verifyCommand onnistuu.

Kentillä on key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) ja required.