[maven-release-plugin] prepare release v1.0.67

- Added `ConsoleOutputStreamHandler`

.github/workflows/release-jar.yml

@@ -1,42 +0,0 @@
-name: Release JAR
-
-on:
-  push:
-    tags:
-      - '**'
-
-permissions:
-  contents: read
-  id-token: write
-  packages: write
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    permissions:
-      contents: write
-      pull-requests: write
-      repository-projects: write
-
-    steps:
-      - uses: actions/checkout@v3
-      - name: Set up JDK 11
-        uses: actions/setup-java@v3
-        with:
-          java-version: '11'
-          distribution: 'temurin'
-          server-id: github # Value of the distributionManagement/repository/id field of the pom.xml
-          settings-path: ${{ github.workspace }} # location for the settings.xml file
-
-      - name: Build with Maven
-        run: mvn -B clean install package --file pom.xml
-
-      - name: Release Assets
-        uses: softprops/action-gh-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        if: startsWith(github.ref, 'refs/tags/')
-        with:
-          files: target/*.jar

docs/docs/apis-generate/chat.md

@@ -41,6 +41,7 @@ public class Main {
 }
 
 ```
+
 You will get a response similar to:
 
 > First answer: Should be Paris!
@@ -50,23 +51,28 @@ You will get a response similar to:
 > Chat History:
 
 ```json
-[ {
+[
+  {
     "role": "user",
     "content": "What is the capital of France?",
     "images": []
-  }, {
+  },
+  {
     "role": "assistant",
     "content": "Should be Paris!",
     "images": []
-  }, {
+  },
+  {
     "role": "user",
     "content": "And what is the second largest city?",
     "images": []
-  }, {
+  },
+  {
     "role": "assistant",
     "content": "Marseille.",
     "images": []
-  } ]
+  }
+]
 ```
 
 ## Create a conversation where the answer is streamed
@@ -93,6 +99,7 @@ public class Main {
     }
 }
 ```
+
 You will get a response similar to:
 
 > The
@@ -103,8 +110,27 @@ You will get a response similar to:
 > The capital of France is Paris
 > The capital of France is Paris.
 
+## Use a simple Console Output Stream Handler
+
+```java
+import io.github.amithkoujalgi.ollama4j.core.impl.ConsoleOutputStreamHandler;
+
+public class Main {
+    public static void main(String[] args) throws Exception {
+        String host = "http://localhost:11434/";
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+
+        OllamaChatRequestBuilder builder = OllamaChatRequestBuilder.getInstance(OllamaModelType.LLAMA2);
+        OllamaChatRequestModel requestModel = builder.withMessage(OllamaChatMessageRole.USER, "List all cricket world cup teams of 2019. Name the teams!")
+                .build();
+        OllamaStreamHandler streamHandler = new ConsoleOutputStreamHandler();
+        ollamaAPI.chat(requestModel, streamHandler);
+    }
+}
+```
 
 ## Create a new conversation with individual system prompt
+
 ```java
 public class Main {
 
@@ -128,6 +154,7 @@ public class Main {
 }
 
 ```
+
 You will get a response similar to:
 
 > NI.
@@ -167,6 +194,12 @@ public class Main {
 
 You will get a response similar to:
 
-> First Answer: The image shows a dog sitting on the bow of a boat that is docked in calm water. The boat has two levels, with the lower level containing seating and what appears to be an engine cover. The dog seems relaxed and comfortable on the boat, looking out over the water. The background suggests it might be late afternoon or early evening, given the warm lighting and the low position of the sun in the sky.
+> First Answer: The image shows a dog sitting on the bow of a boat that is docked in calm water. The boat has two
+> levels, with the lower level containing seating and what appears to be an engine cover. The dog seems relaxed and
+> comfortable on the boat, looking out over the water. The background suggests it might be late afternoon or early
+> evening, given the warm lighting and the low position of the sun in the sky.
 >
-> Second Answer: Based on the image, it's difficult to definitively determine the breed of the dog. However, the dog appears to be medium-sized with a short coat and a brown coloration, which might suggest that it is a Golden Retriever or a similar breed. Without more details like ear shape and tail length, it's not possible to identify the exact breed confidently.
+> Second Answer: Based on the image, it's difficult to definitively determine the breed of the dog. However, the dog
+> appears to be medium-sized with a short coat and a brown coloration, which might suggest that it is a Golden Retriever
+> or a similar breed. Without more details like ear shape and tail length, it's not possible to identify the exact breed
+> confidently.

docs/docs/apis-generate/prompt-builder.md

@@ -42,7 +42,7 @@ public class AskPhi {
                         .addSeparator()
                         .add("How do I read a file in Go and print its contents to stdout?");
 
-        OllamaResult response = ollamaAPI.generate(model, promptBuilder.build());
+        OllamaResult response = ollamaAPI.generate(model, promptBuilder.build(), new OptionsBuilder().build());
         System.out.println(response.getResponse());
     }
 }

pom.xml

@@ -4,7 +4,7 @@
 
     <groupId>io.github.amithkoujalgi</groupId>
     <artifactId>ollama4j</artifactId>
-    <version>1.0.60</version>
+    <version>1.0.67</version>
 
     <name>Ollama4j</name>
     <description>Java library for interacting with Ollama API.</description>
@@ -39,7 +39,7 @@
         <connection>scm:git:git@github.com:amithkoujalgi/ollama4j.git</connection>
         <developerConnection>scm:git:https://github.com/amithkoujalgi/ollama4j.git</developerConnection>
         <url>https://github.com/amithkoujalgi/ollama4j</url>
-        <tag>v1.0.60</tag>
+        <tag>v1.0.67</tag>
     </scm>
 
     <build>

src/main/java/io/github/amithkoujalgi/ollama4j/core/OllamaAPI.java

@@ -9,18 +9,13 @@ import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatResult;
 import io.github.amithkoujalgi.ollama4j.core.models.embeddings.OllamaEmbeddingResponseModel;
 import io.github.amithkoujalgi.ollama4j.core.models.embeddings.OllamaEmbeddingsRequestModel;
 import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaGenerateRequestModel;
-import io.github.amithkoujalgi.ollama4j.core.models.request.CustomModelFileContentsRequest;
-import io.github.amithkoujalgi.ollama4j.core.models.request.CustomModelFilePathRequest;
-import io.github.amithkoujalgi.ollama4j.core.models.request.ModelRequest;
-import io.github.amithkoujalgi.ollama4j.core.models.request.OllamaChatEndpointCaller;
-import io.github.amithkoujalgi.ollama4j.core.models.request.OllamaGenerateEndpointCaller;
+import io.github.amithkoujalgi.ollama4j.core.models.request.*;
 import io.github.amithkoujalgi.ollama4j.core.utils.Options;
 import io.github.amithkoujalgi.ollama4j.core.utils.Utils;
-import java.io.BufferedReader;
-import java.io.File;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.*;
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.net.http.HttpClient;
@@ -33,16 +28,16 @@ import java.time.Duration;
 import java.util.ArrayList;
 import java.util.Base64;
 import java.util.List;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
-/** The base Ollama API class. */
+/**
+ * The base Ollama API class.
+ */
 @SuppressWarnings("DuplicatedCode")
 public class OllamaAPI {
 
     private static final Logger logger = LoggerFactory.getLogger(OllamaAPI.class);
     private final String host;
-  private long requestTimeoutSeconds = 3;
+    private long requestTimeoutSeconds = 10;
     private boolean verbose = true;
     private BasicAuth basicAuth;
 
@@ -365,7 +360,7 @@ public class OllamaAPI {
 
     /**
      * Convenience method to call Ollama API without streaming responses.
-   * 
+     * <p>
      * Uses {@link #generate(String, String, Options, OllamaStreamHandler)}
      */
     public OllamaResult generate(String model, String prompt, Options options)
@@ -420,7 +415,7 @@ public class OllamaAPI {
 
     /**
      * Convenience method to call Ollama API without streaming responses.
-   * 
+     * <p>
      * Uses {@link #generateWithImageFiles(String, String, List, Options, OllamaStreamHandler)}
      */
     public OllamaResult generateWithImageFiles(
@@ -456,7 +451,7 @@ public class OllamaAPI {
 
     /**
      * Convenience method to call Ollama API without streaming responses.
-   * 
+     * <p>
      * Uses {@link #generateWithImageURLs(String, String, List, Options, OllamaStreamHandler)}
      */
     public OllamaResult generateWithImageURLs(String model, String prompt, List<String> imageURLs,
@@ -466,7 +461,6 @@ public class OllamaAPI {
     }
 
 
-  
     /**
      * Ask a question to a model based on a given message stack (i.e. a chat history). Creates a synchronous call to the api
      * 'api/chat'.
@@ -485,7 +479,7 @@ public class OllamaAPI {
 
     /**
      * Ask a question to a model using an {@link OllamaChatRequestModel}. This can be constructed using an {@link OllamaChatRequestBuilder}.
-   * 
+     * <p>
      * Hint: the OllamaChatRequestModel#getStream() property is not implemented.
      *
      * @param request request object to be sent to the server
@@ -500,7 +494,7 @@ public class OllamaAPI {
 
     /**
      * Ask a question to a model using an {@link OllamaChatRequestModel}. This can be constructed using an {@link OllamaChatRequestBuilder}.
-   * 
+     * <p>
      * Hint: the OllamaChatRequestModel#getStream() property is not implemented.
      *
      * @param request       request object to be sent to the server
@@ -516,8 +510,7 @@ public class OllamaAPI {
         if (streamHandler != null) {
             request.setStream(true);
             result = requestCaller.call(request, streamHandler);
-    }
-    else {
+        } else {
             result = requestCaller.callSync(request);
         }
         return new OllamaChatResult(result.getResponse(), result.getResponseTime(), result.getHttpStatusCode(), request.getMessages());

src/main/java/io/github/amithkoujalgi/ollama4j/core/impl/ConsoleOutputStreamHandler.java

@@ -0,0 +1,14 @@
+package io.github.amithkoujalgi.ollama4j.core.impl;
+
+import io.github.amithkoujalgi.ollama4j.core.OllamaStreamHandler;
+
+public class ConsoleOutputStreamHandler implements OllamaStreamHandler {
+    private final StringBuffer response = new StringBuffer();
+
+    @Override
+    public void accept(String message) {
+        String substr = message.substring(response.length());
+        response.append(substr);
+        System.out.print(substr);
+    }
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/chat/OllamaChatResponseModel.java

@@ -1,14 +1,15 @@
 package io.github.amithkoujalgi.ollama4j.core.models.chat;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
 
 import java.util.List;
-import lombok.Data;
 
 @Data
 public class OllamaChatResponseModel {
     private String model;
     private @JsonProperty("created_at") String createdAt;
+    private @JsonProperty("done_reason") String doneReason;
     private OllamaChatMessage message;
     private boolean done;
     private String error;

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/request/OllamaChatEndpointCaller.java

@@ -1,12 +1,6 @@
 package io.github.amithkoujalgi.ollama4j.core.models.request;
 
-import java.io.IOException;
-
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 import com.fasterxml.jackson.core.JsonProcessingException;
-
 import io.github.amithkoujalgi.ollama4j.core.OllamaStreamHandler;
 import io.github.amithkoujalgi.ollama4j.core.exceptions.OllamaBaseException;
 import io.github.amithkoujalgi.ollama4j.core.models.BasicAuth;
@@ -15,6 +9,10 @@ import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatResponseModel
 import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatStreamObserver;
 import io.github.amithkoujalgi.ollama4j.core.utils.OllamaRequestBody;
 import io.github.amithkoujalgi.ollama4j.core.utils.Utils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
 
 /**
  * Specialization class for requests
@@ -54,7 +52,4 @@ public class OllamaChatEndpointCaller extends OllamaEndpointCaller{
         streamObserver = new OllamaChatStreamObserver(streamHandler);
         return super.callSync(body);
     }
-
-    
- 
 }

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/request/OllamaEndpointCaller.java

@@ -1,5 +1,15 @@
 package io.github.amithkoujalgi.ollama4j.core.models.request;
 
+import io.github.amithkoujalgi.ollama4j.core.OllamaAPI;
+import io.github.amithkoujalgi.ollama4j.core.exceptions.OllamaBaseException;
+import io.github.amithkoujalgi.ollama4j.core.models.BasicAuth;
+import io.github.amithkoujalgi.ollama4j.core.models.OllamaErrorResponseModel;
+import io.github.amithkoujalgi.ollama4j.core.models.OllamaResult;
+import io.github.amithkoujalgi.ollama4j.core.utils.OllamaRequestBody;
+import io.github.amithkoujalgi.ollama4j.core.utils.Utils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStream;
@@ -12,17 +22,6 @@ import java.nio.charset.StandardCharsets;
 import java.time.Duration;
 import java.util.Base64;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import io.github.amithkoujalgi.ollama4j.core.OllamaAPI;
-import io.github.amithkoujalgi.ollama4j.core.exceptions.OllamaBaseException;
-import io.github.amithkoujalgi.ollama4j.core.models.BasicAuth;
-import io.github.amithkoujalgi.ollama4j.core.models.OllamaErrorResponseModel;
-import io.github.amithkoujalgi.ollama4j.core.models.OllamaResult;
-import io.github.amithkoujalgi.ollama4j.core.utils.OllamaRequestBody;
-import io.github.amithkoujalgi.ollama4j.core.utils.Utils;
-
 /**
  * Abstract helperclass to call the ollama api server.
  */
@@ -57,7 +56,6 @@ public abstract class OllamaEndpointCaller {
      * @throws InterruptedException in case the server is not reachable or network issues happen
      */
     public OllamaResult callSync(OllamaRequestBody body) throws OllamaBaseException, IOException, InterruptedException {
-
         // Create Request
         long startTime = System.currentTimeMillis();
         HttpClient httpClient = HttpClient.newHttpClient();
@@ -71,7 +69,6 @@ public abstract class OllamaEndpointCaller {
         HttpResponse<InputStream> response =
                 httpClient.send(request, HttpResponse.BodyHandlers.ofInputStream());
 
-        
         int statusCode = response.statusCode();
         InputStream responseBodyStream = response.body();
         StringBuilder responseBuffer = new StringBuilder();

src/main/java/io/github/amithkoujalgi/ollama4j/core/types/OllamaModelType.java

@@ -10,15 +10,18 @@ package io.github.amithkoujalgi.ollama4j.core.types;
 public class OllamaModelType {
     public static final String GEMMA = "gemma";
     public static final String LLAMA2 = "llama2";
+    public static final String LLAMA3 = "llama3";
     public static final String MISTRAL = "mistral";
     public static final String MIXTRAL = "mixtral";
     public static final String LLAVA = "llava";
+    public static final String LLAVA_PHI3 = "llava-phi3";
     public static final String NEURAL_CHAT = "neural-chat";
     public static final String CODELLAMA = "codellama";
     public static final String DOLPHIN_MIXTRAL = "dolphin-mixtral";
     public static final String MISTRAL_OPENORCA = "mistral-openorca";
     public static final String LLAMA2_UNCENSORED = "llama2-uncensored";
     public static final String PHI = "phi";
+    public static final String PHI3 = "phi3";
     public static final String ORCA_MINI = "orca-mini";
     public static final String DEEPSEEK_CODER = "deepseek-coder";
     public static final String DOLPHIN_MISTRAL = "dolphin-mistral";

src/test/java/io/github/amithkoujalgi/ollama4j/unittests/jackson/TestChatRequestSerialization.java

@@ -51,12 +51,27 @@ public class TestChatRequestSerialization extends AbstractRequestSerializationTe
     public void testRequestWithOptions() {
         OptionsBuilder b = new OptionsBuilder();
         OllamaChatRequestModel req = builder.withMessage(OllamaChatMessageRole.USER, "Some prompt")
-                .withOptions(b.setMirostat(1).build()).build();
+            .withOptions(b.setMirostat(1).build())
+            .withOptions(b.setTemperature(1L).build())
+            .withOptions(b.setMirostatEta(1L).build())
+            .withOptions(b.setMirostatTau(1L).build())
+            .withOptions(b.setNumGpu(1).build())
+            .withOptions(b.setSeed(1).build())
+            .withOptions(b.setTopK(1).build())
+            .withOptions(b.setTopP(1).build())
+            .build();
 
         String jsonRequest = serializeRequest(req);
         OllamaChatRequestModel deserializeRequest = deserializeRequest(jsonRequest, OllamaChatRequestModel.class);
         assertEqualsAfterUnmarshalling(deserializeRequest, req);
         assertEquals(1, deserializeRequest.getOptions().get("mirostat"));
+        assertEquals(1.0, deserializeRequest.getOptions().get("temperature"));
+        assertEquals(1.0, deserializeRequest.getOptions().get("mirostat_eta"));
+        assertEquals(1.0, deserializeRequest.getOptions().get("mirostat_tau"));
+        assertEquals(1, deserializeRequest.getOptions().get("num_gpu"));
+        assertEquals(1, deserializeRequest.getOptions().get("seed"));
+        assertEquals(1, deserializeRequest.getOptions().get("top_k"));
+        assertEquals(1.0, deserializeRequest.getOptions().get("top_p"));
     }
 
     @Test
@@ -71,4 +86,28 @@ public class TestChatRequestSerialization extends AbstractRequestSerializationTe
         String requestFormatProperty = jsonObject.getString("format");
         assertEquals("json", requestFormatProperty);
     }
+
+    @Test
+    public void testWithTemplate() {
+        OllamaChatRequestModel req = builder.withTemplate("System Template")
+            .build();
+        String jsonRequest = serializeRequest(req);
+        assertEqualsAfterUnmarshalling(deserializeRequest(jsonRequest, OllamaChatRequestModel.class), req);
+    }
+
+    @Test
+    public void testWithStreaming() {
+        OllamaChatRequestModel req = builder.withStreaming().build();
+        String jsonRequest = serializeRequest(req);
+        assertEquals(deserializeRequest(jsonRequest, OllamaChatRequestModel.class).isStream(), true);
+    }
+
+    @Test
+    public void testWithKeepAlive() {
+        String expectedKeepAlive = "5m";
+        OllamaChatRequestModel req = builder.withKeepAlive(expectedKeepAlive)
+            .build();
+        String jsonRequest = serializeRequest(req);
+        assertEquals(deserializeRequest(jsonRequest, OllamaChatRequestModel.class).getKeepAlive(), expectedKeepAlive);
+    }
 }