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 தொகுப்பைப் பதிவிறக்கும் இடம்.

அங்கீகாரம்

புலம்பொருள்
typeபிளகின் இயக்கும் உலாவி உள்நுழைவுக்கு oauth_cli; மதிப்புகளாக உள்ளிடப்படும் சான்றுகளுக்கு env; _TOKEN என முடியும் ஒவ்வொரு auth.env விசையிலும் உரிமையாளரின் NeboAI டோக்கனைப் பெற neboai.
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-இன் பொது திசைதிருப்பல் வழியாகச் செல்லும்.

நிலை வெளியீட்டில் authenticated, isAuthenticated, logged_in, loggedIn அல்லது token_valid ஆகியவற்றில் முதலில் வருவதை Nebo படிக்கிறது. காலியாக இல்லாத 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"
  }
]
புலம்பொருள்
nameslug இல்லாத நிகழ்வுப் பெயர். தேவை.
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

ஹூக் என்பது ஒரு பணியாளரின் முறையில் ஒரு குறிப்பிட்ட கட்டத்தில் உங்கள் கட்டளையை இயக்கும். Nebo ஒரு JSON payload-ஐ stdin இல் எழுதும். action ஹூக்கின் வெளியீடு புறக்கணிக்கப்படும். filter ஹூக் {"payload": ..., "handled": false} ஐத் திருப்பி அனுப்பும்; "handled": true அடுத்துவரும் ஹூக்குகளை நிறுத்தும். பிழைகளும் நேர முடிவுகளும் முந்தைய payload-ஐயே வைத்திருக்கும், ஒருபோதும் முறையைத் தடுக்காது. தொடர்ந்து மூன்று தோல்விகளுக்குப் பிறகு ஹூக் ஐந்து நிமிடங்களுக்கு இடைநிறுத்தப்படும்.

புலம்இயல்புநிலைபொருள்
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 முகவரி, ஒரு டோக்கன் மற்றும் பணியாளர் id-ஐக் கொடுக்கவும். தேவைப்பட்டால் மட்டுமே; இல்லையெனில் முடக்கத்தில் இருக்கும்.

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 ஆகியவை இருக்கும்.