Ylätason kentät
| Kenttä | Tyyppi | Pakollinen | Merkitys |
|---|---|---|---|
id | string | kyllä | Laajennuksen tunniste kaupassa. Käytä slugia kehityksen aikana. |
slug | string | kyllä | 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. |
name | string | kyllä | Näyttönimi. Nimeä palvelu, johon laajennus yhdistää. |
version | string | kyllä | Semanttinen versio, esimerkiksi 0.1.0. |
platforms | map | kyllä | Alustan avain binääriin. Katso Alustat. |
description | string | ei | Yksi lause ihmisille ja työntekijöille. |
author | string | ei | Julkaisijan nimi. |
category | string | ei | Auttaa työntekijöitä löytämään laajennuksen. |
triggers | merkkijonolista | ei | Sanat, jotka kuvaavat, milloin laajennusta käytetään. Käytetään hakuvihjeissä. |
entrySkills | merkkijonolista | ei | Mukana tulevat taidot, jotka mainitaan ensimmäisinä laajennuksen työkalukuvauksessa. |
dependencies | lista muotoa {name, version, optional} | ei | Muut laajennukset, joita tämä laajennus suorittaa. version on oletuksena "*" ja optional false. Niiden <SLUG>_BIN-polut asetetaan jokaisessa kutsussa. |
auth | object | ei | Kirjautuminen ja tilit. Katso Todennus. |
capabilities | object | ei | configSchema, hooks, commands, routes, providers. |
permissions | object | ei | Ympäristön suodatus ja aikakatkaisun yläraja. |
events | list | ei | Tarkkailijat, jotka syöttävät työntekijöiden työnkulkuja. |
interfaceBindings | map | ei | Laajennuksen tarjoamat tyypitetyt toiminnot. |
channel | object | ei | Pysyvä silta viestipalveluun. |
setup | object | ei | Vaiheittainen 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 |
|---|---|
binaryName | Suoritettavan tiedoston nimi. Lisää Windowsissa .exe. |
sha256 | Binäärin tiiviste. Tarkistetaan asennuksen yhteydessä. |
signature | Binäärin allekirjoitus. Tarkistetaan asennuksen yhteydessä, kun allekirjoitusavain on saatavilla. |
size | Koko tavuina. |
downloadUrl | Mistä Nebo lataa paketin. |
Todennus
| Kenttä | Merkitys |
|---|---|
type | oauth_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. |
env | Muuttujan nimien ja oletusarvojen kartta. Myös ainoat tunnistetietojen nimet, jotka Nebo välittää login-komennolle. |
commands.login | Kirjaa sisään. Pakollinen, ellei type ole env. Suoritetaan tilikansio asetettuna. |
commands.status | Tulostaa JSONin, joka kertoo, onko tili kirjautunut sisään. |
commands.refresh | Uusii tunnuksen ilman vuorovaikutusta. |
commands.logout | Kirjaa ulos. Vain omistaja voi suorittaa sen. |
profileDirEnv | Muuttuja, joka saa erillisen tunnistetietokansion jokaiselle työntekijälle ja tilille. Ilman sitä laajennuksella on yksi jaettu tili. |
label, description | Yhdistämiskortin teksti. |
help | {url, urlLabel, text}, joka näytetään yhdistämisen aikana. |
publicRedirect | Aseta 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ä | Tyyppi | Oletus | Merkitys |
|---|---|---|---|
key | string | pakollinen | Ympäristömuuttujan nimi. |
label | string | pakollinen | Kentän nimiö. |
description | string | "" | Ohjeteksti. |
fieldType | string | "string" | Syötteen tyyppi, esimerkiksi string, number, boolean, select tai password. |
default | string | ei mitään | Valmiiksi täytetty arvo. |
required | boolean | false | Laajennus ei ole valmis, ennen kuin arvo on asetettu. |
secret | boolean | false | Arvo peitetään, kun se luetaan takaisin. |
options | merkkijonolista | ei mitään | Vaihtoehdot select-tyypille. |
permissions
| Kenttä | Oletus | Merkitys |
|---|---|---|
envAllow | [] | Perityt muuttujat, jotka laajennus saa nähdä. Tyhjä sallii kaikki. |
envDeny | [] | Perityt muuttujat, jotka poistetaan aina. |
maxTimeoutSeconds | 300 | Minkä tahansa kutsun aikakatkaisun yläraja. |
network | false | Ilmoittaa 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 |
|---|---|
name | Tapahtuman nimi ilman slugia. Pakollinen. |
command | Argumentit, jotka käynnistävät tarkkailijan. Pakollinen. {{key}} korvataan työntekijän syötearvoilla. |
description | Mikä aiheuttaa tapahtuman. |
multiplexed | Kun 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}"
} | Paikkamerkki | Laajenee 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ä | Oletus | Merkitys |
|---|---|---|
hook | pakollinen | Yksi 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. |
command | pakollinen | Binäärisi argumentit. |
priority | 100 | Pienempi suoritetaan ensin. |
timeoutMs | 500 | Aikaraja 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ä | Oletus | Merkitys |
|---|---|---|
command | pakollinen | Argumentit, jotka käynnistävät sillan. |
name, description | "" | Näytetään asetuksissa. |
restartDelaySecs | 5 | Odotusaika ennen uudelleenkäynnistystä kaatumisen jälkeen. |
shared | false | Yksi silta kaikille työntekijöille; viestit reititetään työntekijän nimen mukaan, ja vastauksissa on kunkin työntekijän identiteetti. |
needsLocalApi | false | Anna 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 laji | Kentät |
|---|---|
form | title, description, fields |
generate | title, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Näyttää komennon tulosteen kopioitavaksi. |
external | title, description, url, urlLabel, instructions |
credentials | title, description, fields, verifyCommand. Vaihe valmistuu, kun verifyCommand onnistuu. |
Kentillä on key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) ja required.