NeboAI
NeboAI
શરૂ કરો

plugin.json સંદર્ભ

plugin.json એ મેનિફેસ્ટ છે જે Nebo પ્લગઇન ઇન્સ્ટોલ કરવા અને ચલાવવા માટે વાંચે છે. કીઝ camelCaseમાં હોય છે. આ પેજ Nebo આજે વાંચે છે તે દરેક ફીલ્ડ અને દરેક શું કરે છે તેની યાદી આપે છે.

ટોચના સ્તરના ફીલ્ડ્સ

ફીલ્ડપ્રકારજરૂરીઅર્થ
idstringહાપ્લગઇનનો માર્કેટપ્લેસ ઓળખકર્તા. ડેવલપ કરતી વખતે સ્લગ વાપરો.
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 માર્કેટપ્લેસ ઇન્સ્ટોલની ચકાસણી કરે છે: સ્લગના નિયમો, સિમેન્ટિક વર્ઝન, ઓછામાં ઓછું એક પ્લેટફોર્મ, પાથ સેપરેટર્સ કે .. વગરનું 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બાઇટ્સમાં સાઇઝ.
downloadUrlજ્યાંથી Nebo પૅકેજ ડાઉનલોડ કરે છે.

ઑથ

ફીલ્ડઅર્થ
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ના જાહેર રીડાયરેક્ટ દ્વારા થાય છે.

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 પર લખે તે દરેક લાઇન એક ઇવેન્ટ છે. ચાલતી વખતે ઇવેન્ટના નામની આગળ સ્લગ લાગે છે, તેથી 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સ્લગ વગરનું ઇવેન્ટ નામ. જરૂરી.
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 stdin પર JSON પેલોડ લખે છે. action હૂકના આઉટપુટને અવગણવામાં આવે છે. filter હૂક {"payload": ..., "handled": false} પાછું આપે છે; "handled": true પછીના હૂકને અટકાવે છે. ભૂલો અને ટાઇમઆઉટ અગાઉનો પેલોડ રાખે છે અને ક્યારેય ટર્નને અટકાવતાં નથી. સળંગ ત્રણ નિષ્ફળતા પછી હૂક પાંચ મિનિટ માટે થોભાવાય છે.

ફીલ્ડડિફૉલ્ટઅર્થ
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ને મોકલે છે અને stdout પર newline-delimited JSON તરીકે સ્ટ્રીમ થયેલા ઇવેન્ટ્સ 300 સેકન્ડ સુધી વાંચે છે. આજે ફક્ત ચેટ સ્ટ્રીમિંગ વપરાય છે.

channel

ચેનલ મેસેજિંગ સર્વિસ સાથે બ્રિજ બનાવે છે. Nebo commandને ચાલુ રાખે છે, તેના stdoutમાંથી આવતા મેસેજ વાંચે છે અને તેના stdinમાં જવાબો લખે છે, બંને newline-delimited 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 હોય છે.