Index (Plugin-API 0.1.2 API)

A C D E G H I L M N O P R T U
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addArgument(String, Object) - Method in class me.neurodock.plugin.tool.ToolArguments
addArguments(Map) - Method in class me.neurodock.plugin.tool.ToolArguments

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: NOT YET IMPLEMENTED!
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 record class me.neurodock.plugin.tool.ToolResponse
empty(Tool) - Static method in record class me.neurodock.plugin.tool.ToolResponse
equals(Object) - Method in record class me.neurodock.plugin.LoadedPlugin: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.neurodock.plugin.tool.ToolResponse: Indicates whether some other object is "equal to" this one.

G

getArgument(String) - Method in class me.neurodock.plugin.tool.ToolArguments
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

H

hasArgument(String) - Method in class me.neurodock.plugin.tool.ToolArguments
hashCode() - Method in record class me.neurodock.plugin.LoadedPlugin: Returns a hash code value for this object.
hashCode() - Method in record class me.neurodock.plugin.tool.ToolResponse: Returns a hash code value for this object.

I

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

L

LoadedPlugin - Record Class in me.neurodock.plugin
LoadedPlugin(Plugin, ClassLoader, PluginMetadata) - Constructor for record class me.neurodock.plugin.LoadedPlugin: Creates an instance of a LoadedPlugin record class.
loader() - Method in record class me.neurodock.plugin.LoadedPlugin: Returns the value of the loader record component.

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
metaData() - Method in record class me.neurodock.plugin.LoadedPlugin: Returns the value of the metaData record component.

N

name() - Method in class me.neurodock.plugin.tool.Tool: Name of the tool.
name() - Method in record class me.neurodock.plugin.tool.ToolResponse: Returns the value of the name record component.

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 AND the plugin was able to be loaded.
onEnable() - Method in class me.neurodock.plugin.Plugin: This will be called after all plugins have been initialized; 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() - Method in record class me.neurodock.plugin.LoadedPlugin: Returns the value of the plugin record component.
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
PluginLoadingException(String, Throwable, 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
response() - Method in record class me.neurodock.plugin.tool.ToolResponse: Returns the value of the response record component.
RPCP_SOURCE - Static variable in class me.neurodock.plugin.tool.Tool: Magic constant for RPCP sources.
This is solely here to replace the case of a magic string being used in the code

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 - Record Class in me.neurodock.plugin.tool
ToolResponse(String, String) - Constructor for record class me.neurodock.plugin.tool.ToolResponse: Creates an instance of a ToolResponse record class.
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
toString() - Method in record class me.neurodock.plugin.LoadedPlugin: Returns a string representation of this record class.
toString() - Method in record class me.neurodock.plugin.tool.ToolResponse: Returns a string representation of this record class.

U

UNKNOWN_PLUGIN - Static variable in class me.neurodock.plugin.Plugin: This is a magic constant plugin name used for when a plugin's name cant be loaded

A C D E G H I L M N O P R T U
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form