Index

C D E G I L M N O P R T
All Classes and Interfaces|All Packages|Serialized Form

C

callTool(ToolArguments) - Method in class me.neurodock.plugin.tool.Tool

This is the main course of the tool.

D

Data - Class in me.neurodock.plugin

Data() - Constructor for class me.neurodock.plugin.Data

dependencies() - Element in annotation interface me.neurodock.plugin.annotations.PluginEntryPoint

description() - Method in class me.neurodock.plugin.tool.Tool

Description for the LLM on what this tool does

E

empty() - Static method in class me.neurodock.plugin.tool.ToolParameters

An empty ToolParameters for when a tool dosent need any perameters

empty(String) - Static method in class me.neurodock.plugin.tool.ToolResponse

empty(Tool) - Static method in class me.neurodock.plugin.tool.ToolResponse

G

getAuthor() - Method in interface me.neurodock.plugin.PluginMetadata

A String containing a list of all authors for this
May be empty, but may not be null

getCacheDirectory() - Method in class me.neurodock.plugin.Data

getDataDictionary() - Method in class me.neurodock.plugin.Data

getDescription() - Method in interface me.neurodock.plugin.PluginMetadata

Description for the tool, shuld be an explanatory, yet simple description

getLoadedPlugins() - Method in class me.neurodock.plugin.Data

getMetadata() - Method in class me.neurodock.plugin.Plugin

This represents your plugin's Metadata

getName() - Method in interface me.neurodock.plugin.PluginMetadata

Returns the name of the plugin

getToolJSON() - Method in class me.neurodock.plugin.tool.Tool

The core uses this method when generating the list of available functions to the LLM

getToolName() - Method in exception class me.neurodock.plugin.exceptions.ToolRuntimeException

getTools() - Method in class me.neurodock.plugin.Plugin

The "main" method of a plugin, it will be the one returning a list of all tools you define.

getVersion() - Method in interface me.neurodock.plugin.PluginMetadata

Version of the project

I

InjectPluginMetadata - Annotation Interface in me.neurodock.plugin.annotations

L

LoadedPlugins - Class in me.neurodock.plugin

LoadedPlugins() - Constructor for class me.neurodock.plugin.LoadedPlugins

M

me.neurodock.plugin - package me.neurodock.plugin

me.neurodock.plugin.annotations - package me.neurodock.plugin.annotations

me.neurodock.plugin.exceptions - package me.neurodock.plugin.exceptions

me.neurodock.plugin.tool - package me.neurodock.plugin.tool

N

name() - Method in class me.neurodock.plugin.tool.Tool

Name of the tool.

O

onDisable() - Method in class me.neurodock.plugin.Plugin

This will be called if the core gets a "fetal" exception or fails to fetch certain info

onEnable() - Method in class me.neurodock.plugin.Plugin

This will be called after all plugins have been initialised; here it is safe to perform potential stuff where you load data from optional dependencies, or similar things

onInit() - Method in class me.neurodock.plugin.Plugin

This will be called once every plugin has been loaded

P

parameters() - Method in class me.neurodock.plugin.tool.Tool

The parameters this tool allows

Plugin - Class in me.neurodock.plugin

Entry point for the plugin, this is required for the plugin to work, and you MUST annotate it with PluginEntryPoint

Plugin() - Constructor for class me.neurodock.plugin.Plugin

This shuld be used if PluginEntryPoint.requireData() is false (default)

Plugin(Data) - Constructor for class me.neurodock.plugin.Plugin

This shuld be used if PluginEntryPoint.requireData() is true

PLUGIN - Variable in class me.neurodock.plugin.tool.Tool

The parent plugin of this tool, used by Tool.getToolJSON().

PluginEntryPoint - Annotation Interface in me.neurodock.plugin.annotations

PluginLoadingException - Exception Class in me.neurodock.plugin.exceptions

PluginLoadingException(String, String) - Constructor for exception class me.neurodock.plugin.exceptions.PluginLoadingException

PluginMetadata - Interface in me.neurodock.plugin

Interface defining the core properties/information about the plugin

R

requireData() - Element in annotation interface me.neurodock.plugin.annotations.PluginEntryPoint

T

Tool - Class in me.neurodock.plugin.tool

Tool(Plugin) - Constructor for class me.neurodock.plugin.tool.Tool

A base contructor, as the Plugin is used within this class

ToolArguments - Class in me.neurodock.plugin.tool

ToolArguments() - Constructor for class me.neurodock.plugin.tool.ToolArguments

ToolParameters - Class in me.neurodock.plugin.tool

ToolParameters() - Constructor for class me.neurodock.plugin.tool.ToolParameters

ToolResponse - Class in me.neurodock.plugin.tool

ToolResponse() - Constructor for class me.neurodock.plugin.tool.ToolResponse

ToolRuntimeException - Exception Class in me.neurodock.plugin.exceptions

ToolRuntimeException(String, String) - Constructor for exception class me.neurodock.plugin.exceptions.ToolRuntimeException

ToolRuntimeException(String, String, Throwable) - Constructor for exception class me.neurodock.plugin.exceptions.ToolRuntimeException

ToolRuntimeException(String, Throwable) - Constructor for exception class me.neurodock.plugin.exceptions.ToolRuntimeException

ToolRuntimeException(Tool, String) - Constructor for exception class me.neurodock.plugin.exceptions.ToolRuntimeException

ToolRuntimeException(Tool, String, Throwable) - Constructor for exception class me.neurodock.plugin.exceptions.ToolRuntimeException

ToolRuntimeException(Tool, Throwable) - Constructor for exception class me.neurodock.plugin.exceptions.ToolRuntimeException

C D E G I L M N O P R T
All Classes and Interfaces|All Packages|Serialized Form