Index (Core 2.1.5.1 API)

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

A

addArgument(String, Object) - Method in class me.neurodock.llm.tools.ToolArguments
addArguments(Map) - Method in class me.neurodock.llm.tools.ToolArguments
AddArrayMemory - Class in me.neurodock.core.memory.array
AddArrayMemory() - Constructor for class me.neurodock.core.memory.array.AddArrayMemory
addFact(String) - Method in class me.neurodock.core.LLMSystemPrompt.Context: Appends a single fact to this context block.
addMemory(String) - Method in class me.neurodock.core.memory.CoreMemory: Add an array-based memory
addMemory(String, int) - Method in class me.neurodock.core.memory.CoreMemory: Add an array-based memory
addMemory(String, String) - Method in class me.neurodock.core.memory.CoreMemory: Sets the memory.
AddMemoryFunction - Class in me.neurodock.core.memory: Provides the add_memory function.
This function adds a string to the memory.
AddMemoryFunction() - Constructor for class me.neurodock.core.memory.AddMemoryFunction
addMessage(Message) - Method in class me.neurodock.core.Core
addMessage(Message) - Method in class me.neurodock.llm.ChatObject
addProperty(String, ToolParameters.ToolParametersBuilder.Type, String) - Method in class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder: Add an optinal perameter to this ToolParameters.ToolParametersBuilder
addProperty(String, ToolParameters.ToolParametersBuilder.Type, String, boolean) - Method in class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder: Add a potentialy required peremeter to this ToolParameters.ToolParametersBuilder.
addSerializer(Class, ToolToJSON) - Method in class me.neurodock.llm.tools.serializer.ToolSerializer
addTool(Tool) - Method in class me.neurodock.core.Core: Adds a new tool to the System
ARRAY - Enum constant in enum class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder.Type: Represents a array parameter.
ARRAYED_MEMORY - Static variable in class me.neurodock.core.memory.CoreMemory: Memory type identifier for sequential/array-based memory storage.
ASSISTANT - Enum constant in enum class me.neurodock.llm.Message.Role

B

behavior(String) - Method in class me.neurodock.core.LLMSystemPrompt.Builder: Sets the pre-built behavior body for the prompt being built directly, bypassing LLMSystemPrompt.Builder.loadBehaviorFromFile(String).
Behavior() - Constructor for class me.neurodock.core.LLMSystemPrompt.Behavior
BOOLEAN - Enum constant in enum class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder.Type: Represents a boolean parameter.
build() - Method in class me.neurodock.core.LLMSystemPrompt.Builder: Builds the LLMSystemPrompt from the sections configured on this builder.
build() - Method in class me.neurodock.core.LLMSystemPrompt.Context: Joins all added facts into a single newline-separated string.
build() - Method in record class me.neurodock.core.LLMSystemPrompt.Identity: Builds the identity sentence from whichever of LLMSystemPrompt.Identity.name, LLMSystemPrompt.Identity.role, and LLMSystemPrompt.Identity.purpose are present, joining them with commas.
build() - Method in class me.neurodock.core.LLMSystemPrompt.OutputFormat: Returns the format specification text for rendering into the prompt.
build() - Method in class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder: Builds the ToolParameters
builder() - Static method in class me.neurodock.core.LLMSystemPrompt: Creates a new LLMSystemPrompt.Builder for assembling an LLMSystemPrompt.
builder() - Static method in class me.neurodock.llm.tools.ToolParameters: Creates a new instance of ToolParameters.ToolParametersBuilder.
Builder() - Constructor for class me.neurodock.core.LLMSystemPrompt.Builder

C

cancel() - Method in class me.neurodock.backend.open.ai.OpenAIModel
canSerialize(Class) - Method in class me.neurodock.llm.tools.serializer.ToolSerializer
capabilities(LLMSystemPrompt.Capabilities) - Method in class me.neurodock.core.LLMSystemPrompt.Builder: Sets the capability usage-hint definitions for the prompt being built.
Capabilities() - Constructor for class me.neurodock.core.LLMSystemPrompt.Capabilities
ChatObject - Class in me.neurodock.llm
ChatObject() - Constructor for class me.neurodock.llm.ChatObject
color() - Method in interface me.neurodock.core.PrintMessageHandler: Gets if color is supported by the PrintMessageHandler.
Constraints() - Constructor for class me.neurodock.core.LLMSystemPrompt.Behavior.Constraints
content - Variable in class me.neurodock.llm.Message
CONTENT_FILTER - Enum constant in enum class me.neurodock.backend.open.ai.OpenAIAssistentMessage.Reason
context(String) - Method in class me.neurodock.core.LLMSystemPrompt.Builder: Sets the pre-built static-context body for the prompt being built.
Context() - Constructor for class me.neurodock.core.LLMSystemPrompt.Context
Core - Class in me.neurodock.core: The Main class for the System, responsible for managing the OllamaObject, tools, and the Ollama API.
Core(PrintAdvanceMessageHandler) - Constructor for class me.neurodock.core.Core: Creates a new instance of Core with the provided PrintMessageHandler, defaulting the Ollama backend to localhost.
CoreMemory - Class in me.neurodock.core.memory: CoreMemory is a class that provides a way to store and retrieve strings from a file.
This is meant to be used as a way to store and retrieve strings from a file.
CoreMemory(String) - Constructor for class me.neurodock.core.memory.CoreMemory: Creates a new instance of CoreMemory.
Custom(String) - Constructor for record class me.neurodock.core.ToolCallingRender.Custom: Creates an instance of a Custom record class.

D

Default() - Constructor for record class me.neurodock.core.ToolCallingRender.Default: Creates an instance of a Default record class.
description() - Method in class me.neurodock.core.files.tools.ReadFileTool
description() - Method in class me.neurodock.core.memory.AddMemoryFunction
description() - Method in class me.neurodock.core.memory.GetMemoriesFunction
description() - Method in class me.neurodock.core.memory.GetMemoryFunction
description() - Method in class me.neurodock.core.memory.GetMemoryIdentitiesFunction
description() - Method in class me.neurodock.core.memory.RemoveMemoryFunction
description() - Method in class me.neurodock.llm.tools.FunctionTool: The description of the tool.
description() - Method in record class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder.Property: Returns the value of the description record component.

E

empty() - Static method in class me.neurodock.llm.tools.ToolParameters: Creates an empty ToolParameters
empty(String) - Static method in class me.neurodock.llm.tools.ToolResponse: Returns an empty tool response See ToolResponse.empty(String, String) for a reasoned/described response
empty(String, String) - Static method in class me.neurodock.llm.tools.ToolResponse: Returns an empty tool response with a reason/description.
emptyTools() - Static method in interface me.neurodock.llm.tools.Tool
enablePlugins(File) - Method in class me.neurodock.core.Core
ensureDir(String) - Static method in class me.neurodock.core.Core: Ensures that a directory exists at the given path, creating it if it does not.
ENUM - Enum constant in enum class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder.Type: Represents a enum parameter.
equals(Object) - Method in record class me.neurodock.core.LLMSystemPrompt.Identity: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.neurodock.core.ToolCallingRender.Custom: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.neurodock.core.ToolCallingRender.Default: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.neurodock.core.ToolCallingRender.Suppress: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder.Property: Indicates whether some other object is "equal to" this one.
exceptingTool - Variable in exception class me.neurodock.llm.exceptions.ToolException

F

FileHandler - Class in me.neurodock.core.files: Base class responsible for the me.neurodock.core.files related systems
FileHandler(Path) - Constructor for class me.neurodock.core.files.FileHandler: Creates a new instance as well as setting the FileHandler.instance to this new one A good start is to use Options.getFileHandlerDataLocation() as it's located along all other files
FileHandlerException - Exception Class in me.neurodock.core.files
FileHandlerException(String) - Constructor for exception class me.neurodock.core.files.FileHandlerException
flushLog() - Static method in class me.neurodock.core.Core: Flushes the log file
fromString(String) - Static method in enum class me.neurodock.backend.open.ai.OpenAIAssistentMessage.Reason
function(ToolArguments) - Method in class me.neurodock.core.files.tools.ReadFileTool
function(ToolArguments) - Method in class me.neurodock.core.files.tools.WriteFileTool
function(ToolArguments) - Method in class me.neurodock.core.memory.AddMemoryFunction
function(ToolArguments) - Method in class me.neurodock.core.memory.array.AddArrayMemory
function(ToolArguments) - Method in class me.neurodock.core.memory.array.GetArrayedMemories
function(ToolArguments) - Method in class me.neurodock.core.memory.array.GetArrayMemory
function(ToolArguments) - Method in class me.neurodock.core.memory.GetMemoriesFunction
function(ToolArguments) - Method in class me.neurodock.core.memory.GetMemoryFunction
function(ToolArguments) - Method in class me.neurodock.core.memory.GetMemoryIdentitiesFunction
function(ToolArguments) - Method in class me.neurodock.core.memory.RemoveMemoryFunction
function(ToolArguments) - Method in class me.neurodock.llm.tools.FunctionTool: Invokes the tool.
FUNCTION_CALL - Enum constant in enum class me.neurodock.backend.open.ai.OpenAIAssistentMessage.Reason
FunctionTool - Class in me.neurodock.llm.tools
FunctionTool() - Constructor for class me.neurodock.llm.tools.FunctionTool

G

generateCapabilities(ArrayList) - Method in class me.neurodock.core.LLMSystemPrompt: Compiles the <Capabilities> section from the tools currently registered on the given ArrayList<Tool>, using the usage hints defined in LLMSystemPrompt.capabilities.
generateSystemPrompt() - Method in class me.neurodock.core.LLMSystemPrompt: Renders this prompt's currently-set sections into a single system-role Message, ready to be sent to Ollama.
getArgument(String) - Method in class me.neurodock.llm.tools.ToolArguments
getArgument(String, Class) - Method in class me.neurodock.llm.tools.ToolArguments
GetArrayedMemories - Class in me.neurodock.core.memory.array
GetArrayedMemories() - Constructor for class me.neurodock.core.memory.array.GetArrayedMemories
getArrayMemories() - Method in class me.neurodock.core.memory.CoreMemory: Get all array-stored memories
GetArrayMemory - Class in me.neurodock.core.memory.array
GetArrayMemory() - Constructor for class me.neurodock.core.memory.array.GetArrayMemory
getCacheDirectory() - Method in class me.neurodock.core.Options
getChatObject() - Method in class me.neurodock.core.Core
getContent() - Method in class me.neurodock.llm.Message
getConversation() - Method in class me.neurodock.llm.ChatObject
getData() - Method in class me.neurodock.core.Options
getDataDir() - Method in class me.neurodock.core.Options
getDefaultToolSerializer() - Static method in class me.neurodock.backend.open.ai.OpenAIModel
getEndReason() - Method in class me.neurodock.backend.open.ai.OpenAIAssistentMessage
getErrorMessage() - Method in exception class me.neurodock.llm.exceptions.ToolException
getFacts() - Method in class me.neurodock.core.LLMSystemPrompt.Context: Returns the facts added to this context block so far, in insertion order.
getFileHandlerDataLocation() - Method in class me.neurodock.core.Options
getInstance() - Static method in class me.neurodock.core.files.FileHandler
getInstance() - Static method in class me.neurodock.core.LaunchOptions: Gets the singleton instance of the LaunchOptions class.
getInstance() - Static method in class me.neurodock.core.memory.CoreMemory: Gets the singleton instance of CoreMemory.
getInstance() - Static method in class me.neurodock.core.Options: Provides the singleton options object for modification to options
getKey() - Method in class me.neurodock.core.Pair: Gets the key of the pair.
getMappedMemories() - Method in class me.neurodock.core.memory.CoreMemory: Gets all memories as a JSON string.
getMemoriesArray() - Method in class me.neurodock.core.memory.CoreMemory
GetMemoriesFunction - Class in me.neurodock.core.memory
GetMemoriesFunction() - Constructor for class me.neurodock.core.memory.GetMemoriesFunction
getMemoriesIdentity() - Method in class me.neurodock.core.memory.CoreMemory: Gets the memory.
getMemory(int) - Method in class me.neurodock.core.memory.CoreMemory: Get the array-based memory at index
getMemory(String) - Method in class me.neurodock.core.memory.CoreMemory
GetMemoryFunction - Class in me.neurodock.core.memory: Provides the get_memory function.
This function retrives all the memory.
GetMemoryFunction() - Constructor for class me.neurodock.core.memory.GetMemoryFunction
GetMemoryIdentitiesFunction - Class in me.neurodock.core.memory
GetMemoryIdentitiesFunction() - Constructor for class me.neurodock.core.memory.GetMemoryIdentitiesFunction
getModel() - Method in class me.neurodock.core.Core: Gets the Ollama Object
getPluginDirectory() - Method in class me.neurodock.core.Options
getPort() - Method in class me.neurodock.core.LaunchOptions: Gets the port number that the API server should use.
getProperties() - Method in class me.neurodock.llm.tools.ToolParameters: Gets the properties of the ToolParameters
getRedirectOutput() - Method in class me.neurodock.core.LaunchOptions: Gets the file path that the program should redirect output to.
getRequired() - Method in class me.neurodock.llm.tools.ToolParameters: Gets the required parameters of the ToolParameters
getResponse() - Method in class me.neurodock.llm.tools.ToolResponse: Gets the response from the tool.
getRole() - Method in class me.neurodock.llm.Message
getSerializer(Class) - Method in class me.neurodock.llm.tools.serializer.ToolSerializer
getServerCredentials() - Method in class me.neurodock.core.LaunchOptions: get the credentials for the API Server
getTool() - Method in class me.neurodock.llm.tools.ToolResponse: Gets the tool that responded.
getToolCalls() - Method in class me.neurodock.llm.Message
getToolID() - Method in class me.neurodock.llm.Message
getTools() - Method in class me.neurodock.core.Core: Gets the list of tools added to the System
getTools() - Static method in class me.neurodock.core.files.FileHandler: Returns a list of all Tool's this module adds
getTools(Plugin) - Method in class me.neurodock.plugin.loader.Loader: Mock example!
getToolSerializer() - Method in class me.neurodock.backend.open.ai.OpenAIModel
getToolSerializer() - Method in interface me.neurodock.llm.Model
getType() - Method in enum class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder.Type: Gets the type of the parameter.
getValue() - Method in class me.neurodock.core.Pair: Gets the value of the pair.

H

handleResponse(Message) - Method in class me.neurodock.core.Core: Handles the response from Ollama.
hasArgument(String) - Method in class me.neurodock.llm.tools.ToolArguments
hashCode() - Method in record class me.neurodock.core.LLMSystemPrompt.Identity: Returns a hash code value for this object.
hashCode() - Method in record class me.neurodock.core.ToolCallingRender.Custom: Returns a hash code value for this object.
hashCode() - Method in record class me.neurodock.core.ToolCallingRender.Default: Returns a hash code value for this object.
hashCode() - Method in record class me.neurodock.core.ToolCallingRender.Suppress: Returns a hash code value for this object.
hashCode() - Method in record class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder.Property: Returns a hash code value for this object.

I

identity(LLMSystemPrompt.Identity) - Method in class me.neurodock.core.LLMSystemPrompt.Builder: Sets the identity/persona block for the prompt being built.
Identity(String, String, String) - Constructor for record class me.neurodock.core.LLMSystemPrompt.Identity: Creates an instance of a Identity record class.
initiateDirectories() - Method in class me.neurodock.core.Options
INT - Enum constant in enum class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder.Type: Represents an integer parameter.
isAutoAccept() - Method in class me.neurodock.core.LaunchOptions: Gets if the program should automatically accept prompts.
isLoadOld() - Method in class me.neurodock.core.LaunchOptions: Retries if old messages should be loaded.
isNotDisplay() - Method in class me.neurodock.core.LaunchOptions: Gets if the program is running in display mode.
isServerCredentialsEnabled() - Method in class me.neurodock.core.LaunchOptions: Gets weather or not the API Server requires credentials
isServerMode() - Method in class me.neurodock.core.LaunchOptions: Gets if the program is running in API server mode.
isShowFullMessage() - Method in class me.neurodock.core.LaunchOptions: Gets if the full message should be shown in the display.

L

LaunchOptions - Class in me.neurodock.core: The Configuration class, where arguments are stored and retrieved.
LENGTH - Enum constant in enum class me.neurodock.backend.open.ai.OpenAIAssistentMessage.Reason
ListFiles - Class in me.neurodock.core.files
ListFiles() - Constructor for class me.neurodock.core.files.ListFiles
LLMSystemPrompt - Class in me.neurodock.core: Compiles a structured system prompt for an LLM out of discrete, reusable pieces — identity, static context, tool-usage capabilities, behavior rules, and output format — instead of hand-writing and concatenating prompt strings inline.
LLMSystemPrompt(LLMSystemPrompt.Identity, String, LLMSystemPrompt.Capabilities, String, LLMSystemPrompt.OutputFormat) - Constructor for class me.neurodock.core.LLMSystemPrompt: Constructs a system prompt from its component parts.
LLMSystemPrompt.Behavior - Class in me.neurodock.core: The behavior/constraints section of a system prompt — tone, formatting rules, and other "how to behave" instructions.
LLMSystemPrompt.Behavior.Constraints - Class in me.neurodock.core: Structured constraints for a LLMSystemPrompt.Behavior block (tone, length limits, things to avoid, etc.).
LLMSystemPrompt.Builder - Class in me.neurodock.core: Builder for assembling an LLMSystemPrompt from its component sections.
LLMSystemPrompt.Capabilities - Class in me.neurodock.core: Defines per-tool usage-routing hints for the <Capabilities> section of a system prompt — i.e.
LLMSystemPrompt.Context - Class in me.neurodock.core: A builder for the static-facts <Context> section of a system prompt — things the model should always know (e.g.
LLMSystemPrompt.Identity - Record Class in me.neurodock.core: The persona/role block of a system prompt — who the model is and what it's for.
LLMSystemPrompt.OutputFormat - Class in me.neurodock.core: Specifies the expected output format for a system prompt's <Output> section — e.g.
loadBehaviorFromFile(String) - Method in class me.neurodock.core.LLMSystemPrompt.Builder: Loads LLMSystemPrompt.Builder.behavior from a text file, resolved in order against: the classpath Options.getDataDir() the current runtime/working directory an exact file path match
Loader - Class in me.neurodock.plugin.loader
Loader() - Constructor for class me.neurodock.plugin.loader.Loader
loadPlugin(JSONObject, JarFile, Path, Data) - Method in class me.neurodock.plugin.loader.Loader

M

MAPPED_MEMORY - Static variable in class me.neurodock.core.memory.CoreMemory: Memory type identifier for key-value mapped memory storage.
me.neurodock.backend.open.ai - package me.neurodock.backend.open.ai
me.neurodock.core - package me.neurodock.core
me.neurodock.core.files - package me.neurodock.core.files
me.neurodock.core.files.tools - package me.neurodock.core.files.tools
me.neurodock.core.memory - package me.neurodock.core.memory: A memory module for the AI Assistent to have the abilit to store memories between conversations, and over longer time TODO: Key-Value map memory bank alongside of the array based.
me.neurodock.core.memory.array - package me.neurodock.core.memory.array
me.neurodock.llm - package me.neurodock.llm
me.neurodock.llm.exceptions - package me.neurodock.llm.exceptions
me.neurodock.llm.tools - package me.neurodock.llm.tools
me.neurodock.llm.tools.serializer - package me.neurodock.llm.tools.serializer
me.neurodock.plugin.loader - package me.neurodock.plugin.loader
Message - Class in me.neurodock.llm
Message(Message.Role, Object) - Constructor for class me.neurodock.llm.Message
Message(Message.Role, Object, JSONArray) - Constructor for class me.neurodock.llm.Message
Message(Message.Role, String, Object) - Constructor for class me.neurodock.llm.Message
Message.Role - Enum Class in me.neurodock.llm
Model - Interface in me.neurodock.llm: This interface is used for when a backend dose not supports streaming responses, otherwise use StreamingModel
ModelNotFoundException - Exception Class in me.neurodock.llm.exceptions
ModelNotFoundException(String) - Constructor for exception class me.neurodock.llm.exceptions.ModelNotFoundException
ModelNotFoundException(String, String) - Constructor for exception class me.neurodock.llm.exceptions.ModelNotFoundException

N

name() - Method in class me.neurodock.core.files.tools.ReadFileTool
name() - Method in class me.neurodock.core.files.tools.WriteFileTool
name() - Method in record class me.neurodock.core.LLMSystemPrompt.Identity: Returns the value of the name record component.
name() - Method in class me.neurodock.core.memory.AddMemoryFunction
name() - Method in class me.neurodock.core.memory.array.AddArrayMemory
name() - Method in class me.neurodock.core.memory.array.GetArrayedMemories
name() - Method in class me.neurodock.core.memory.array.GetArrayMemory
name() - Method in class me.neurodock.core.memory.GetMemoriesFunction
name() - Method in class me.neurodock.core.memory.GetMemoryFunction
name() - Method in class me.neurodock.core.memory.GetMemoryIdentitiesFunction
name() - Method in class me.neurodock.core.memory.RemoveMemoryFunction
name() - Method in class me.neurodock.llm.tools.FunctionTool: The name of the tool.
name() - Method in interface me.neurodock.llm.tools.Tool: The name of the tool, as sent to the model.
NULL - Enum constant in enum class me.neurodock.backend.open.ai.OpenAIAssistentMessage.Reason: Still streaming, or null

O

OBJECT - Enum constant in enum class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder.Type: Represents a object parameter.
OpenAIAssistentMessage - Class in me.neurodock.backend.open.ai
OpenAIAssistentMessage(Message.Role, Object, OpenAIAssistentMessage.Reason) - Constructor for class me.neurodock.backend.open.ai.OpenAIAssistentMessage
OpenAIAssistentMessage(Message.Role, Object, JSONArray, OpenAIAssistentMessage.Reason) - Constructor for class me.neurodock.backend.open.ai.OpenAIAssistentMessage
OpenAIAssistentMessage(Message.Role, String, Object, OpenAIAssistentMessage.Reason) - Constructor for class me.neurodock.backend.open.ai.OpenAIAssistentMessage
OpenAIAssistentMessage.Reason - Enum Class in me.neurodock.backend.open.ai
OpenAIModel - Class in me.neurodock.backend.open.ai
OpenAIModel(String, String) - Constructor for class me.neurodock.backend.open.ai.OpenAIModel: Constructs an me.neurodock.backend.open.ai.OpenAIModel bound to a specific backend and model.
optArgument(String) - Method in class me.neurodock.llm.tools.ToolArguments
optArgument(String, Class) - Method in class me.neurodock.llm.tools.ToolArguments
optArgument(String, Class, T) - Method in class me.neurodock.llm.tools.ToolArguments
optArgument(String, Object) - Method in class me.neurodock.llm.tools.ToolArguments
Options - Class in me.neurodock.core
Options() - Constructor for class me.neurodock.core.Options
outputFormat(LLMSystemPrompt.OutputFormat) - Method in class me.neurodock.core.LLMSystemPrompt.Builder: Sets the output format specification for the prompt being built.
OutputFormat(String) - Constructor for class me.neurodock.core.LLMSystemPrompt.OutputFormat: Creates an output format from a raw, pre-formatted string.
OutputFormat(JSONObject) - Constructor for class me.neurodock.core.LLMSystemPrompt.OutputFormat: Creates an output format from a JSON schema.

P

Pair<K,V> - Class in me.neurodock.core: A simple Pair class.
Pair(K, V) - Constructor for class me.neurodock.core.Pair: Creates a new instance of Pair.
parameters() - Method in class me.neurodock.core.files.tools.ReadFileTool
parameters() - Method in class me.neurodock.core.files.tools.WriteFileTool
parameters() - Method in class me.neurodock.core.memory.AddMemoryFunction
parameters() - Method in class me.neurodock.core.memory.array.AddArrayMemory
parameters() - Method in class me.neurodock.core.memory.array.GetArrayedMemories
parameters() - Method in class me.neurodock.core.memory.array.GetArrayMemory
parameters() - Method in class me.neurodock.core.memory.GetMemoriesFunction
parameters() - Method in class me.neurodock.core.memory.GetMemoryFunction
parameters() - Method in class me.neurodock.core.memory.GetMemoryIdentitiesFunction
parameters() - Method in class me.neurodock.core.memory.RemoveMemoryFunction
parameters() - Method in class me.neurodock.llm.tools.FunctionTool: The parameters this tool accepts.
path(File) - Method in class me.neurodock.core.files.FileHandler: Provides a relative path from FileHandler.root to file
PrintAdvanceMessageHandler - Interface in me.neurodock.core: Represents a PrintAdvanceMessageHandler.
printError(String) - Method in interface me.neurodock.core.PrintMessageHandler: Default method to print error messages to the user or API Client.
printErrorMessage(Message) - Method in interface me.neurodock.core.PrintAdvanceMessageHandler: Default method to print error messages to the user or API Client.
printErrorMessage(Message) - Method in interface me.neurodock.core.PrintMessageHandler: This is a default implementation when wrapping PrintAdvanceMessageHandler to this "simpler" PrintMessageHandler Default method to print error messages to the user or API Client.
printMessage(String) - Method in interface me.neurodock.core.PrintMessageHandler: Handles the printing of a message.
printMessage(Message) - Method in interface me.neurodock.core.PrintAdvanceMessageHandler: Expected to handle the printing of the provided Message.
printMessage(Message) - Method in interface me.neurodock.core.PrintMessageHandler: This is a default implementation when wrapping PrintAdvanceMessageHandler to this "simpler" PrintMessageHandler
PrintMessageHandler - Interface in me.neurodock.core: Represents a PrintMessageHandler.
printToolCalling(String) - Method in interface me.neurodock.core.PrintAdvanceMessageHandler: Used when a tool is to have it's calling rendered
printToolCalling(String) - Method in interface me.neurodock.core.PrintMessageHandler
Property(ToolParameters.ToolParametersBuilder.Type, String) - Constructor for record class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder.Property: Creates a new instance of ToolParameters.ToolParametersBuilder.Property.
purpose() - Method in record class me.neurodock.core.LLMSystemPrompt.Identity: Returns the value of the purpose record component.

Q

queryJSON(JSONObject, String, String, Consumer) - Method in class me.neurodock.backend.open.ai.OpenAIModel: Sends a blocking HTTP request to the given endpoint on the configured backend and parses the response body as JSON.
queryModel() - Method in class me.neurodock.core.Core
queryModel(Consumer) - Method in class me.neurodock.core.Core
qurryModel(ChatObject, List) - Method in class me.neurodock.backend.open.ai.OpenAIModel: Sends the conversation history in obj to the backend and requests the next assistant response.
qurryModel(ChatObject, List) - Method in interface me.neurodock.llm.Model: Sends the given chat context to the model and requests the next response.
qurryModel(ChatObject, List, Consumer) - Method in class me.neurodock.backend.open.ai.OpenAIModel
qurryModel(ChatObject, List, Consumer) - Method in interface me.neurodock.llm.StreamingModel

R

readFile(String) - Method in class me.neurodock.core.files.FileHandler
ReadFileTool - Class in me.neurodock.core.files.tools
ReadFileTool() - Constructor for class me.neurodock.core.files.tools.ReadFileTool
removeMemory(String) - Method in class me.neurodock.core.memory.CoreMemory: Removes the memory.
RemoveMemoryFunction - Class in me.neurodock.core.memory: Provides the remove_memory function.
This function removes a value from the memory.
RemoveMemoryFunction() - Constructor for class me.neurodock.core.memory.RemoveMemoryFunction
removeProperty(String) - Method in class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder: Removes a property from the parameters.
removeTool(String) - Method in class me.neurodock.core.Core: Removes a tool with a given name
renderCalling(JSONObject) - Method in interface me.neurodock.llm.tools.Tool
representation() - Method in record class me.neurodock.core.ToolCallingRender.Custom: Returns the value of the representation record component.
required(String) - Method in class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder: Makes a previusly optinal perameter required for this ToolParameters.ToolParametersBuilder
resolve(String) - Method in class me.neurodock.core.files.FileHandler
role - Variable in class me.neurodock.llm.Message
role() - Method in record class me.neurodock.core.LLMSystemPrompt.Identity: Returns the value of the role record component.

S

serialize(T) - Method in class me.neurodock.llm.tools.serializer.ToolSerializer
setAutoAccept(boolean) - Method in class me.neurodock.core.LaunchOptions: Sets if the program should automatically accept prompts.
setDataDir(Path, boolean) - Method in class me.neurodock.core.Options
setInstance(LaunchOptions) - Static method in class me.neurodock.core.LaunchOptions: Sets the singleton instance of the LaunchOptions class.
setInstance(Options) - Static method in class me.neurodock.core.Options: Sets a new singleton options object
setKey(K) - Method in class me.neurodock.core.Pair: Sets the key of the pair.
setLoadOld(boolean) - Method in class me.neurodock.core.LaunchOptions: Sets if old messages should be loaded.
setLogDirectory(String) - Static method in class me.neurodock.core.Core
setModel(Model) - Method in class me.neurodock.core.Core: Sets the Core.model object to the provided argument, Also adds the memory base system.
setModelNoMemory(Model) - Method in class me.neurodock.core.Core: Sets the Core.model object to the provided argument, Does not add the base system for memory.
setNotDisplay(boolean) - Method in class me.neurodock.core.LaunchOptions: Sets if the program is running in display mode.
setPort(int) - Method in class me.neurodock.core.LaunchOptions: Sets the port number that the API server should use.
setRedirectOutput(String) - Method in class me.neurodock.core.LaunchOptions: Sets the file path that the program should redirect output to.
setServerCredentials(String) - Method in class me.neurodock.core.LaunchOptions: Sets the credentials used by the API Server
setServerCredentialsEnabled(boolean) - Method in class me.neurodock.core.LaunchOptions: Sets weather credentials are needed for the API Server
setServerMode(boolean) - Method in class me.neurodock.core.LaunchOptions: Sets if the program is running in API server mode.
setShowFullMessage(boolean) - Method in class me.neurodock.core.LaunchOptions: Sets if the full message should be shown in the display.
setToolID(String) - Method in class me.neurodock.llm.tools.ToolResponse
setValue(V) - Method in class me.neurodock.core.Pair: Sets the value of the pair.
singleFire(Message) - Method in class me.neurodock.backend.open.ai.OpenAIModel
singleFire(Message) - Method in interface me.neurodock.llm.Model: Sends a single, standalone message to the model, without any prior conversation context.
singleFire(Message, Consumer) - Method in class me.neurodock.backend.open.ai.OpenAIModel
singleFire(Message, Consumer) - Method in interface me.neurodock.llm.StreamingModel
singleFire(Message, List) - Method in class me.neurodock.backend.open.ai.OpenAIModel
singleFire(Message, List) - Method in interface me.neurodock.llm.Model: Sends a single, standalone message to the model with tool support, without any prior conversation context.
singleFire(Message, List, Consumer) - Method in class me.neurodock.backend.open.ai.OpenAIModel
singleFire(Message, List, Consumer) - Method in interface me.neurodock.llm.StreamingModel
STOP - Enum constant in enum class me.neurodock.backend.open.ai.OpenAIAssistentMessage.Reason
StreamingModel - Interface in me.neurodock.llm: This interface is used for when a backend supports streaming responses, otherwise use Model
STRING - Enum constant in enum class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder.Type: Represents a string parameter.
Suppress() - Constructor for record class me.neurodock.core.ToolCallingRender.Suppress: Creates an instance of a Suppress record class.
SYSTEM - Enum constant in enum class me.neurodock.llm.Message.Role

T

toJSON(T) - Method in interface me.neurodock.llm.tools.serializer.ToolToJSON
Tool - Interface in me.neurodock.llm.tools
TOOL - Enum constant in enum class me.neurodock.llm.Message.Role
TOOL_CALLS - Enum constant in enum class me.neurodock.backend.open.ai.OpenAIAssistentMessage.Reason
ToolArguments - Class in me.neurodock.llm.tools
ToolArguments() - Constructor for class me.neurodock.llm.tools.ToolArguments
ToolCallingRender - Interface in me.neurodock.core
ToolCallingRender.Custom - Record Class in me.neurodock.core
ToolCallingRender.Default - Record Class in me.neurodock.core
ToolCallingRender.Suppress - Record Class in me.neurodock.core
toolCalls - Variable in class me.neurodock.llm.Message
ToolException - Exception Class in me.neurodock.llm.exceptions
ToolException(Tool, String) - Constructor for exception class me.neurodock.llm.exceptions.ToolException
ToolException(Tool, Throwable) - Constructor for exception class me.neurodock.llm.exceptions.ToolException
toolID - Variable in class me.neurodock.llm.Message
ToolParameters - Class in me.neurodock.llm.tools: Represents the parameters of a tool.
ToolParameters.ToolParametersBuilder - Class in me.neurodock.llm.tools: Represents a builder for ToolParameters.
ToolParameters.ToolParametersBuilder.Property - Record Class in me.neurodock.llm.tools: Represents a property of a parameter.
ToolParameters.ToolParametersBuilder.Type - Enum Class in me.neurodock.llm.tools: Represents the type of parameter.
ToolParametersBuilder() - Constructor for class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder
ToolResponse - Class in me.neurodock.llm.tools: Represents a response from a tool.
ToolResponse(String, String) - Constructor for class me.neurodock.llm.tools.ToolResponse: Creates a new instance of ToolResponse.
ToolSerializer - Class in me.neurodock.llm.tools.serializer
ToolSerializer() - Constructor for class me.neurodock.llm.tools.serializer.ToolSerializer
ToolToJSON<T> - Interface in me.neurodock.llm.tools.serializer
toString() - Method in record class me.neurodock.core.LLMSystemPrompt.Identity: Returns a string representation of this record class.
toString() - Method in record class me.neurodock.core.ToolCallingRender.Custom: Returns a string representation of this record class.
toString() - Method in record class me.neurodock.core.ToolCallingRender.Default: Returns a string representation of this record class.
toString() - Method in record class me.neurodock.core.ToolCallingRender.Suppress: Returns a string representation of this record class.
toString() - Method in class me.neurodock.llm.Message
toString() - Method in record class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder.Property: Returns a string representation of this record class.
type() - Method in record class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder.Property: Returns the value of the type record component.

U

unload() - Method in class me.neurodock.backend.open.ai.OpenAIModel: Unloads the current model.
And ignoring any errors
use(Class, String) - Method in class me.neurodock.core.LLMSystemPrompt.Capabilities: Registers a usage-routing hint for a tool class — guidance on when the model should reach for this tool, e.g.
USER - Enum constant in enum class me.neurodock.llm.Message.Role

V

valueOf(String) - Static method in enum class me.neurodock.backend.open.ai.OpenAIAssistentMessage.Reason: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.neurodock.llm.Message.Role: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder.Type: Returns the enum constant of this class with the specified name.
values() - Static method in enum class me.neurodock.backend.open.ai.OpenAIAssistentMessage.Reason: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.neurodock.llm.Message.Role: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.neurodock.llm.tools.ToolParameters.ToolParametersBuilder.Type: Returns an array containing the constants of this enum class, in the order they are declared.
VERSION - Static variable in class me.neurodock.core.memory.CoreMemory

W

WriteFileTool - Class in me.neurodock.core.files.tools
WriteFileTool() - Constructor for class me.neurodock.core.files.tools.WriteFileTool
writeLog(String) - Static method in class me.neurodock.core.Core: Writes a message to the log file

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