Updated OllamaFunctionTool.toString to reflect what the Ollama API actually wants

Added @NotNull annotation to OllamaFunctionTool.name and OllamaFunctionTool.parameters since the documentation reports as these being required

Made sure that OllamaFunctionTool.description is actually optional as the Ollama API docs define

API/src/main/java/me/zacharias/chat/api/APITool.java

@@ -8,6 +8,8 @@ import me.zacharias.chat.ollama.OllamaFunctionTool;
 import me.zacharias.chat.ollama.OllamaPerameter;
 import me.zacharias.chat.ollama.OllamaToolRespnce;
 import me.zacharias.chat.ollama.exceptions.OllamaToolErrorException;
+import org.jetbrains.annotations.NotNull;
+import org.jspecify.annotations.NonNull;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.client.RestTemplate;
 import org.springframework.web.util.UriComponentsBuilder;
@@ -45,7 +47,7 @@ public class APITool extends OllamaFunctionTool {
     }
 
     @Override
-    public String name() {
+    public @NonNull String name() {
         return name;
     }
 
@@ -55,7 +57,7 @@ public class APITool extends OllamaFunctionTool {
     }
 
     @Override
-    public OllamaPerameter parameters() {
+    public @NotNull OllamaPerameter parameters() {
         OllamaPerameter.OllamaPerameterBuilder parameter = OllamaPerameter.builder();
         for (ToolArgument argument : arguments) {
             parameter.addProperty(argument.getName(), argument.getType(), argument.getDescription(), argument.isRequired());

Core/src/main/java/me/zacharias/chat/core/files/tools/ReadFileTool.java

@@ -6,6 +6,7 @@ import me.zacharias.chat.ollama.OllamaFunctionTool;
 import me.zacharias.chat.ollama.OllamaPerameter;
 import me.zacharias.chat.ollama.OllamaToolRespnce;
 import me.zacharias.chat.ollama.exceptions.OllamaToolErrorException;
+import org.jetbrains.annotations.NotNull;
 
 import java.io.*;
 import java.nio.file.Path;
@@ -13,7 +14,7 @@ import java.nio.file.Path;
 public class ReadFileTool extends OllamaFunctionTool {
     FileHandler fs = FileHandler.getInstance();
     @Override
-    public String name() {
+    public @NotNull String name() {
         return "read_file";
     }
 
@@ -23,7 +24,7 @@ public class ReadFileTool extends OllamaFunctionTool {
     }
 
     @Override
-    public OllamaPerameter parameters() {
+    public @NotNull OllamaPerameter parameters() {
         return OllamaPerameter.builder()
                 .addProperty("file_path", OllamaPerameter.OllamaPerameterBuilder.Type.STRING, "The path to the file to be read")
                 .build();

Core/src/main/java/me/zacharias/chat/core/memory/AddMemoryFunction.java

@@ -5,6 +5,7 @@ import me.zacharias.chat.ollama.OllamaFunctionTool;
 import me.zacharias.chat.ollama.OllamaPerameter;
 import me.zacharias.chat.ollama.OllamaToolRespnce;
 import me.zacharias.chat.ollama.exceptions.OllamaToolErrorException;
+import org.jetbrains.annotations.NotNull;
 
 /**
  * Provides the add_memory function.<br>
@@ -17,7 +18,7 @@ public class AddMemoryFunction extends OllamaFunctionTool {
     CoreMemory memory = CoreMemory.getInstance();
 
     @Override
-    public String name() {
+    public @NotNull String name() {
         return "add_memory";
     }
 
@@ -27,7 +28,7 @@ public class AddMemoryFunction extends OllamaFunctionTool {
     }
 
     @Override
-    public OllamaPerameter parameters() {
+    public @NotNull OllamaPerameter parameters() {
         return OllamaPerameter.builder()
                 .addProperty("memory", OllamaPerameter.OllamaPerameterBuilder.Type.STRING, "The memory to remember", true)
                 .addProperty("identity", OllamaPerameter.OllamaPerameterBuilder.Type.STRING, "The identity of the memory to remember", true)

Core/src/main/java/me/zacharias/chat/core/memory/GetMemoriesFunction.java

@@ -4,10 +4,11 @@ import me.zacharias.chat.ollama.OllamaFunctionArgument;
 import me.zacharias.chat.ollama.OllamaFunctionTool;
 import me.zacharias.chat.ollama.OllamaPerameter;
 import me.zacharias.chat.ollama.OllamaToolRespnce;
+import org.jetbrains.annotations.NotNull;
 
 public class GetMemoriesFunction extends OllamaFunctionTool {
     @Override
-    public String name() {
+    public @NotNull String name() {
         return "get_memories";
     }
 
@@ -17,7 +18,7 @@ public class GetMemoriesFunction extends OllamaFunctionTool {
     }
 
     @Override
-    public OllamaPerameter parameters() {
+    public @NotNull OllamaPerameter parameters() {
         return null;
     }
 

Core/src/main/java/me/zacharias/chat/core/memory/GetMemoryFunction.java

@@ -4,8 +4,7 @@ import me.zacharias.chat.ollama.OllamaFunctionArgument;
 import me.zacharias.chat.ollama.OllamaFunctionTool;
 import me.zacharias.chat.ollama.OllamaPerameter;
 import me.zacharias.chat.ollama.OllamaToolRespnce;
-import org.json.JSONArray;
+import org.jetbrains.annotations.NotNull;
-import org.json.JSONObject;
 
 /**
  * Provides the get_memory function.<br>
@@ -18,7 +17,7 @@ public class GetMemoryFunction extends OllamaFunctionTool {
     CoreMemory memory = CoreMemory.getInstance();
 
     @Override
-    public String name() {
+    public @NotNull String name() {
         return "get_memory";
     }
 
@@ -28,7 +27,7 @@ public class GetMemoryFunction extends OllamaFunctionTool {
     }
 
     @Override
-    public OllamaPerameter parameters() {
+    public @NotNull OllamaPerameter parameters() {
         return OllamaPerameter.builder()
                 .addProperty("identity", OllamaPerameter.OllamaPerameterBuilder.Type.STRING, "The identity of the memory to retrieve", true)
                 .build();

Core/src/main/java/me/zacharias/chat/core/memory/GetMemoryIdentitiesFunction.java

@@ -4,13 +4,14 @@ import me.zacharias.chat.ollama.OllamaFunctionArgument;
 import me.zacharias.chat.ollama.OllamaFunctionTool;
 import me.zacharias.chat.ollama.OllamaPerameter;
 import me.zacharias.chat.ollama.OllamaToolRespnce;
+import org.jetbrains.annotations.NotNull;
 import org.json.JSONArray;
 
 public class GetMemoryIdentitiesFunction extends OllamaFunctionTool {
     CoreMemory memory = CoreMemory.getInstance();
 
     @Override
-    public String name() {
+    public @NotNull String name() {
         return "get_memory_identities";
     }
 
@@ -20,7 +21,7 @@ public class GetMemoryIdentitiesFunction extends OllamaFunctionTool {
     }
 
     @Override
-    public OllamaPerameter parameters() {
+    public @NotNull OllamaPerameter parameters() {
         return null;
     }
 

Core/src/main/java/me/zacharias/chat/core/memory/RemoveMemoryFunction.java

@@ -5,6 +5,7 @@ import me.zacharias.chat.ollama.OllamaFunctionTool;
 import me.zacharias.chat.ollama.OllamaPerameter;
 import me.zacharias.chat.ollama.OllamaToolRespnce;
 import me.zacharias.chat.ollama.exceptions.OllamaToolErrorException;
+import org.jetbrains.annotations.NotNull;
 
 /**
  * Provides the remove_memory function.<br>
@@ -17,7 +18,7 @@ public class RemoveMemoryFunction extends OllamaFunctionTool {
     CoreMemory memory = CoreMemory.getInstance();
 
     @Override
-    public String name() {
+    public @NotNull String name() {
         return "remove_memory";
     }
 
@@ -27,7 +28,7 @@ public class RemoveMemoryFunction extends OllamaFunctionTool {
     }
 
     @Override
-    public OllamaPerameter parameters() {
+    public @NotNull OllamaPerameter parameters() {
         return OllamaPerameter.builder()
                 .addProperty("identity", OllamaPerameter.OllamaPerameterBuilder.Type.STRING, "The identity of the memory to forget", true)
                 .build();

Core/src/main/java/me/zacharias/chat/ollama/OllamaFunctionTool.java

@@ -2,6 +2,7 @@ package me.zacharias.chat.ollama;
 
 import me.zacharias.chat.core.Core;
 import me.zacharias.chat.ollama.exceptions.OllamaToolErrorException;
+import org.jetbrains.annotations.NotNull;
 import org.json.JSONObject;
 
 /**
@@ -9,16 +10,22 @@ import org.json.JSONObject;
  */
 public abstract class OllamaFunctionTool implements OllamaTool {
 
+    /**
+     * This field is set via Reflection injection from {@link OllamaObject#addTool(OllamaTool, String)}.
+     * As is, it will be over written. Do not set it yourself.
+     */
     protected String source = "";
 
     @Override
     public String toString() {
         JSONObject ret = new JSONObject();
-        ret.put("tool", "function");
+        ret.put("type", "function");
 
         JSONObject function = new JSONObject();
         function.put("name", name()+(source != null ? source : ""));
-        function.put("description", description());
+        if(description() != null) {
+            function.put("description", description());
+        }
         function.put("parameters", (parameters() == null?
                 new JSONObject() : new JSONObject(parameters().toString())));
 
@@ -32,6 +39,7 @@ public abstract class OllamaFunctionTool implements OllamaTool {
      * This is used by Ollama to know what the tool is
      * @return The name of the tool
      */
+    @NotNull
     abstract public String name();
     
     /**
@@ -39,14 +47,18 @@ public abstract class OllamaFunctionTool implements OllamaTool {
      * This is used by Ollama to know what the tool does
      * @return The description of the tool
      */
-    abstract public String description();
+    public String description(){
+        return null;
+    }
     
     /**
      * The parameters of the tool
      * This is used by Ollama to know what parameters the tool takes
      * If null, the tool does not take any parameters
+     *
      * @return The parameters of the tool or null if the tool does not take any parameters
      */
+    @NotNull
     abstract public OllamaPerameter parameters();
     
     /**

Display/src/main/java/me/zacharias/chat/display/PythonRunner.java

@@ -1,9 +1,6 @@
 package me.zacharias.chat.display;
 
 import com.github.dockerjava.api.DockerClient;
-import com.github.dockerjava.api.async.ResultCallback;
-import com.github.dockerjava.api.command.*;
-import com.github.dockerjava.api.model.Frame;
 import com.github.dockerjava.api.model.HostConfig;
 import com.github.dockerjava.core.DefaultDockerClientConfig;
 import com.github.dockerjava.core.DockerClientImpl;
@@ -14,8 +11,10 @@ import me.zacharias.chat.core.Pair;
 import me.zacharias.chat.ollama.*;
 import me.zacharias.chat.ollama.exceptions.OllamaToolErrorException;
 import org.apache.commons.io.IOUtils;
+import org.jetbrains.annotations.NotNull;
 import org.json.JSONArray;
 import org.json.JSONObject;
+import org.jspecify.annotations.NonNull;
 
 import java.io.*;
 import java.net.ServerSocket;
@@ -28,7 +27,6 @@ import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 import java.util.concurrent.ConcurrentHashMap;
-import java.util.logging.Logger;
 
 import static me.zacharias.chat.core.Core.writeLog;
 
@@ -266,7 +264,7 @@ public class PythonRunner extends OllamaFunctionTool {
     }
 
     @Override
-    public String name() {
+    public @NonNull String name() {
         return "python_runner";
     }
 
@@ -276,7 +274,7 @@ public class PythonRunner extends OllamaFunctionTool {
     }
 
     @Override
-    public OllamaPerameter parameters() {
+    public @NotNull OllamaPerameter parameters() {
         return OllamaPerameter.builder()
                 .addProperty("code", OllamaPerameter.OllamaPerameterBuilder.Type.STRING, "The code to be executed, optional if a file with the same name exists.")
                 .addProperty("name", OllamaPerameter.OllamaPerameterBuilder.Type.STRING, "The name of the python code")

Display/src/main/java/me/zacharias/chat/display/TimeTool.java

@@ -4,6 +4,8 @@ import me.zacharias.chat.ollama.OllamaFunctionArgument;
 import me.zacharias.chat.ollama.OllamaFunctionTool;
 import me.zacharias.chat.ollama.OllamaPerameter;
 import me.zacharias.chat.ollama.OllamaToolRespnce;
+import org.jetbrains.annotations.NotNull;
+import org.jspecify.annotations.NonNull;
 
 import java.util.Date;
 
@@ -20,12 +22,12 @@ public class TimeTool extends OllamaFunctionTool {
     }
 
     @Override
-    public String name() {
+    public @NonNull String name() {
         return "get_current_date";
     }
 
     @Override
-    public OllamaPerameter parameters() {
+    public @NotNull OllamaPerameter parameters() {
         return null;
     }
 

GeniusAPI/src/main/java/me/zacharias/neuro/dock/genius/endpoints/FindSong.java

@@ -7,6 +7,7 @@ import me.zacharias.chat.ollama.exceptions.OllamaToolErrorException;
 import me.zacharias.neuro.dock.genius.GeniusEndpoint;
 import me.zacharias.neuro.dock.genius.GeniusEndpointTool;
 import me.zacharias.neuro.dock.genius.GeniusTools;
+import org.jetbrains.annotations.NotNull;
 import org.json.JSONArray;
 import org.json.JSONObject;
 
@@ -21,7 +22,7 @@ public class FindSong extends GeniusEndpointTool {
     }
 
     @Override
-    public String name() {
+    public @NotNull String name() {
         return "findsong";
     }
 
@@ -31,7 +32,7 @@ public class FindSong extends GeniusEndpointTool {
     }
 
     @Override
-    public OllamaPerameter parameters() {
+    public @NotNull OllamaPerameter parameters() {
         return OllamaPerameter.builder()
                 .addProperty("title", STRING, "The title, artitst, and song_id of the song to find.", true)
                 .build();

GeniusAPI/src/main/java/me/zacharias/neuro/dock/genius/endpoints/GetLyrics.java

@@ -7,6 +7,7 @@ import me.zacharias.chat.ollama.exceptions.OllamaToolErrorException;
 import me.zacharias.neuro.dock.genius.GeniusEndpoint;
 import me.zacharias.neuro.dock.genius.GeniusEndpointTool;
 import me.zacharias.neuro.dock.genius.GeniusTools;
+import org.jetbrains.annotations.NotNull;
 import org.json.JSONObject;
 import org.jsoup.Jsoup;
 import org.jsoup.nodes.Document;
@@ -15,8 +16,6 @@ import org.jsoup.nodes.Node;
 import org.jsoup.nodes.TextNode;
 import org.jsoup.select.Elements;
 
-import java.util.stream.Collectors;
-
 import static me.zacharias.chat.core.Core.writeLog;
 
 /**
@@ -40,7 +39,7 @@ public class GetLyrics extends GeniusEndpointTool {
     }
 
     @Override
-    public String name() {
+    public @NotNull String name() {
         return "get_lyrics";
     }
 
@@ -50,7 +49,7 @@ public class GetLyrics extends GeniusEndpointTool {
     }
 
     @Override
-    public OllamaPerameter parameters() {
+    public @NotNull OllamaPerameter parameters() {
         return OllamaPerameter.builder()
                 .addProperty("song_id", OllamaPerameter.OllamaPerameterBuilder.Type.INT, "The ID of the song to get lyrics for.", true)
                 .build();

MALAPITool/src/main/java/me/zacharias/chat/mal/api/endpoints/GetAnimeDetails.java

@@ -7,10 +7,10 @@ import me.zacharias.chat.ollama.OllamaFunctionArgument;
 import me.zacharias.chat.ollama.OllamaPerameter;
 import me.zacharias.chat.ollama.OllamaToolRespnce;
 import me.zacharias.chat.ollama.exceptions.OllamaToolErrorException;
+import org.jetbrains.annotations.NotNull;
 import org.json.JSONArray;
 import org.json.JSONObject;
 
-import java.util.ArrayList;
 import java.util.HashMap;
 
 @MALEndpoint
@@ -20,7 +20,7 @@ public class GetAnimeDetails extends MALEndpointTool {
     }
 
     @Override
-    public String name() {
+    public @NotNull String name() {
         return "get_anime_details";
     }
 
@@ -30,7 +30,7 @@ public class GetAnimeDetails extends MALEndpointTool {
     }
 
     @Override
-    public OllamaPerameter parameters() {
+    public @NotNull OllamaPerameter parameters() {
         return OllamaPerameter.builder()
                 .addProperty("id", OllamaPerameter.OllamaPerameterBuilder.Type.INT, "The id of the anime", true)
                 .addProperty("fields", OllamaPerameter.OllamaPerameterBuilder.Type.ARRAY, "The fields to return, defaults to [\"id\", \"title\", \"synopsis\", \"genres\"]")

MALAPITool/src/main/java/me/zacharias/chat/mal/api/endpoints/GetAnimeList.java

@@ -7,11 +7,11 @@ import me.zacharias.chat.ollama.OllamaFunctionArgument;
 import me.zacharias.chat.ollama.OllamaPerameter;
 import me.zacharias.chat.ollama.OllamaToolRespnce;
 import me.zacharias.chat.ollama.exceptions.OllamaToolErrorException;
+import org.jetbrains.annotations.NotNull;
 import org.json.JSONArray;
 import org.json.JSONObject;
 
 import java.util.HashMap;
-import java.util.Map;
 
 @MALEndpoint
 public class GetAnimeList extends MALEndpointTool {
@@ -20,7 +20,7 @@ public class GetAnimeList extends MALEndpointTool {
     }
 
     @Override
-    public String name() {
+    public @NotNull String name() {
         return "get_anime_list";
     }
 
@@ -30,7 +30,7 @@ public class GetAnimeList extends MALEndpointTool {
     }
 
     @Override
-    public OllamaPerameter parameters() {
+    public @NotNull OllamaPerameter parameters() {
         return OllamaPerameter.builder()
                 .addProperty("query", OllamaPerameter.OllamaPerameterBuilder.Type.STRING, "The query to search for",true)
                 .addProperty("offset", OllamaPerameter.OllamaPerameterBuilder.Type.INT, "The offset to start from")

MALAPITool/src/main/java/me/zacharias/chat/mal/api/endpoints/GetManagDetails.java

@@ -7,6 +7,7 @@ import me.zacharias.chat.ollama.OllamaFunctionArgument;
 import me.zacharias.chat.ollama.OllamaPerameter;
 import me.zacharias.chat.ollama.OllamaToolRespnce;
 import me.zacharias.chat.ollama.exceptions.OllamaToolErrorException;
+import org.jetbrains.annotations.NotNull;
 import org.json.JSONArray;
 import org.json.JSONObject;
 
@@ -19,7 +20,7 @@ public class GetManagDetails extends MALEndpointTool {
     }
 
     @Override
-    public String name() {
+    public @NotNull String name() {
         return "get_manag_details";
     }
 
@@ -29,7 +30,7 @@ public class GetManagDetails extends MALEndpointTool {
     }
 
     @Override
-    public OllamaPerameter parameters() {
+    public @NotNull OllamaPerameter parameters() {
         return OllamaPerameter.builder()
                 .addProperty("id", OllamaPerameter.OllamaPerameterBuilder.Type.INT, "The id of the manga", true)
                 .addProperty("fields", OllamaPerameter.OllamaPerameterBuilder.Type.ARRAY, "The fields to return, defaults to [\"id\", \"title\", \"synopsis\", \"genres\"]")

MALAPITool/src/main/java/me/zacharias/chat/mal/api/endpoints/GetMangaList.java

@@ -7,6 +7,7 @@ import me.zacharias.chat.ollama.OllamaFunctionArgument;
 import me.zacharias.chat.ollama.OllamaPerameter;
 import me.zacharias.chat.ollama.OllamaToolRespnce;
 import me.zacharias.chat.ollama.exceptions.OllamaToolErrorException;
+import org.jetbrains.annotations.NotNull;
 import org.json.JSONArray;
 import org.json.JSONObject;
 
@@ -19,7 +20,7 @@ public class GetMangaList extends MALEndpointTool {
     }
 
     @Override
-    public String name() {
+    public @NotNull String name() {
         return "get_manga_list";
     }
 
@@ -29,7 +30,7 @@ public class GetMangaList extends MALEndpointTool {
     }
 
     @Override
-    public OllamaPerameter parameters() {
+    public @NotNull OllamaPerameter parameters() {
         return OllamaPerameter.builder()
                 .addProperty("query", OllamaPerameter.OllamaPerameterBuilder.Type.STRING, "The query to search for",true)
                 .addProperty("offset", OllamaPerameter.OllamaPerameterBuilder.Type.INT, "The offset to start from")

WikipediaTool/src/main/java/me/zacharias/neuro/dock/wikipedia/GetWikiPageText.java

@@ -5,12 +5,13 @@ import me.zacharias.chat.ollama.OllamaFunctionArgument;
 import me.zacharias.chat.ollama.OllamaFunctionTool;
 import me.zacharias.chat.ollama.OllamaPerameter;
 import me.zacharias.chat.ollama.OllamaToolRespnce;
+import org.jetbrains.annotations.NotNull;
 
 public class GetWikiPageText extends OllamaFunctionTool {
     Wiki wiki = WikipediaTool.wiki;
 
     @Override
-    public String name() {
+    public @NotNull String name() {
         return "get_wiki_page_text";
     }
 
@@ -20,7 +21,7 @@ public class GetWikiPageText extends OllamaFunctionTool {
     }
 
     @Override
-    public OllamaPerameter parameters() {
+    public @NotNull OllamaPerameter parameters() {
         return OllamaPerameter.builder()
                 .addProperty("title", OllamaPerameter.OllamaPerameterBuilder.Type.STRING, "The title of the Wikipedia page to retrieve text from.", true)
                 .build();